gcp_clouddeploy_automation_run

advance_rollout_operation

Type: STRUCT
Provider name: advanceRolloutOperation
Description: Output only. Advances a rollout to the next phase.

• destination_phase
  Type: STRING
  Provider name: destinationPhase
  Description: Output only. The phase the rollout will be advanced to.
  
• rollout
  Type: STRING
  Provider name: rollout
  Description: Output only. The name of the rollout that initiates the AutomationRun.
  
• source_phase
  Type: STRING
  Provider name: sourcePhase
  Description: Output only. The phase of a deployment that initiated the operation.
  
• wait
  Type: STRING
  Provider name: wait
  Description: Output only. How long the operation will be paused.
  

ancestors

Type: UNORDERED_LIST_STRING

automation_id

Type: STRING
Provider name: automationId
Description: Output only. The ID of the automation that initiated the operation.

automation_snapshot

Type: STRUCT
Provider name: automationSnapshot
Description: Output only. Snapshot of the Automation taken at AutomationRun creation time.

• annotations
  Type: MAP_STRING_STRING
  Provider name: annotations
  Description: 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.
  
• create_time
  Type: TIMESTAMP
  Provider name: createTime
  Description: Output only. Time at which the automation was created.
  
• description
  Type: STRING
  Provider name: description
  Description: Optional. Description of the Automation. Max length is 255 characters.
  
• etag
  Type: STRING
  Provider name: etag
  Description: 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.
  
• name
  Type: STRING
  Provider name: name
  Description: Output only. Name of the Automation. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.
  
• rules
  Type: UNORDERED_LIST_STRUCT
  Provider name: rules
  Description: 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.
  
  • advance_rollout_rule
    Type: STRUCT
    Provider name: advanceRolloutRule
    Description: Optional. The AdvanceRolloutRule will automatically advance a successful Rollout.
    
    • condition
      Type: STRUCT
      Provider name: condition
      Description: Output only. Information around the state of the Automation rule.
      
      • targets_present_condition
        Type: STRUCT
        Provider name: targetsPresentCondition
        Description: Optional. Details around targets enumerated in the rule.
        
        • gcp_status
          Type: BOOLEAN
          Provider name: status
          Description: True if there aren’t any missing Targets.
          
        • missing_targets
          Type: UNORDERED_LIST_STRING
          Provider name: missingTargets
          Description: The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.
          
        • update_time
          Type: TIMESTAMP
          Provider name: updateTime
          Description: Last time the condition was updated.
          
      • timed_promote_release_condition
        Type: STRUCT
        Provider name: timedPromoteReleaseCondition
        Description: Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
        
        • next_promotion_time
          Type: TIMESTAMP
          Provider name: nextPromotionTime
          Description: Output only. When the next scheduled promotion(s) will occur.
          
        • targets_list
          Type: UNORDERED_LIST_STRUCT
          Provider name: targetsList
          Description: Output only. A list of targets involved in the upcoming timed promotion(s).
          
          • destination_target_id
            Type: STRING
            Provider name: destinationTargetId
            Description: Optional. The destination target ID.
            
          • source_target_id
            Type: STRING
            Provider name: sourceTargetId
            Description: Optional. The source target ID.
            
    • id
      Type: STRING
      Provider name: id
      Description: Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
      
    • source_phases
      Type: UNORDERED_LIST_STRING
      Provider name: sourcePhases
      Description: Optional. Proceeds only after phase name matched any one in the list. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
      
    • wait
      Type: STRING
      Provider name: wait
      Description: Optional. How long to wait after a rollout is finished.
      
  • promote_release_rule
    Type: STRUCT
    Provider name: promoteReleaseRule
    Description: Optional. PromoteReleaseRule will automatically promote a release from the current target to a specified target.
    
    • condition
      Type: STRUCT
      Provider name: condition
      Description: Output only. Information around the state of the Automation rule.
      
      • targets_present_condition
        Type: STRUCT
        Provider name: targetsPresentCondition
        Description: Optional. Details around targets enumerated in the rule.
        
        • gcp_status
          Type: BOOLEAN
          Provider name: status
          Description: True if there aren’t any missing Targets.
          
        • missing_targets
          Type: UNORDERED_LIST_STRING
          Provider name: missingTargets
          Description: The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.
          
        • update_time
          Type: TIMESTAMP
          Provider name: updateTime
          Description: Last time the condition was updated.
          
      • timed_promote_release_condition
        Type: STRUCT
        Provider name: timedPromoteReleaseCondition
        Description: Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
        
        • next_promotion_time
          Type: TIMESTAMP
          Provider name: nextPromotionTime
          Description: Output only. When the next scheduled promotion(s) will occur.
          
        • targets_list
          Type: UNORDERED_LIST_STRUCT
          Provider name: targetsList
          Description: Output only. A list of targets involved in the upcoming timed promotion(s).
          
          • destination_target_id
            Type: STRING
            Provider name: destinationTargetId
            Description: Optional. The destination target ID.
            
          • source_target_id
            Type: STRING
            Provider name: sourceTargetId
            Description: Optional. The source target ID.
            
    • destination_phase
      Type: STRING
      Provider name: destinationPhase
      Description: Optional. The starting phase of the rollout created by this operation. Default to the first phase.
      
    • destination_target_id
      Type: STRING
      Provider name: destinationTargetId
      Description: Optional. The ID of the stage in the pipeline to which this Release is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * “@next”, the next target in the promotion sequence
      
    • id
      Type: STRING
      Provider name: id
      Description: Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
      
    • wait
      Type: STRING
      Provider name: wait
      Description: Optional. How long the release need to be paused until being promoted to the next target.
      
  • repair_rollout_rule
    Type: STRUCT
    Provider name: repairRolloutRule
    Description: Optional. The RepairRolloutRule will automatically repair a failed rollout.
    
    • condition
      Type: STRUCT
      Provider name: condition
      Description: Output only. Information around the state of the ‘Automation’ rule.
      
      • targets_present_condition
        Type: STRUCT
        Provider name: targetsPresentCondition
        Description: Optional. Details around targets enumerated in the rule.
        
        • gcp_status
          Type: BOOLEAN
          Provider name: status
          Description: True if there aren’t any missing Targets.
          
        • missing_targets
          Type: UNORDERED_LIST_STRING
          Provider name: missingTargets
          Description: The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.
          
        • update_time
          Type: TIMESTAMP
          Provider name: updateTime
          Description: Last time the condition was updated.
          
      • timed_promote_release_condition
        Type: STRUCT
        Provider name: timedPromoteReleaseCondition
        Description: Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
        
        • next_promotion_time
          Type: TIMESTAMP
          Provider name: nextPromotionTime
          Description: Output only. When the next scheduled promotion(s) will occur.
          
        • targets_list
          Type: UNORDERED_LIST_STRUCT
          Provider name: targetsList
          Description: Output only. A list of targets involved in the upcoming timed promotion(s).
          
          • destination_target_id
            Type: STRING
            Provider name: destinationTargetId
            Description: Optional. The destination target ID.
            
          • source_target_id
            Type: STRING
            Provider name: sourceTargetId
            Description: Optional. The source target ID.
            
    • id
      Type: STRING
      Provider name: id
      Description: Required. ID of the rule. This id must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
      
    • jobs
      Type: UNORDERED_LIST_STRING
      Provider name: jobs
      Description: Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in source_phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
      
    • phases
      Type: UNORDERED_LIST_STRING
      Provider name: phases
      Description: Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
      
    • repair_phases
      Type: UNORDERED_LIST_STRUCT
      Provider name: repairPhases
      Description: Required. Defines the types of automatic repair phases for failed jobs.
      
      • retry
        Type: STRUCT
        Provider name: retry
        Description: Optional. Retries a failed job.
        
        • attempts
          Type: INT64
          Provider name: attempts
          Description: Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
          
        • backoff_mode
          Type: STRING
          Provider name: backoffMode
          Description: Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if wait is 0.
          Possible values:
          
          • BACKOFF_MODE_UNSPECIFIED - No WaitMode is specified.
            
          • BACKOFF_MODE_LINEAR - Increases the wait time linearly.
            
          • BACKOFF_MODE_EXPONENTIAL - Increases the wait time exponentially.
            
        • wait
          Type: STRING
          Provider name: wait
          Description: Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
          
      • rollback
        Type: STRUCT
        Provider name: rollback
        Description: Optional. Rolls back a Rollout.
        
        • destination_phase
          Type: STRING
          Provider name: destinationPhase
          Description: Optional. The starting phase ID for the Rollout. If unspecified, the Rollout will start in the stable phase.
          
        • disable_rollback_if_rollout_pending
          Type: BOOLEAN
          Provider name: disableRollbackIfRolloutPending
          Description: Optional. If pending rollout exists on the target, the rollback operation will be aborted.
          
  • timed_promote_release_rule
    Type: STRUCT
    Provider name: timedPromoteReleaseRule
    Description: Optional. The TimedPromoteReleaseRule will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
    
    • condition
      Type: STRUCT
      Provider name: condition
      Description: Output only. Information around the state of the Automation rule.
      
      • targets_present_condition
        Type: STRUCT
        Provider name: targetsPresentCondition
        Description: Optional. Details around targets enumerated in the rule.
        
        • gcp_status
          Type: BOOLEAN
          Provider name: status
          Description: True if there aren’t any missing Targets.
          
        • missing_targets
          Type: UNORDERED_LIST_STRING
          Provider name: missingTargets
          Description: The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.
          
        • update_time
          Type: TIMESTAMP
          Provider name: updateTime
          Description: Last time the condition was updated.
          
      • timed_promote_release_condition
        Type: STRUCT
        Provider name: timedPromoteReleaseCondition
        Description: Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
        
        • next_promotion_time
          Type: TIMESTAMP
          Provider name: nextPromotionTime
          Description: Output only. When the next scheduled promotion(s) will occur.
          
        • targets_list
          Type: UNORDERED_LIST_STRUCT
          Provider name: targetsList
          Description: Output only. A list of targets involved in the upcoming timed promotion(s).
          
          • destination_target_id
            Type: STRING
            Provider name: destinationTargetId
            Description: Optional. The destination target ID.
            
          • source_target_id
            Type: STRING
            Provider name: sourceTargetId
            Description: Optional. The source target ID.
            
    • destination_phase
      Type: STRING
      Provider name: destinationPhase
      Description: Optional. The starting phase of the rollout created by this rule. Default to the first phase.
      
    • destination_target_id
      Type: STRING
      Provider name: destinationTargetId
      Description: Optional. The ID of the stage in the pipeline to which this Release is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * “@next”, the next target in the promotion sequence
      
    • id
      Type: STRING
      Provider name: id
      Description: Required. ID of the rule. This ID must be unique in the Automation resource to which this rule belongs. The format is [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
      
    • schedule
      Type: STRING
      Provider name: schedule
      Description: Required. Schedule in crontab format. e.g. “0 9 * * 1” for every Monday at 9am.
      
    • time_zone
      Type: STRING
      Provider name: timeZone
      Description: Required. The time zone in IANA format IANA Time Zone Database (e.g. America/New_York).
      
• selector
  Type: STRUCT
  Provider name: selector
  Description: Required. Selected resources to which the automation will be applied.
  
  • targets
    Type: UNORDERED_LIST_STRUCT
    Provider name: targets
    Description: Optional. Contains attributes about a target.
    
    • id
      Type: STRING
      Provider name: id
      Description: Optional. ID of the Target. The value of this field could be one of the following: * The last segment of a target name * “*”, all targets in a location
      
• service_account
  Type: STRING
  Provider name: serviceAccount
  Description: Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
  
• suspended
  Type: BOOLEAN
  Provider name: suspended
  Description: Optional. When Suspended, automation is deactivated from execution.
  
• uid
  Type: STRING
  Provider name: uid
  Description: Output only. Unique identifier of the Automation.
  
• update_time
  Type: TIMESTAMP
  Provider name: updateTime
  Description: Output only. Time at which the automation was updated.
  

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. Time at which the AutomationRun was created.

etag

Type: STRING
Provider name: etag
Description: 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.

expire_time

Type: TIMESTAMP
Provider name: expireTime
Description: Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

organization_id

Type: STRING

parent

Type: STRING

policy_violation

Type: STRUCT
Provider name: policyViolation
Description: Output only. Contains information about what policies prevented the AutomationRun from proceeding.

• policy_violation_details
  Type: UNORDERED_LIST_STRUCT
  Provider name: policyViolationDetails
  Description: Policy violation details.
  
  • failure_message
    Type: STRING
    Provider name: failureMessage
    Description: User readable message about why the request violated a policy. This is not intended for machine parsing.
    
  • policy
    Type: STRING
    Provider name: policy
    Description: Name of the policy that was violated. Policy resource will be in the format of projects/{project}/locations/{location}/policies/{policy}.
    
  • rule_id
    Type: STRING
    Provider name: ruleId
    Description: Id of the rule that triggered the policy violation.
    

project_id

Type: STRING

project_number

Type: STRING

promote_release_operation

Type: STRUCT
Provider name: promoteReleaseOperation
Description: Output only. Promotes a release to a specified ‘Target’.

• phase
  Type: STRING
  Provider name: phase
  Description: Output only. The starting phase of the rollout created by this operation.
  
• rollout
  Type: STRING
  Provider name: rollout
  Description: Output only. The name of the rollout that initiates the AutomationRun.
  
• target_id
  Type: STRING
  Provider name: targetId
  Description: 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
  Type: STRING
  Provider name: wait
  Description: Output only. How long the operation will be paused.
  

repair_rollout_operation

Type: STRUCT
Provider name: repairRolloutOperation
Description: Output only. Repairs a failed ‘Rollout’.

• current_repair_phase_index
  Type: INT64
  Provider name: currentRepairPhaseIndex
  Description: Output only. The index of the current repair action in the repair sequence.
  
• job_id
  Type: STRING
  Provider name: jobId
  Description: Output only. The job ID for the Job to repair.
  
• phase_id
  Type: STRING
  Provider name: phaseId
  Description: Output only. The phase ID of the phase that includes the job being repaired.
  
• repair_phases
  Type: UNORDERED_LIST_STRUCT
  Provider name: repairPhases
  Description: Output only. Records of the repair attempts. Each repair phase may have multiple retry attempts or single rollback attempt.
  
  • retry
    Type: STRUCT
    Provider name: retry
    Description: Output only. Records of the retry attempts for retry repair mode.
    
    • attempts
      Type: UNORDERED_LIST_STRUCT
      Provider name: attempts
      Description: Output only. Detail of a retry action.
      
      • attempt
        Type: INT64
        Provider name: attempt
        Description: Output only. The index of this retry attempt.
        
      • state
        Type: STRING
        Provider name: state
        Description: Output only. Valid state of this retry action.
        Possible values:
        
        • 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.
          
      • state_desc
        Type: STRING
        Provider name: stateDesc
        Description: Output only. Description of the state of the Retry.
        
      • wait
        Type: STRING
        Provider name: wait
        Description: Output only. How long the operation will be paused.
        
    • backoff_mode
      Type: STRING
      Provider name: backoffMode
      Description: Output only. The pattern of how the wait time of the retry attempt is calculated.
      Possible values:
      
      • BACKOFF_MODE_UNSPECIFIED - No WaitMode is specified.
        
      • BACKOFF_MODE_LINEAR - Increases the wait time linearly.
        
      • BACKOFF_MODE_EXPONENTIAL - Increases the wait time exponentially.
        
    • total_attempts
      Type: INT64
      Provider name: totalAttempts
      Description: Output only. The number of attempts that have been made.
      
  • rollback
    Type: STRUCT
    Provider name: rollback
    Description: Output only. Rollback attempt for rollback repair mode .
    
    • destination_phase
      Type: STRING
      Provider name: destinationPhase
      Description: Output only. The phase to which the rollout will be rolled back to.
      
    • disable_rollback_if_rollout_pending
      Type: BOOLEAN
      Provider name: disableRollbackIfRolloutPending
      Description: Output only. If active rollout exists on the target, abort this rollback.
      
    • rollout_id
      Type: STRING
      Provider name: rolloutId
      Description: Output only. ID of the rollback Rollout to create.
      
    • state
      Type: STRING
      Provider name: state
      Description: Output only. Valid state of this rollback action.
      Possible values:
      
      • 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.
        
    • state_desc
      Type: STRING
      Provider name: stateDesc
      Description: Output only. Description of the state of the Rollback.
      
• rollout
  Type: STRING
  Provider name: rollout
  Description: Output only. The name of the rollout that initiates the AutomationRun.
  

resource_name

Type: STRING

rule_id

Type: STRING
Provider name: ruleId
Description: Output only. The ID of the automation rule that initiated the operation.

service_account

Type: STRING
Provider name: serviceAccount
Description: Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.

state

Type: STRING
Provider name: state
Description: Output only. Current state of the AutomationRun.
Possible values:

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

state_description

Type: STRING
Provider name: stateDescription
Description: Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.

tags

Type: UNORDERED_LIST_STRING

target_id

Type: STRING
Provider name: targetId
Description: 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.

timed_promote_release_operation

Type: STRUCT
Provider name: timedPromoteReleaseOperation
Description: Output only. Promotes a release to a specified ‘Target’ as defined in a Timed Promote Release rule.

• phase
  Type: STRING
  Provider name: phase
  Description: Output only. The starting phase of the rollout created by this operation.
  
• release
  Type: STRING
  Provider name: release
  Description: Output only. The name of the release to be promoted.
  
• target_id
  Type: STRING
  Provider name: targetId
  Description: 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.
  

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Time at which the automationRun was updated.

wait_until_time

Type: TIMESTAMP
Provider name: waitUntilTime
Description: Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.