Google Cloud Deploy V1 Client - Class AutomationRun (1.2.0)

Version 1.2.0

• 2.0.0 (latest)
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.0
• 0.19.1
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.4

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

An AutomationRun resource in the Cloud Deploy API.

An AutomationRun represents an execution instance of an automation rule.

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

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 AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.
↳ create_time	Google\Protobuf\Timestamp Output only. Time at which the AutomationRun was created.
↳ update_time	Google\Protobuf\Timestamp Output only. Time at which the automationRun was updated.
↳ etag	string Output only. The weak etag of the AutomationRun 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.
↳ service_account	string Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
↳ automation_snapshot	Google\Cloud\Deploy\V1\Automation Output only. Snapshot of the Automation taken at AutomationRun creation time.
↳ target_id	string Output only. The ID of the target that represents the promotion stage that initiates the AutomationRun. The value of this field is the last segment of a target name.
↳ state	int Output only. Current state of the AutomationRun.
↳ state_description	string Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.
↳ policy_violation	Google\Cloud\Deploy\V1\PolicyViolation Output only. Contains information about what policies prevented the AutomationRun from proceeding.
↳ expire_time	Google\Protobuf\Timestamp Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.
↳ rule_id	string Output only. The ID of the automation rule that initiated the operation.
↳ automation_id	string Output only. The ID of the automation that initiated the operation.
↳ promote_release_operation	Google\Cloud\Deploy\V1\PromoteReleaseOperation Output only. Promotes a release to a specified 'Target'.
↳ advance_rollout_operation	Google\Cloud\Deploy\V1\AdvanceRolloutOperation Output only. Advances a rollout to the next phase.
↳ repair_rollout_operation	Google\Cloud\Deploy\V1\RepairRolloutOperation Output only. Repairs a failed 'Rollout'.
↳ wait_until_time	Google\Protobuf\Timestamp Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

getName

Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Returns
Type	Description
string

setName

Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Time at which the AutomationRun was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the AutomationRun was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Time at which the automationRun was updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time at which the automationRun was updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEtag

Output only. The weak etag of the AutomationRun 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

Output only. The weak etag of the AutomationRun 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

getServiceAccount

Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.

Returns
Type	Description
string

setServiceAccount

Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAutomationSnapshot

Output only. Snapshot of the Automation taken at AutomationRun creation time.

Returns
Type	Description
Google\Cloud\Deploy\V1\Automation|null

hasAutomationSnapshot

clearAutomationSnapshot

setAutomationSnapshot

Output only. Snapshot of the Automation taken at AutomationRun creation time.

Parameter
Name	Description
var	Google\Cloud\Deploy\V1\Automation

Returns
Type	Description
$this

getTargetId

Output only. The ID of the target that represents the promotion stage that initiates the AutomationRun. The value of this field is the last segment of a target name.

Returns
Type	Description
string

setTargetId

Output only. The ID of the target that represents the promotion stage that initiates the AutomationRun. The value of this field is the last segment of a target name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getState

Output only. Current state of the AutomationRun.

Returns
Type	Description
int

setState

Output only. Current state of the AutomationRun.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStateDescription

Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.

Returns
Type	Description
string

setStateDescription

Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPolicyViolation

Output only. Contains information about what policies prevented the AutomationRun from proceeding.

Returns
Type	Description
Google\Cloud\Deploy\V1\PolicyViolation|null

hasPolicyViolation

clearPolicyViolation

setPolicyViolation

Output only. Contains information about what policies prevented the AutomationRun from proceeding.

Parameter
Name	Description
var	Google\Cloud\Deploy\V1\PolicyViolation

Returns
Type	Description
$this

getExpireTime

Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getRuleId

Output only. The ID of the automation rule that initiated the operation.

Returns
Type	Description
string

setRuleId

Output only. The ID of the automation rule that initiated the operation.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAutomationId

Output only. The ID of the automation that initiated the operation.

Returns
Type	Description
string

setAutomationId

Output only. The ID of the automation that initiated the operation.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPromoteReleaseOperation

Output only. Promotes a release to a specified 'Target'.

Returns
Type	Description
Google\Cloud\Deploy\V1\PromoteReleaseOperation|null

hasPromoteReleaseOperation

setPromoteReleaseOperation

Output only. Promotes a release to a specified 'Target'.

Parameter
Name	Description
var	Google\Cloud\Deploy\V1\PromoteReleaseOperation

Returns
Type	Description
$this

getAdvanceRolloutOperation

Output only. Advances a rollout to the next phase.

Returns
Type	Description
Google\Cloud\Deploy\V1\AdvanceRolloutOperation|null

hasAdvanceRolloutOperation

setAdvanceRolloutOperation

Output only. Advances a rollout to the next phase.

Parameter
Name	Description
var	Google\Cloud\Deploy\V1\AdvanceRolloutOperation

Returns
Type	Description
$this

getRepairRolloutOperation

Output only. Repairs a failed 'Rollout'.

Returns
Type	Description
Google\Cloud\Deploy\V1\RepairRolloutOperation|null

hasRepairRolloutOperation

setRepairRolloutOperation

Output only. Repairs a failed 'Rollout'.

Parameter
Name	Description
var	Google\Cloud\Deploy\V1\RepairRolloutOperation

Returns
Type	Description
$this

getWaitUntilTime

Output only. Earliest time the AutomationRun will attempt to resume.

Wait-time is configured by wait in automation rule.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasWaitUntilTime

clearWaitUntilTime

setWaitUntilTime

Output only. Earliest time the AutomationRun will attempt to resume.

Wait-time is configured by wait in automation rule.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getOperation

Returns
Type	Description
string