rollouts

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

Overview

Name	rollouts
Type	Resource
Id	google.saasservicemgmt.rollouts

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"
annotations	object	Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
control	object	Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state. (id: RolloutControl)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
endTime	string (google-datetime)	Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.
etag	string	Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
parentRollout	string	Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
release	string	Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
rolloutKind	string	Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
rolloutOrchestrationStrategy	string	Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.
rootRollout	string	Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
startTime	string (google-datetime)	Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.
state	string	Output only. Current state of the rollout.
stateMessage	string	Output only. Human readable message indicating details about the last state transition.
stateTransitionTime	string (google-datetime)	Optional. Output only. The time when the rollout transitioned into its current state.
stats	object	Optional. Output only. Details about the progress of the rollout. (id: RolloutStats)
uid	string	Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
unitFilter	string	Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"
annotations	object	Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
control	object	Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state. (id: RolloutControl)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
endTime	string (google-datetime)	Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.
etag	string	Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
labels	object	Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
parentRollout	string	Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
release	string	Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
rolloutKind	string	Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
rolloutOrchestrationStrategy	string	Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.
rootRollout	string	Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
startTime	string (google-datetime)	Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.
state	string	Output only. Current state of the rollout.
stateMessage	string	Output only. Human readable message indicating details about the last state transition.
stateTransitionTime	string (google-datetime)	Optional. Output only. The time when the rollout transitioned into its current state.
stats	object	Optional. Output only. Details about the progress of the rollout. (id: RolloutStats)
uid	string	Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
unitFilter	string	Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, rolloutsId		Retrieve a single rollout.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Retrieve a collection of rollouts.
create	insert	projectsId, locationsId	rolloutId, validateOnly, requestId	Create a new rollout.
patch	update	projectsId, locationsId, rolloutsId	validateOnly, requestId, updateMask	Update a single rollout.
delete	delete	projectsId, locationsId, rolloutsId	etag, validateOnly, requestId	Delete a single 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
locationsId	string
projectsId	string
rolloutsId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
rolloutId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Retrieve a single rollout.

SELECT
name,
annotations,
control,
createTime,
endTime,
etag,
labels,
parentRollout,
release,
rolloutKind,
rolloutOrchestrationStrategy,
rootRollout,
startTime,
state,
stateMessage,
stateTransitionTime,
stats,
uid,
unitFilter,
updateTime
FROM google.saasservicemgmt.rollouts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND rolloutsId = '{{ rolloutsId }}' -- required;

list

Retrieve a collection of rollouts.

SELECT
name,
annotations,
control,
createTime,
endTime,
etag,
labels,
parentRollout,
release,
rolloutKind,
rolloutOrchestrationStrategy,
rootRollout,
startTime,
state,
stateMessage,
stateTransitionTime,
stats,
uid,
unitFilter,
updateTime
FROM google.saasservicemgmt.rollouts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create a new rollout.

INSERT INTO google.saasservicemgmt.rollouts (
data__name,
data__release,
data__rolloutOrchestrationStrategy,
data__unitFilter,
data__rolloutKind,
data__control,
data__labels,
data__annotations,
projectsId,
locationsId,
rolloutId,
validateOnly,
requestId
)
SELECT 
'{{ name }}',
'{{ release }}',
'{{ rolloutOrchestrationStrategy }}',
'{{ unitFilter }}',
'{{ rolloutKind }}',
'{{ control }}',
'{{ labels }}',
'{{ annotations }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ rolloutId }}',
'{{ validateOnly }}',
'{{ requestId }}'
RETURNING
name,
annotations,
control,
createTime,
endTime,
etag,
labels,
parentRollout,
release,
rolloutKind,
rolloutOrchestrationStrategy,
rootRollout,
startTime,
state,
stateMessage,
stateTransitionTime,
stats,
uid,
unitFilter,
updateTime
;

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: name
      value: string
      description: >
        Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"
        
    - name: release
      value: string
      description: >
        Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
        
    - name: rolloutOrchestrationStrategy
      value: string
      description: >
        Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.
        
    - name: unitFilter
      value: string
      description: >
        Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.
        
    - name: rolloutKind
      value: string
      description: >
        Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
        
    - name: control
      value: object
      description: >
        Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.
        
    - name: labels
      value: object
      description: >
        Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
        
    - name: annotations
      value: object
      description: >
        Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
        
    - name: rolloutId
      value: string
    - name: validateOnly
      value: boolean
    - name: requestId
      value: string

UPDATE examples

patch

Update a single rollout.

UPDATE google.saasservicemgmt.rollouts
SET 
data__name = '{{ name }}',
data__release = '{{ release }}',
data__rolloutOrchestrationStrategy = '{{ rolloutOrchestrationStrategy }}',
data__unitFilter = '{{ unitFilter }}',
data__rolloutKind = '{{ rolloutKind }}',
data__control = '{{ control }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND rolloutsId = '{{ rolloutsId }}' --required
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
control,
createTime,
endTime,
etag,
labels,
parentRollout,
release,
rolloutKind,
rolloutOrchestrationStrategy,
rootRollout,
startTime,
state,
stateMessage,
stateTransitionTime,
stats,
uid,
unitFilter,
updateTime;

DELETE examples

delete

Delete a single rollout.

DELETE FROM google.saasservicemgmt.rollouts
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND rolloutsId = '{{ rolloutsId }}' --required
AND etag = '{{ etag }}'
AND validateOnly = '{{ validateOnly }}'
AND requestId = '{{ requestId }}';