Returns the jobRuns Resource.
advance(name, body=None, x__xgafv=None)
Advances a Rollout in a given project and location.
approve(name, body=None, x__xgafv=None)
Approves a Rollout.
cancel(name, body=None, x__xgafv=None)
Cancels a Rollout in a given project and location.
Close httplib2 connections.
Creates a new Rollout in a given project and location.
Gets details of a single Rollout.
ignoreJob(rollout, body=None, x__xgafv=None)
Ignores the specified Job in a Rollout.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Rollouts in a given project and location.
Retrieves the next page of results.
retryJob(rollout, body=None, x__xgafv=None)
Retries the specified Job in a Rollout.
advance(name, body=None, x__xgafv=None)
Advances a Rollout in a given project and location.
Args:
name: string, Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `AdvanceRollout`.
"overrideDeployPolicy": [ # Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
"A String",
],
"phaseId": "A String", # Required. The phase ID to advance the `Rollout` to.
}
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 `AdvanceRollout`.
}
approve(name, body=None, x__xgafv=None)
Approves a Rollout.
Args:
name: string, Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `ApproveRollout`.
"approved": True or False, # Required. True = approve; false = reject
"overrideDeployPolicy": [ # Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
"A String",
],
}
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 `ApproveRollout`.
}
cancel(name, body=None, x__xgafv=None)
Cancels a Rollout in a given project and location.
Args:
name: string, Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `CancelRollout`.
"overrideDeployPolicy": [ # Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
"A String",
],
}
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 `CancelRollout`.
}
close()
Close httplib2 connections.
create(parent, body=None, overrideDeployPolicy=None, requestId=None, rolloutId=None, startingPhaseId=None, validateOnly=None, x__xgafv=None)
Creates a new Rollout in a given project and location.
Args:
parent: string, Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`. (required)
body: object, The request body.
The object takes the form of:
{ # A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.
"activeRepairAutomationRun": "A String", # Output only. The AutomationRun actively repairing the rollout.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"approvalState": "A String", # Output only. Approval state of the `Rollout`.
"approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
"controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
"createTime": "A String", # Output only. Time at which the `Rollout` was created.
"deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
"deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
"deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
"deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.
"description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
"enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
"etag": "A String", # 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.
"failureReason": "A String", # Output only. Additional information about the rollout failure, if available.
"labels": { # 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 <= 128 bytes.
"a_key": "A String",
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
"repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
"job": "A String", # Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.
"revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
"service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/services/{service}`.
"serviceUrls": [ # Output only. The Cloud Run Service urls that are associated with a `Rollout`.
"A String",
],
},
"custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined `Rollout` operations.
"values": { # Output only. Key-value pairs provided by the user-defined operation.
"a_key": "A String",
},
},
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
{ # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
"childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
"advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
"createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
},
"deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
"deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"postdeployJob": { # Job represents an operation for a `Rollout`. # Output only. The postdeploy Job, which is the last job on the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"predeployJob": { # Job represents an operation for a `Rollout`. # Output only. The predeploy Job, which is the first job on the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
},
"id": "A String", # Output only. The ID of the Phase.
"skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
"state": "A String", # Output only. Current state of the Phase.
},
],
"rollbackOfRollout": "A String", # Output only. Name of the `Rollout` that is rolled back by this `Rollout`. Empty if this `Rollout` wasn't created as a rollback.
"rolledBackByRollouts": [ # Output only. Names of `Rollouts` that rolled back this `Rollout`.
"A String",
],
"state": "A String", # Output only. Current state of the `Rollout`.
"targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
"uid": "A String", # Output only. Unique identifier of the `Rollout`.
}
overrideDeployPolicy: string, Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. (repeated)
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).
rolloutId: string, Required. ID of the `Rollout`.
startingPhaseId: string, Optional. The starting phase ID for the `Rollout`. If empty the `Rollout` will start at the first phase.
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.
},
}
get(name, x__xgafv=None)
Gets details of a single Rollout.
Args:
name: string, Required. Name of the `Rollout`. Format must be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.
"activeRepairAutomationRun": "A String", # Output only. The AutomationRun actively repairing the rollout.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"approvalState": "A String", # Output only. Approval state of the `Rollout`.
"approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
"controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
"createTime": "A String", # Output only. Time at which the `Rollout` was created.
"deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
"deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
"deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
"deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.
"description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
"enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
"etag": "A String", # 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.
"failureReason": "A String", # Output only. Additional information about the rollout failure, if available.
"labels": { # 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 <= 128 bytes.
"a_key": "A String",
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
"repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
"job": "A String", # Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.
"revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
"service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/services/{service}`.
"serviceUrls": [ # Output only. The Cloud Run Service urls that are associated with a `Rollout`.
"A String",
],
},
"custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined `Rollout` operations.
"values": { # Output only. Key-value pairs provided by the user-defined operation.
"a_key": "A String",
},
},
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
{ # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
"childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
"advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
"createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
},
"deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
"deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"postdeployJob": { # Job represents an operation for a `Rollout`. # Output only. The postdeploy Job, which is the last job on the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"predeployJob": { # Job represents an operation for a `Rollout`. # Output only. The predeploy Job, which is the first job on the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
},
"id": "A String", # Output only. The ID of the Phase.
"skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
"state": "A String", # Output only. Current state of the Phase.
},
],
"rollbackOfRollout": "A String", # Output only. Name of the `Rollout` that is rolled back by this `Rollout`. Empty if this `Rollout` wasn't created as a rollback.
"rolledBackByRollouts": [ # Output only. Names of `Rollouts` that rolled back this `Rollout`.
"A String",
],
"state": "A String", # Output only. Current state of the `Rollout`.
"targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
"uid": "A String", # Output only. Unique identifier of the `Rollout`.
}
ignoreJob(rollout, body=None, x__xgafv=None)
Ignores the specified Job in a Rollout.
Args:
rollout: string, Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request object used by `IgnoreJob`.
"jobId": "A String", # Required. The job ID for the Job to ignore.
"overrideDeployPolicy": [ # Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
"A String",
],
"phaseId": "A String", # Required. The phase ID the Job to ignore belongs to.
}
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 `IgnoreJob`.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Rollouts in a given project and location.
Args:
parent: string, Required. The `Release` which owns this collection of `Rollout` objects. (required)
filter: string, Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.
orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Optional. The maximum number of `Rollout` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Rollout` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
pageToken: string, Optional. A page token, received from a previous `ListRollouts` 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:
{ # ListRolloutsResponse is the response object reutrned by `ListRollouts`.
"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.
"rollouts": [ # The `Rollout` objects.
{ # A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.
"activeRepairAutomationRun": "A String", # Output only. The AutomationRun actively repairing the rollout.
"annotations": { # User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
"a_key": "A String",
},
"approvalState": "A String", # Output only. Approval state of the `Rollout`.
"approveTime": "A String", # Output only. Time at which the `Rollout` was approved.
"controllerRollout": "A String", # Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
"createTime": "A String", # Output only. Time at which the `Rollout` was created.
"deployEndTime": "A String", # Output only. Time at which the `Rollout` finished deploying.
"deployFailureCause": "A String", # Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
"deployStartTime": "A String", # Output only. Time at which the `Rollout` started deploying.
"deployingBuild": "A String", # Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.
"description": "A String", # Description of the `Rollout` for user purposes. Max length is 255 characters.
"enqueueTime": "A String", # Output only. Time at which the `Rollout` was enqueued.
"etag": "A String", # 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.
"failureReason": "A String", # Output only. Additional information about the rollout failure, if available.
"labels": { # 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 <= 128 bytes.
"a_key": "A String",
},
"metadata": { # Metadata includes information associated with a `Rollout`. # Output only. Metadata contains information about the rollout.
"automation": { # AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout. # Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
"advanceAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by an advance rollout rule.
"A String",
],
"promoteAutomationRun": "A String", # Output only. The name of the AutomationRun initiated by a promote release rule.
"repairAutomationRuns": [ # Output only. The names of the AutomationRuns initiated by a repair rollout rule.
"A String",
],
},
"cloudRun": { # CloudRunMetadata contains information from a Cloud Run deployment. # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
"job": "A String", # Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.
"revision": "A String", # Output only. The Cloud Run Revision id associated with a `Rollout`.
"service": "A String", # Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/services/{service}`.
"serviceUrls": [ # Output only. The Cloud Run Service urls that are associated with a `Rollout`.
"A String",
],
},
"custom": { # CustomMetadata contains information from a user-defined operation. # Output only. Custom metadata provided by user-defined `Rollout` operations.
"values": { # Output only. Key-value pairs provided by the user-defined operation.
"a_key": "A String",
},
},
},
"name": "A String", # Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
"phases": [ # Output only. The phases that represent the workflows of this `Rollout`.
{ # Phase represents a collection of jobs that are logically grouped together for a `Rollout`.
"childRolloutJobs": { # ChildRollouts job composition # Output only. ChildRollout job composition.
"advanceRolloutJobs": [ # Output only. List of AdvanceChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
"createRolloutJobs": [ # Output only. List of CreateChildRolloutJobs
{ # Job represents an operation for a `Rollout`.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
],
},
"deploymentJobs": { # Deployment job composition. # Output only. Deployment job composition.
"deployJob": { # Job represents an operation for a `Rollout`. # Output only. The deploy Job. This is the deploy job in the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"postdeployJob": { # Job represents an operation for a `Rollout`. # Output only. The postdeploy Job, which is the last job on the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"predeployJob": { # Job represents an operation for a `Rollout`. # Output only. The predeploy Job, which is the first job on the phase.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
"verifyJob": { # Job represents an operation for a `Rollout`. # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
"advanceChildRolloutJob": { # An advanceChildRollout Job. # Output only. An advanceChildRollout Job.
},
"createChildRolloutJob": { # A createChildRollout Job. # Output only. A createChildRollout Job.
},
"deployJob": { # A deploy Job. # Output only. A deploy Job.
},
"id": "A String", # Output only. The ID of the Job.
"jobRun": "A String", # Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.
"postdeployJob": { # A postdeploy Job. # Output only. A postdeploy Job.
"actions": [ # Output only. The custom actions that the postdeploy Job executes.
"A String",
],
},
"predeployJob": { # A predeploy Job. # Output only. A predeploy Job.
"actions": [ # Output only. The custom actions that the predeploy Job executes.
"A String",
],
},
"skipMessage": "A String", # Output only. Additional information on why the Job was skipped, if available.
"state": "A String", # Output only. The current state of the Job.
"verifyJob": { # A verify Job. # Output only. A verify Job.
},
},
},
"id": "A String", # Output only. The ID of the Phase.
"skipMessage": "A String", # Output only. Additional information on why the Phase was skipped, if available.
"state": "A String", # Output only. Current state of the Phase.
},
],
"rollbackOfRollout": "A String", # Output only. Name of the `Rollout` that is rolled back by this `Rollout`. Empty if this `Rollout` wasn't created as a rollback.
"rolledBackByRollouts": [ # Output only. Names of `Rollouts` that rolled back this `Rollout`.
"A String",
],
"state": "A String", # Output only. Current state of the `Rollout`.
"targetId": "A String", # Required. The ID of Target to which this `Rollout` is deploying.
"uid": "A String", # Output only. Unique identifier of the `Rollout`.
},
],
"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.
retryJob(rollout, body=None, x__xgafv=None)
Retries the specified Job in a Rollout.
Args:
rollout: string, Required. Name of the Rollout. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. (required)
body: object, The request body.
The object takes the form of:
{ # RetryJobRequest is the request object used by `RetryJob`.
"jobId": "A String", # Required. The job ID for the Job to retry.
"overrideDeployPolicy": [ # Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
"A String",
],
"phaseId": "A String", # Required. The phase ID the Job to retry belongs to.
}
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 'RetryJob'.
}