Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1332185209.7 KB
projects

Creates a new Rollout in a given project and location.

post/v1/{+parent}/rollouts

Path parameters

parentstring required

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

Query parameters

overrideDeployPolicystring[]

Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.

requestIdstring

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

rolloutIdstring

Required. ID of the Rollout.

startingPhaseIdstring

Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

validateOnlyboolean

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Request body

state'STATE_UNSPECIFIED' | 'SUCCEEDED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING_APPROVAL' | 'APPROVAL_REJECTED' | 'PENDING' | 'PENDING_RELEASE' | 'CANCELLING' | 'CANCELLED' | 'HALTED'

Output only. Current state of the Rollout.

etagstring

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.

activeRepairAutomationRunstring

Output only. The AutomationRun actively repairing the rollout.

uidstring

Output only. Unique identifier of the Rollout.

labelsobject

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.

deployEndTimestring google-datetime

Output only. Time at which the Rollout finished deploying.

deployFailureCause'FAILURE_CAUSE_UNSPECIFIED' | 'CLOUD_BUILD_UNAVAILABLE' | 'EXECUTION_FAILED' | 'DEADLINE_EXCEEDED' | 'RELEASE_FAILED' | 'RELEASE_ABANDONED' | 'VERIFICATION_CONFIG_NOT_FOUND' | 'CLOUD_BUILD_REQUEST_FAILED' | 'OPERATION_FEATURE_NOT_SUPPORTED'

Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.

failureReasonstring

Output only. Additional information about the rollout failure, if available.

controllerRolloutstring

Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

namestring

Identifier. 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])?

annotationsobject

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

createTimestring google-datetime

Output only. Time at which the Rollout was created.

rolledBackByRolloutsstring[]

Output only. Names of Rollouts that rolled back this Rollout.

approvalState'APPROVAL_STATE_UNSPECIFIED' | 'NEEDS_APPROVAL' | 'DOES_NOT_NEED_APPROVAL' | 'APPROVED' | 'REJECTED'

Output only. Approval state of the Rollout.

deployingBuildstring

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

enqueueTimestring google-datetime

Output only. Time at which the Rollout was enqueued.

deployStartTimestring google-datetime

Output only. Time at which the Rollout started deploying.

targetIdstring

Required. The ID of Target to which this Rollout is deploying.

descriptionstring

Optional. Description of the Rollout for user purposes. Max length is 255 characters.

rollbackOfRolloutstring

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback.

approveTimestring google-datetime

Output only. Time at which the Rollout was approved.

Response

Successful response