REST Resource: projects.locations.deliveryPipelines.automationRuns

Resource: AutomationRun

An AutomationRun resource in the Cloud Deploy API.

An AutomationRun represents an execution instance of an automation rule.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "serviceAccount": string,
  "automationSnapshot": {
    object (Automation)
  },
  "targetId": string,
  "state": enum (State),
  "stateDescription": string,
  "policyViolation": {
    object (PolicyViolation)
  },
  "expireTime": string,
  "ruleId": string,
  "automationId": string,
  "waitUntilTime": string,

  // Union field operation can be only one of the following:
  "promoteReleaseOperation": {
    object (PromoteReleaseOperation)
  },
  "advanceRolloutOperation": {
    object (AdvanceRolloutOperation)
  },
  "repairRolloutOperation": {
    object (RepairRolloutOperation)
  },
  "timedPromoteReleaseOperation": {
    object (TimedPromoteReleaseOperation)
  }
  // End of list of possible types for union field operation.
}
Fields
name

string

Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/automationRuns/{automationRun}.
createTime

string (Timestamp format)

Output only. Time at which the AutomationRun was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Time at which the automationRun was updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
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.
serviceAccount

string

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

object (Automation)

Output only. Snapshot of the Automation taken at AutomationRun creation time.
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.
state

enum (State)

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

object (PolicyViolation)

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

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
ruleId

string

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

string

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

string (Timestamp format)

Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Union field operation. The operation that the AutomationRun will perform. operation can be only one of the following:
promoteReleaseOperation

object (PromoteReleaseOperation)

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

object (AdvanceRolloutOperation)

Output only. Advances a rollout to the next phase.
repairRolloutOperation

object (RepairRolloutOperation)

Output only. Repairs a failed 'Rollout'.
timedPromoteReleaseOperation

object (TimedPromoteReleaseOperation)

Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.

State

Valid state of an AutomationRun.

Enums
STATE_UNSPECIFIED The AutomationRun has an unspecified state.
SUCCEEDED The AutomationRun has succeeded.
CANCELLED The AutomationRun was cancelled.
FAILED The AutomationRun has failed.
IN_PROGRESS The AutomationRun is in progress.
PENDING The AutomationRun is pending.
ABORTED The AutomationRun was aborted.

PolicyViolation

Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why.

JSON representation 
{
  "policyViolationDetails": [
    {
      object (PolicyViolationDetails)
    }
  ]
}
Fields
policyViolationDetails[]

object (PolicyViolationDetails)

Policy violation details.

PolicyViolationDetails

Policy violation details.

JSON representation 
{
  "policy": string,
  "ruleId": string,
  "failureMessage": string
}
Fields
policy

string

Name of the policy that was violated. Policy resource will be in the format of projects/{project}/locations/{location}/policies/{policy}.
ruleId

string

Id of the rule that triggered the policy violation.
failureMessage

string

User readable message about why the request violated a policy. This is not intended for machine parsing.

PromoteReleaseOperation

Contains the information of an automated promote-release operation.

JSON representation 
{
  "targetId": string,
  "wait": string,
  "rollout": string,
  "phase": string
}
Fields
targetId

string

Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.
wait

string (Duration format)

Output only. How long the operation will be paused.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
rollout

string

Output only. The name of the rollout that initiates the AutomationRun.
phase

string

Output only. The starting phase of the rollout created by this operation.

AdvanceRolloutOperation

Contains the information of an automated advance-rollout operation.

JSON representation 
{
  "sourcePhase": string,
  "wait": string,
  "rollout": string,
  "destinationPhase": string
}
Fields
sourcePhase

string

Output only. The phase of a deployment that initiated the operation.
wait

string (Duration format)

Output only. How long the operation will be paused.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
rollout

string

Output only. The name of the rollout that initiates the AutomationRun.
destinationPhase

string

Output only. The phase the rollout will be advanced to.

RepairRolloutOperation

Contains the information for an automated repair rollout operation.

JSON representation 
{
  "rollout": string,
  "currentRepairPhaseIndex": string,
  "repairPhases": [
    {
      object (RepairPhase)
    }
  ],
  "phaseId": string,
  "jobId": string
}
Fields
rollout

string

Output only. The name of the rollout that initiates the AutomationRun.
currentRepairPhaseIndex

string (int64 format)

Output only. The index of the current repair action in the repair sequence.
repairPhases[]

object (RepairPhase)

Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.
phaseId

string

Output only. The phase ID of the phase that includes the job being repaired.
jobId

string

Output only. The job ID for the Job to repair.

RepairPhase

RepairPhase tracks the repair attempts that have been made for each RepairPhaseConfig specified in the Automation resource.

JSON representation 
{

  // Union field repair_phase can be only one of the following:
  "retry": {
    object (RetryPhase)
  },
  "rollback": {
    object (RollbackAttempt)
  }
  // End of list of possible types for union field repair_phase.
}
Fields
Union field repair_phase. The RepairPhase type and the information for that type. repair_phase can be only one of the following:
retry

object (RetryPhase)

Output only. Records of the retry attempts for retry repair mode.
rollback

object (RollbackAttempt)

Output only. Rollback attempt for rollback repair mode .

RetryPhase

RetryPhase contains the retry attempts and the metadata for initiating a new attempt.

JSON representation 
{
  "totalAttempts": string,
  "backoffMode": enum (BackoffMode),
  "attempts": [
    {
      object (RetryAttempt)
    }
  ]
}
Fields
totalAttempts

string (int64 format)

Output only. The number of attempts that have been made.
backoffMode

enum (BackoffMode)

Output only. The pattern of how the wait time of the retry attempt is calculated.
attempts[]

object (RetryAttempt)

Output only. Detail of a retry action.

RetryAttempt

RetryAttempt represents an action of retrying the failed Cloud Deploy job.

JSON representation 
{
  "attempt": string,
  "wait": string,
  "state": enum (RepairState),
  "stateDesc": string
}
Fields
attempt

string (int64 format)

Output only. The index of this retry attempt.
wait

string (Duration format)

Output only. How long the operation will be paused.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
state

enum (RepairState)

Output only. Valid state of this retry action.
stateDesc

string

Output only. Description of the state of the Retry.

RepairState

Valid state of a repair attempt.

Enums
REPAIR_STATE_UNSPECIFIED The repair has an unspecified state.
REPAIR_STATE_SUCCEEDED The repair action has succeeded.
REPAIR_STATE_CANCELLED The repair action was cancelled.
REPAIR_STATE_FAILED The repair action has failed.
REPAIR_STATE_IN_PROGRESS The repair action is in progress.
REPAIR_STATE_PENDING The repair action is pending.
REPAIR_STATE_ABORTED The repair action was aborted.

RollbackAttempt

RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.

JSON representation 
{
  "destinationPhase": string,
  "rolloutId": string,
  "state": enum (RepairState),
  "stateDesc": string,
  "disableRollbackIfRolloutPending": boolean
}
Fields
destinationPhase

string

Output only. The phase to which the rollout will be rolled back to.
rolloutId

string

Output only. ID of the rollback Rollout to create.
state

enum (RepairState)

Output only. Valid state of this rollback action.
stateDesc

string

Output only. Description of the state of the Rollback.
disableRollbackIfRolloutPending

boolean

Output only. If active rollout exists on the target, abort this rollback.

TimedPromoteReleaseOperation

Contains the information of an automated timed promote-release operation.

JSON representation 
{
  "targetId": string,
  "release": string,
  "phase": string
}
Fields
targetId

string

Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name.
release

string

Output only. The name of the release to be promoted.
phase

string

Output only. The starting phase of the rollout created by this operation.

Methods

cancel

 Cancels an AutomationRun.

get

 Gets details of a single AutomationRun.

list

 Lists AutomationRuns in a given project and location.