Google Cloud Deploy V1 Client - Class DeployPolicy (1.5.1)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class DeployPolicy.

A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Generated from protobuf message google.cloud.deploy.v1.DeployPolicy

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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])?
↳ uid string

Output only. Unique identifier of the DeployPolicy.
↳ description string

Description of the DeployPolicy. Max length is 255 characters.
↳ annotations array|Google\Protobuf\Internal\MapField

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.
↳ labels array|Google\Protobuf\Internal\MapField

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.
↳ create_time Google\Protobuf\Timestamp

Output only. Time at which the deploy policy was created.
↳ update_time Google\Protobuf\Timestamp

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

When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.
↳ selectors array<DeployPolicyResourceSelector>

Required. 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.
↳ rules array<PolicyRule>

Required. Rules to apply. At least one rule must be present.
↳ etag string

The weak etag of the Automation 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.

getName

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])?

Returns
Type Description
string

setName

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])?

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. Unique identifier of the DeployPolicy.

Returns
Type Description
string

setUid

Output only. Unique identifier of the DeployPolicy.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Description of the DeployPolicy. Max length is 255 characters.

Returns
Type Description
string

setDescription

Description of the DeployPolicy. Max length is 255 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getAnnotations

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.
Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

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.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getLabels

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.
Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSuspended

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

Returns
Type Description
bool

setSuspended

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getSelectors

Required. 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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSelectors

Required. 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.

Parameter
Name Description
var array<DeployPolicyResourceSelector>
Returns
Type Description
$this

getRules

Required. Rules to apply. At least one rule must be present.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRules

Required. Rules to apply. At least one rule must be present.

Parameter
Name Description
var array<PolicyRule>
Returns
Type Description
$this

getEtag

The weak etag of the Automation 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.

Returns
Type Description
string

setEtag

The weak etag of the Automation 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.

Parameter
Name Description
var string
Returns
Type Description
$this