rollouts

Creates, updates, deletes, gets or lists a rollouts resource.

Overview

Name	rollouts
Type	Resource
Id	google.clouddeploy.rollouts

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	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])?
activeRepairAutomationRun	string	Output only. The AutomationRun actively repairing the rollout.
annotations	object	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.
approvalState	string	Output only. Approval state of the Rollout.
approveTime	string (google-datetime)	Output only. Time at which the Rollout was approved.
controllerRollout	string	Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
createTime	string (google-datetime)	Output only. Time at which the Rollout was created.
deployEndTime	string (google-datetime)	Output only. Time at which the Rollout finished deploying.
deployFailureCause	string	Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
deployStartTime	string (google-datetime)	Output only. Time at which the Rollout started deploying.
deployingBuild	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	string	Optional. Description of the Rollout for user purposes. Max length is 255 characters.
enqueueTime	string (google-datetime)	Output only. Time at which the Rollout was enqueued.
etag	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	string	Output only. Additional information about the rollout failure, if available.
labels	object	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.
metadata	object	Output only. Metadata contains information about the rollout. (id: Metadata)
phases	array	Output only. The phases that represent the workflows of this Rollout.
rollbackOfRollout	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	array	Output only. Names of Rollouts that rolled back this Rollout.
state	string	Output only. Current state of the Rollout.
targetId	string	Required. The ID of Target to which this Rollout is deploying.
uid	string	Output only. Unique identifier of the Rollout.

list

Successful response

Name	Datatype	Description
name	string	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])?
activeRepairAutomationRun	string	Output only. The AutomationRun actively repairing the rollout.
annotations	object	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.
approvalState	string	Output only. Approval state of the Rollout.
approveTime	string (google-datetime)	Output only. Time at which the Rollout was approved.
controllerRollout	string	Output only. Name of the ControllerRollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
createTime	string (google-datetime)	Output only. Time at which the Rollout was created.
deployEndTime	string (google-datetime)	Output only. Time at which the Rollout finished deploying.
deployFailureCause	string	Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.
deployStartTime	string (google-datetime)	Output only. Time at which the Rollout started deploying.
deployingBuild	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	string	Optional. Description of the Rollout for user purposes. Max length is 255 characters.
enqueueTime	string (google-datetime)	Output only. Time at which the Rollout was enqueued.
etag	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	string	Output only. Additional information about the rollout failure, if available.
labels	object	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.
metadata	object	Output only. Metadata contains information about the rollout. (id: Metadata)
phases	array	Output only. The phases that represent the workflows of this Rollout.
rollbackOfRollout	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	array	Output only. Names of Rollouts that rolled back this Rollout.
state	string	Output only. Current state of the Rollout.
targetId	string	Required. The ID of Target to which this Rollout is deploying.
uid	string	Output only. Unique identifier of the Rollout.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId		Gets details of a single Rollout.
list	select	projectsId, locationsId, deliveryPipelinesId, releasesId	pageSize, pageToken, filter, orderBy	Lists Rollouts in a given project and location.
create	insert	projectsId, locationsId, deliveryPipelinesId, releasesId	rolloutId, requestId, validateOnly, overrideDeployPolicy, startingPhaseId	Creates a new Rollout in a given project and location.
approve	exec	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId		Approves a Rollout.
advance	exec	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId		Advances a Rollout in a given project and location.
cancel	exec	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId		Cancels a Rollout in a given project and location.
ignore_job	exec	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId		Ignores the specified Job in a Rollout.
retry_job	exec	projectsId, locationsId, deliveryPipelinesId, releasesId, rolloutsId		Retries the specified Job in a Rollout.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deliveryPipelinesId	string
locationsId	string
projectsId	string
releasesId	string
rolloutsId	string
filter	string
orderBy	string
overrideDeployPolicy	string
pageSize	integer (int32)
pageToken	string
requestId	string
rolloutId	string
startingPhaseId	string
validateOnly	boolean

SELECT examples

get

Gets details of a single Rollout.

SELECT
name,
activeRepairAutomationRun,
annotations,
approvalState,
approveTime,
controllerRollout,
createTime,
deployEndTime,
deployFailureCause,
deployStartTime,
deployingBuild,
description,
enqueueTime,
etag,
failureReason,
labels,
metadata,
phases,
rollbackOfRollout,
rolledBackByRollouts,
state,
targetId,
uid
FROM google.clouddeploy.rollouts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND releasesId = '{{ releasesId }}' -- required
AND rolloutsId = '{{ rolloutsId }}' -- required;

list

Lists Rollouts in a given project and location.

SELECT
name,
activeRepairAutomationRun,
annotations,
approvalState,
approveTime,
controllerRollout,
createTime,
deployEndTime,
deployFailureCause,
deployStartTime,
deployingBuild,
description,
enqueueTime,
etag,
failureReason,
labels,
metadata,
phases,
rollbackOfRollout,
rolledBackByRollouts,
state,
targetId,
uid
FROM google.clouddeploy.rollouts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND deliveryPipelinesId = '{{ deliveryPipelinesId }}' -- required
AND releasesId = '{{ releasesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new Rollout in a given project and location.

INSERT INTO google.clouddeploy.rollouts (
data__name,
data__description,
data__annotations,
data__labels,
data__targetId,
data__etag,
projectsId,
locationsId,
deliveryPipelinesId,
releasesId,
rolloutId,
requestId,
validateOnly,
overrideDeployPolicy,
startingPhaseId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ annotations }}',
'{{ labels }}',
'{{ targetId }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ deliveryPipelinesId }}',
'{{ releasesId }}',
'{{ rolloutId }}',
'{{ requestId }}',
'{{ validateOnly }}',
'{{ overrideDeployPolicy }}',
'{{ startingPhaseId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: rollouts
  props:
    - name: projectsId
      value: string
      description: Required parameter for the rollouts resource.
    - name: locationsId
      value: string
      description: Required parameter for the rollouts resource.
    - name: deliveryPipelinesId
      value: string
      description: Required parameter for the rollouts resource.
    - name: releasesId
      value: string
      description: Required parameter for the rollouts resource.
    - name: name
      value: string
      description: >
        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])?`
        
    - name: description
      value: string
      description: >
        Optional. Description of the `Rollout` for user purposes. Max length is 255 characters.
        
    - name: annotations
      value: object
      description: >
        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.
        
    - name: labels
      value: object
      description: >
        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.
        
    - name: targetId
      value: string
      description: >
        Required. The ID of Target to which this `Rollout` is deploying.
        
    - name: etag
      value: string
      description: >
        This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
        
    - name: rolloutId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean
    - name: overrideDeployPolicy
      value: string
    - name: startingPhaseId
      value: string

Lifecycle Methods

approve

Approves a Rollout.

EXEC google.clouddeploy.rollouts.approve 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@releasesId='{{ releasesId }}' --required, 
@rolloutsId='{{ rolloutsId }}' --required 
@@json=
'{
"approved": {{ approved }}, 
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}';

advance

Advances a Rollout in a given project and location.

EXEC google.clouddeploy.rollouts.advance 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@releasesId='{{ releasesId }}' --required, 
@rolloutsId='{{ rolloutsId }}' --required 
@@json=
'{
"phaseId": "{{ phaseId }}", 
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}';

cancel

Cancels a Rollout in a given project and location.

EXEC google.clouddeploy.rollouts.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@releasesId='{{ releasesId }}' --required, 
@rolloutsId='{{ rolloutsId }}' --required 
@@json=
'{
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}';

ignore_job

Ignores the specified Job in a Rollout.

EXEC google.clouddeploy.rollouts.ignore_job 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@releasesId='{{ releasesId }}' --required, 
@rolloutsId='{{ rolloutsId }}' --required 
@@json=
'{
"phaseId": "{{ phaseId }}", 
"jobId": "{{ jobId }}", 
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}';

retry_job

Retries the specified Job in a Rollout.

EXEC google.clouddeploy.rollouts.retry_job 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@deliveryPipelinesId='{{ deliveryPipelinesId }}' --required, 
@releasesId='{{ releasesId }}' --required, 
@rolloutsId='{{ rolloutsId }}' --required 
@@json=
'{
"phaseId": "{{ phaseId }}", 
"jobId": "{{ jobId }}", 
"overrideDeployPolicy": "{{ overrideDeployPolicy }}"
}';