automation_runs

Creates, updates, deletes, gets or lists an automation_runs resource.

Overview

Name	automation_runs
Type	Resource
Id	google.clouddeploy.automation_runs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.
advanceRolloutOperation	object	Output only. Advances a rollout to the next phase. (id: AdvanceRolloutOperation)
automationId	string	Output only. The ID of the automation that initiated the operation.
automationSnapshot	object	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. (id: Automation)
createTime	string (google-datetime)	Output only. Time at which the AutomationRun was created.
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.
expireTime	string (google-datetime)	Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.
policyViolation	object	Output only. Contains information about what policies prevented the AutomationRun from proceeding. (id: PolicyViolation)
promoteReleaseOperation	object	Output only. Promotes a release to a specified 'Target'. (id: PromoteReleaseOperation)
repairRolloutOperation	object	Output only. Repairs a failed 'Rollout'. (id: RepairRolloutOperation)
ruleId	string	Output only. The ID of the automation rule that initiated the operation.
serviceAccount	string	Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
state	string	Output only. Current state of the AutomationRun.
stateDescription	string	Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.
targetId	string	Output only. The ID of the source target that initiates the AutomationRun. The value of this field is the last segment of a target name.
timedPromoteReleaseOperation	object	Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule. (id: TimedPromoteReleaseOperation)
updateTime	string (google-datetime)	Output only. Time at which the automationRun was updated.
waitUntilTime	string (google-datetime)	Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.
advanceRolloutOperation	object	Output only. Advances a rollout to the next phase. (id: AdvanceRolloutOperation)
automationId	string	Output only. The ID of the automation that initiated the operation.
automationSnapshot	object	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. (id: Automation)
createTime	string (google-datetime)	Output only. Time at which the AutomationRun was created.
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.
expireTime	string (google-datetime)	Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.
policyViolation	object	Output only. Contains information about what policies prevented the AutomationRun from proceeding. (id: PolicyViolation)
promoteReleaseOperation	object	Output only. Promotes a release to a specified 'Target'. (id: PromoteReleaseOperation)
repairRolloutOperation	object	Output only. Repairs a failed 'Rollout'. (id: RepairRolloutOperation)
ruleId	string	Output only. The ID of the automation rule that initiated the operation.
serviceAccount	string	Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.
state	string	Output only. Current state of the AutomationRun.
stateDescription	string	Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.
targetId	string	Output only. The ID of the source target that initiates the AutomationRun. The value of this field is the last segment of a target name.
timedPromoteReleaseOperation	object	Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule. (id: TimedPromoteReleaseOperation)
updateTime	string (google-datetime)	Output only. Time at which the automationRun was updated.
waitUntilTime	string (google-datetime)	Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deliveryPipelinesId, automationRunsId		Gets details of a single AutomationRun.
list	select	projectsId, locationsId, deliveryPipelinesId	pageSize, pageToken, filter, orderBy	Lists AutomationRuns in a given project and location.
cancel	exec	projectsId, locationsId, deliveryPipelinesId, automationRunsId		Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

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.

Name	Datatype	Description
automationRunsId	string
deliveryPipelinesId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets details of a single AutomationRun.

SELECT
name,
advanceRolloutOperation,
automationId,
automationSnapshot,
createTime,
etag,
expireTime,
policyViolation,
promoteReleaseOperation,
repairRolloutOperation,
ruleId,
serviceAccount,
state,
stateDescription,
targetId,
timedPromoteReleaseOperation,
updateTime,
waitUntilTime
FROM google.clouddeploy.automation_runs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND automationRunsId = '{{ automationRunsId }}' -- required;

list

Lists AutomationRuns in a given project and location.

SELECT
name,
advanceRolloutOperation,
automationId,
automationSnapshot,
createTime,
etag,
expireTime,
policyViolation,
promoteReleaseOperation,
repairRolloutOperation,
ruleId,
serviceAccount,
state,
stateDescription,
targetId,
timedPromoteReleaseOperation,
updateTime,
waitUntilTime
FROM google.clouddeploy.automation_runs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

Lifecycle Methods

cancel

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

EXEC google.clouddeploy.automation_runs.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@automationRunsId='{{ automationRunsId }}' --required;