Reference documentation and code samples for the Google Cloud Deploy V1 Client class Automation.
An Automation
resource in the Cloud Deploy API.
An Automation
enables the automation of manually driven actions for
a Delivery Pipeline, which includes Release promotion among Targets,
Rollout repair and Rollout deployment strategy advancement. The intention
of Automation is to reduce manual intervention in the continuous delivery
process.
Generated from protobuf message google.cloud.deploy.v1.Automation
Namespace
Google \ Cloud \ Deploy \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Name of the |
↳ uid |
string
Output only. Unique identifier of the |
↳ description |
string
Optional. Description of the |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time at which the automation was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time at which the automation was updated. |
↳ annotations |
array|Google\Protobuf\Internal\MapField
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 ( |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. 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 <= 63 characters. |
↳ etag |
string
Optional. The weak etag of the |
↳ suspended |
bool
Optional. When Suspended, automation is deactivated from execution. |
↳ service_account |
string
Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources. |
↳ selector |
Google\Cloud\Deploy\V1\AutomationResourceSelector
Required. Selected resources to which the automation will be applied. |
↳ rules |
array<Google\Cloud\Deploy\V1\AutomationRule>
Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution. |
getName
Output only. Name of the Automation
. Format is
projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}
.
Returns | |
---|---|
Type | Description |
string |
setName
Output only. Name of the Automation
. Format is
projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getUid
Output only. Unique identifier of the Automation
.
Returns | |
---|---|
Type | Description |
string |
setUid
Output only. Unique identifier of the Automation
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDescription
Optional. Description of the Automation
. Max length is 255 characters.
Returns | |
---|---|
Type | Description |
string |
setDescription
Optional. Description of the Automation
. Max length is 255 characters.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
Output only. Time at which the automation was created.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time at which the automation was created.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateTime
Output only. Time at which the automation was updated.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time at which the automation was updated.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getAnnotations
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setAnnotations
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.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getLabels
Optional. 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 <= 63 characters.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
Optional. 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 <= 63 characters.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getEtag
Optional. 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
Optional. 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 |
getSuspended
Optional. When Suspended, automation is deactivated from execution.
Returns | |
---|---|
Type | Description |
bool |
setSuspended
Optional. When Suspended, automation is deactivated from execution.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getServiceAccount
Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
Returns | |
---|---|
Type | Description |
string |
setServiceAccount
Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSelector
Required. Selected resources to which the automation will be applied.
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\AutomationResourceSelector|null |
hasSelector
clearSelector
setSelector
Required. Selected resources to which the automation will be applied.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Deploy\V1\AutomationResourceSelector
|
Returns | |
---|---|
Type | Description |
$this |
getRules
Required. List of Automation rules associated with the Automation resource.
Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setRules
Required. List of Automation rules associated with the Automation resource.
Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Deploy\V1\AutomationRule>
|
Returns | |
---|---|
Type | Description |
$this |