Close httplib2 connections.
create(parent, automationId=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new Automation in a given project and location.
delete(name, allowMissing=None, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single Automation resource.
Gets details of a single Automation.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Automations in a given project and location.
Retrieves the next page of results.
Updates the parameters of a single Automation resource.
close()
Close httplib2 connections.
create(parent, automationId=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new Automation in a given project and location.
Args:
parent: string, Required. The parent collection in which the `Automation` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"annotations": { # 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.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the automation was created.
"description": "A String", # Optional. Description of the `Automation`. Max length is 255 characters.
"etag": "A String", # 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.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
"a_key": "A String",
},
"name": "A String", # Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
"rules": [ # 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.
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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])?`.
"sourcePhases": [ # 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])?$`.
"A String",
],
"wait": "A String", # Optional. How long to wait after a rollout is finished.
},
"promoteReleaseRule": { # The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Optional. How long the release need to be paused until being promoted to the next target.
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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": [ # 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])?$`.
"A String",
],
"phases": [ # 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])?$`.
"A String",
],
"repairPhases": [ # Required. Defines the types of automatic repair phases for failed jobs.
{ # Configuration of the repair phase.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
"attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
"rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`.
"destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
"disableRollbackIfRolloutPending": True or False, # Optional. If pending rollout exists on the target, the rollback operation will be aborted.
},
},
],
},
"timedPromoteReleaseRule": { # The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule. # Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this rule. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.
"timeZone": "A String", # Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York).
},
},
],
"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied.
"targets": [ # Contains attributes about a target.
{ # Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.
"id": "A String", # 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
"labels": { # Target labels.
"a_key": "A String",
},
},
],
},
"serviceAccount": "A String", # Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
"suspended": True or False, # Optional. When Suspended, automation is deactivated from execution.
"uid": "A String", # Output only. Unique identifier of the `Automation`.
"updateTime": "A String", # Output only. Time at which the automation was updated.
}
automationId: string, Required. ID of the `Automation`.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, allowMissing=None, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single Automation resource.
Args:
name: string, Required. The name of the `Automation` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`. (required)
allowMissing: boolean, Optional. If set to true, then deleting an already deleted or non-existing `Automation` will succeed.
etag: string, Optional. The weak etag of the request. 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.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets details of a single Automation.
Args:
name: string, Required. Name of the `Automation`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"annotations": { # 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.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the automation was created.
"description": "A String", # Optional. Description of the `Automation`. Max length is 255 characters.
"etag": "A String", # 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.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
"a_key": "A String",
},
"name": "A String", # Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
"rules": [ # 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.
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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])?`.
"sourcePhases": [ # 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])?$`.
"A String",
],
"wait": "A String", # Optional. How long to wait after a rollout is finished.
},
"promoteReleaseRule": { # The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Optional. How long the release need to be paused until being promoted to the next target.
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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": [ # 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])?$`.
"A String",
],
"phases": [ # 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])?$`.
"A String",
],
"repairPhases": [ # Required. Defines the types of automatic repair phases for failed jobs.
{ # Configuration of the repair phase.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
"attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
"rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`.
"destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
"disableRollbackIfRolloutPending": True or False, # Optional. If pending rollout exists on the target, the rollback operation will be aborted.
},
},
],
},
"timedPromoteReleaseRule": { # The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule. # Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this rule. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.
"timeZone": "A String", # Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York).
},
},
],
"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied.
"targets": [ # Contains attributes about a target.
{ # Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.
"id": "A String", # 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
"labels": { # Target labels.
"a_key": "A String",
},
},
],
},
"serviceAccount": "A String", # Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
"suspended": True or False, # Optional. When Suspended, automation is deactivated from execution.
"uid": "A String", # Output only. Unique identifier of the `Automation`.
"updateTime": "A String", # Output only. Time at which the automation was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Automations in a given project and location.
Args:
parent: string, Required. The parent `Delivery Pipeline`, which owns this collection of automations. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. (required)
filter: string, Filter automations to be returned. All fields can be used in the filter.
orderBy: string, Field to sort by.
pageSize: integer, The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
pageToken: string, A page token, received from a previous `ListAutomations` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response object from `ListAutomations`.
"automations": [ # The `Automation` objects.
{ # 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.
"annotations": { # 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.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the automation was created.
"description": "A String", # Optional. Description of the `Automation`. Max length is 255 characters.
"etag": "A String", # 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.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
"a_key": "A String",
},
"name": "A String", # Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
"rules": [ # 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.
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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])?`.
"sourcePhases": [ # 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])?$`.
"A String",
],
"wait": "A String", # Optional. How long to wait after a rollout is finished.
},
"promoteReleaseRule": { # The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Optional. How long the release need to be paused until being promoted to the next target.
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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": [ # 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])?$`.
"A String",
],
"phases": [ # 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])?$`.
"A String",
],
"repairPhases": [ # Required. Defines the types of automatic repair phases for failed jobs.
{ # Configuration of the repair phase.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
"attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
"rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`.
"destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
"disableRollbackIfRolloutPending": True or False, # Optional. If pending rollout exists on the target, the rollback operation will be aborted.
},
},
],
},
"timedPromoteReleaseRule": { # The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule. # Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this rule. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.
"timeZone": "A String", # Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York).
},
},
],
"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied.
"targets": [ # Contains attributes about a target.
{ # Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.
"id": "A String", # 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
"labels": { # Target labels.
"a_key": "A String",
},
},
],
},
"serviceAccount": "A String", # Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
"suspended": True or False, # Optional. When Suspended, automation is deactivated from execution.
"uid": "A String", # Output only. Unique identifier of the `Automation`.
"updateTime": "A String", # Output only. Time at which the automation was updated.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single Automation resource.
Args:
name: string, Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"annotations": { # 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.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the automation was created.
"description": "A String", # Optional. Description of the `Automation`. Max length is 255 characters.
"etag": "A String", # 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.
"labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.
"a_key": "A String",
},
"name": "A String", # Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
"rules": [ # 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.
{ # `AutomationRule` defines the automation activities.
"advanceRolloutRule": { # The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase. # Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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])?`.
"sourcePhases": [ # 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])?$`.
"A String",
],
"wait": "A String", # Optional. How long to wait after a rollout is finished.
},
"promoteReleaseRule": { # The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. # Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Optional. How long the release need to be paused until being promoted to the next target.
},
"repairRolloutRule": { # The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`. # Optional. The `RepairRolloutRule` will automatically repair a failed rollout.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the 'Automation' rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"id": "A String", # 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": [ # 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])?$`.
"A String",
],
"phases": [ # 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])?$`.
"A String",
],
"repairPhases": [ # Required. Defines the types of automatic repair phases for failed jobs.
{ # Configuration of the repair phase.
"retry": { # Retries the failed job. # Optional. Retries a failed job.
"attempts": "A String", # Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.
"backoffMode": "A String", # Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.
"wait": "A String", # Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.
},
"rollback": { # Rolls back a `Rollout`. # Optional. Rolls back a `Rollout`.
"destinationPhase": "A String", # Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.
"disableRollbackIfRolloutPending": True or False, # Optional. If pending rollout exists on the target, the rollback operation will be aborted.
},
},
],
},
"timedPromoteReleaseRule": { # The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule. # Optional. The `TimedPromoteReleaseRule` will automatically promote a release from the current target(s) to the specified target(s) on a configured schedule.
"condition": { # `AutomationRuleCondition` contains conditions relevant to an `Automation` rule. # Output only. Information around the state of the Automation rule.
"targetsPresentCondition": { # `TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist. # Optional. Details around targets enumerated in the rule.
"missingTargets": [ # The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
"A String",
],
"status": True or False, # True if there aren't any missing Targets.
"updateTime": "A String", # Last time the condition was updated.
},
"timedPromoteReleaseCondition": { # `TimedPromoteReleaseCondition` contains conditions specific to an Automation with a Timed Promote Release rule defined. # Optional. TimedPromoteReleaseCondition contains rule conditions specific to a an Automation with a timed promote release rule defined.
"nextPromotionTime": "A String", # Output only. When the next scheduled promotion(s) will occur.
"targetsList": [ # Output only. A list of targets involved in the upcoming timed promotion(s).
{ # The targets involved in a single timed promotion.
"destinationTargetId": "A String", # Optional. The destination target ID.
"sourceTargetId": "A String", # Optional. The source target ID.
},
],
},
},
"destinationPhase": "A String", # Optional. The starting phase of the rollout created by this rule. Default to the first phase.
"destinationTargetId": "A String", # 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": "A String", # 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": "A String", # Required. Schedule in crontab format. e.g. "0 9 * * 1" for every Monday at 9am.
"timeZone": "A String", # Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York).
},
},
],
"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied.
"targets": [ # Contains attributes about a target.
{ # Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.
"id": "A String", # 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
"labels": { # Target labels.
"a_key": "A String",
},
},
],
},
"serviceAccount": "A String", # Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
"suspended": True or False, # Optional. When Suspended, automation is deactivated from execution.
"uid": "A String", # Output only. Unique identifier of the `Automation`.
"updateTime": "A String", # Output only. Time at which the automation was updated.
}
allowMissing: boolean, Optional. If set to true, updating a `Automation` that does not exist will result in the creation of a new `Automation`.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten by the update in the `Automation` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.
validateOnly: boolean, Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}