automation_runs

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

Overview

Name	automation_runs
Type	Resource
Id	google.clouddeploy.automation_runs

Fields

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	Contains the information of an automated advance-rollout operation.
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.
createTime	string	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	Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.
promoteReleaseOperation	object	Contains the information of an automated promote-release operation.
repairRolloutOperation	object	Contains the information for an automated repair rollout operation.
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 target that represents the promotion stage that initiates the AutomationRun. The value of this field is the last segment of a target name.
updateTime	string	Output only. Time at which the automationRun was updated.
waitUntilTime	string	Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	automationRunsId, deliveryPipelinesId, locationsId, projectsId	Gets details of a single AutomationRun.
list	SELECT	deliveryPipelinesId, locationsId, projectsId	Lists AutomationRuns in a given project and location.
cancel	EXEC	automationRunsId, deliveryPipelinesId, locationsId, projectsId	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.

SELECT examples

Lists AutomationRuns in a given project and location.

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