Skip to main content

deploy_policies

Creates, updates, deletes, gets or lists a deploy_policies resource.

Overview​

Namedeploy_policies
TypeResource
Idgoogle.clouddeploy.deploy_policies

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringOutput 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])?
annotationsobjectOptional. 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.
descriptionstringOptional. Description of the DeployPolicy. Max length is 255 characters.
etagstringThe 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.
labelsobjectLabels 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.
rulesarrayRequired. Rules to apply. At least one rule must be present.
selectorsarrayRequired. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action.
suspendedbooleanOptional. When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.
uidstringOutput only. Unique identifier of the DeployPolicy.
updateTimestring (google-datetime)Output only. Most recent time at which the deploy policy was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, deployPoliciesIdGets details of a single DeployPolicy.
listselectprojectsId, locationsIdpageSize, pageToken, filter, orderByLists DeployPolicies in a given project and location.
createinsertprojectsId, locationsIddeployPolicyId, requestId, validateOnlyCreates a new DeployPolicy in a given project and location.
patchupdateprojectsId, locationsId, deployPoliciesIdupdateMask, requestId, allowMissing, validateOnlyUpdates the parameters of a single DeployPolicy.
deletedeleteprojectsId, locationsId, deployPoliciesIdrequestId, allowMissing, validateOnly, etagDeletes a single DeployPolicy.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
deployPoliciesIdstring
locationsIdstring
projectsIdstring
allowMissingboolean
deployPolicyIdstring
etagstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
requestIdstring
updateMaskstring (google-fieldmask)
validateOnlyboolean

SELECT examples​

Gets details of a single DeployPolicy.

SELECT
name,
annotations,
createTime,
description,
etag,
labels,
rules,
selectors,
suspended,
uid,
updateTime
FROM google.clouddeploy.deploy_policies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deployPoliciesId = '{{ deployPoliciesId }}' -- required;

INSERT examples​

Creates a new DeployPolicy in a given project and location.

INSERT INTO google.clouddeploy.deploy_policies (
data__description,
data__annotations,
data__labels,
data__suspended,
data__selectors,
data__rules,
data__etag,
projectsId,
locationsId,
deployPolicyId,
requestId,
validateOnly
)
SELECT 
'{{ description }}',
'{{ annotations }}',
'{{ labels }}',
{{ suspended }},
'{{ selectors }}',
'{{ rules }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ deployPolicyId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates the parameters of a single DeployPolicy.

UPDATE google.clouddeploy.deploy_policies
SET 
data__description = '{{ description }}',
data__annotations = '{{ annotations }}',
data__labels = '{{ labels }}',
data__suspended = {{ suspended }},
data__selectors = '{{ selectors }}',
data__rules = '{{ rules }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deployPoliciesId = '{{ deployPoliciesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a single DeployPolicy.

DELETE FROM google.clouddeploy.deploy_policies
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND deployPoliciesId = '{{ deployPoliciesId }}' --required
AND requestId = '{{ requestId }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}';