Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1332185209.7 KB
projects

Creates a new DeployPolicy in a given project and location.

post/v1/{+parent}/deployPolicies

Path parameters

parentstring required

Required. The parent collection in which the DeployPolicy must be created. The format is projects/{project_id}/locations/{location_name}.

Query parameters

deployPolicyIdstring

Required. ID of the DeployPolicy.

requestIdstring

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

validateOnlyboolean

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Request body

namestring

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

annotationsobject

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(.), not longer than 253 characters in total, followed by a slash (/). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.

createTimestring google-datetime

Output only. Time at which the deploy policy was created.

labelsobject

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

updateTimestring google-datetime

Output only. Most recent time at which the deploy policy was updated.

suspendedboolean

Optional. When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.

etagstring

The weak etag of the DeployPolicy resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

descriptionstring

Optional. Description of the DeployPolicy. Max length is 255 characters.

uidstring

Output only. Unique identifier of the DeployPolicy.

Response

Successful response