rollouts

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

Overview

Name	rollouts
Type	Resource
Id	google.clouddeploy.rollouts

Fields

Name	Datatype	Description
name	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])?
description	string	Description of the Rollout for user purposes. Max length is 255 characters.
annotations	object	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	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	Output only. Time at which the Rollout was created.
deployEndTime	string	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	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}.
enqueueTime	string	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	Metadata includes information associated with a Rollout.
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

Name	Accessible by	Required Params	Description
get	SELECT	deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId	Gets details of a single Rollout.
list	SELECT	deliveryPipelinesId, locationsId, projectsId, releasesId	Lists Rollouts in a given project and location.
create	INSERT	deliveryPipelinesId, locationsId, projectsId, releasesId	Creates a new Rollout in a given project and location.
advance	EXEC	deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId	Advances a Rollout in a given project and location.
approve	EXEC	deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId	Approves a Rollout.
cancel	EXEC	deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId	Cancels a Rollout in a given project and location.
ignore_job	EXEC	deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId	Ignores the specified Job in a Rollout.
retry_job	EXEC	deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId	Retries the specified Job in a Rollout.

SELECT examples

Lists Rollouts in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new rollouts resource.

All Properties

/*+ create */
INSERT INTO google.clouddeploy.rollouts (
deliveryPipelinesId,
locationsId,
projectsId,
releasesId,
name,
description,
annotations,
labels,
targetId,
etag
)
SELECT 
'{{ deliveryPipelinesId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ releasesId }}',
'{{ name }}',
'{{ description }}',
'{{ annotations }}',
'{{ labels }}',
'{{ targetId }}',
'{{ etag }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uid
      value: string
    - name: description
      value: string
    - name: annotations
      value: object
    - name: labels
      value: object
    - name: createTime
      value: string
    - name: approveTime
      value: string
    - name: enqueueTime
      value: string
    - name: deployStartTime
      value: string
    - name: deployEndTime
      value: string
    - name: targetId
      value: string
    - name: approvalState
      value: string
    - name: state
      value: string
    - name: failureReason
      value: string
    - name: deployingBuild
      value: string
    - name: etag
      value: string
    - name: deployFailureCause
      value: string
    - name: phases
      value:
        - - name: id
            value: string
          - name: state
            value: string
          - name: skipMessage
            value: string
          - name: deploymentJobs
            value:
              - name: deployJob
                value:
                  - name: id
                    value: string
                  - name: state
                    value: string
                  - name: skipMessage
                    value: string
                  - name: jobRun
                    value: string
                  - name: deployJob
                    value: []
                  - name: verifyJob
                    value: []
                  - name: predeployJob
                    value:
                      - name: actions
                        value:
                          - string
                  - name: postdeployJob
                    value:
                      - name: actions
                        value:
                          - string
                  - name: createChildRolloutJob
                    value: []
                  - name: advanceChildRolloutJob
                    value: []
          - name: childRolloutJobs
            value:
              - name: createRolloutJobs
                value:
                  - - name: id
                      value: string
                    - name: state
                      value: string
                    - name: skipMessage
                      value: string
                    - name: jobRun
                      value: string
              - name: advanceRolloutJobs
                value:
                  - - name: id
                      value: string
                    - name: state
                      value: string
                    - name: skipMessage
                      value: string
                    - name: jobRun
                      value: string
    - name: metadata
      value:
        - name: cloudRun
          value:
            - name: service
              value: string
            - name: serviceUrls
              value:
                - string
            - name: revision
              value: string
            - name: job
              value: string
        - name: automation
          value:
            - name: promoteAutomationRun
              value: string
            - name: advanceAutomationRuns
              value:
                - string
            - name: repairAutomationRuns
              value:
                - string
        - name: custom
          value:
            - name: values
              value: object
    - name: controllerRollout
      value: string
    - name: rollbackOfRollout
      value: string
    - name: rolledBackByRollouts
      value:
        - string