rollout_kinds

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

Overview

Name	rollout_kinds
Type	Resource
Id	google.saasservicemgmt.rollout_kinds

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}/rolloutKinds/{rollout_kind_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
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
errorBudget	object	Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered. (id: ErrorBudget)
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.
rolloutOrchestrationStrategy	string	Optional. The strategy used for executing a Rollout. This is a required field. 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 associated UnitKind's Saas Locations.
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.
unitKind	string	Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
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.
updateUnitKindStrategy	string	Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.

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}/rolloutKinds/{rollout_kind_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
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
errorBudget	object	Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered. (id: ErrorBudget)
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.
rolloutOrchestrationStrategy	string	Optional. The strategy used for executing a Rollout. This is a required field. 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 associated UnitKind's Saas Locations.
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.
unitKind	string	Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
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.
updateUnitKindStrategy	string	Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, rolloutKindsId		Retrieve a single rollout kind.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Retrieve a collection of rollout kinds.
create	insert	projectsId, locationsId	rolloutKindId, validateOnly, requestId	Create a new rollout kind.
patch	update	projectsId, locationsId, rolloutKindsId	validateOnly, requestId, updateMask	Update a single rollout kind.
delete	delete	projectsId, locationsId, rolloutKindsId	etag, validateOnly, requestId	Delete a single rollout kind.

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
rolloutKindsId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
rolloutKindId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Retrieve a single rollout kind.

SELECT
name,
annotations,
createTime,
errorBudget,
etag,
labels,
rolloutOrchestrationStrategy,
uid,
unitFilter,
unitKind,
updateTime,
updateUnitKindStrategy
FROM google.saasservicemgmt.rollout_kinds
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND rolloutKindsId = '{{ rolloutKindsId }}' -- required;

list

Retrieve a collection of rollout kinds.

SELECT
name,
annotations,
createTime,
errorBudget,
etag,
labels,
rolloutOrchestrationStrategy,
uid,
unitFilter,
unitKind,
updateTime,
updateUnitKindStrategy
FROM google.saasservicemgmt.rollout_kinds
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 kind.

INSERT INTO google.saasservicemgmt.rollout_kinds (
data__name,
data__unitKind,
data__rolloutOrchestrationStrategy,
data__unitFilter,
data__updateUnitKindStrategy,
data__errorBudget,
data__labels,
data__annotations,
projectsId,
locationsId,
rolloutKindId,
validateOnly,
requestId
)
SELECT 
'{{ name }}',
'{{ unitKind }}',
'{{ rolloutOrchestrationStrategy }}',
'{{ unitFilter }}',
'{{ updateUnitKindStrategy }}',
'{{ errorBudget }}',
'{{ labels }}',
'{{ annotations }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ rolloutKindId }}',
'{{ validateOnly }}',
'{{ requestId }}'
RETURNING
name,
annotations,
createTime,
errorBudget,
etag,
labels,
rolloutOrchestrationStrategy,
uid,
unitFilter,
unitKind,
updateTime,
updateUnitKindStrategy
;

Manifest

# Description fields are for documentation purposes
- name: rollout_kinds
  props:
    - name: projectsId
      value: string
      description: Required parameter for the rollout_kinds resource.
    - name: locationsId
      value: string
      description: Required parameter for the rollout_kinds resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"
        
    - name: unitKind
      value: string
      description: >
        Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
        
    - name: rolloutOrchestrationStrategy
      value: string
      description: >
        Optional. The strategy used for executing a Rollout. This is a required field. 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 associated 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.
        
    - name: updateUnitKindStrategy
      value: string
      description: >
        Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
        
      valid_values: ['UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED', 'UPDATE_UNIT_KIND_STRATEGY_ON_START', 'UPDATE_UNIT_KIND_STRATEGY_NEVER']
    - name: errorBudget
      value: object
      description: >
        Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
        
    - 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: rolloutKindId
      value: string
    - name: validateOnly
      value: boolean
    - name: requestId
      value: string

UPDATE examples

patch

Update a single rollout kind.

UPDATE google.saasservicemgmt.rollout_kinds
SET 
data__name = '{{ name }}',
data__unitKind = '{{ unitKind }}',
data__rolloutOrchestrationStrategy = '{{ rolloutOrchestrationStrategy }}',
data__unitFilter = '{{ unitFilter }}',
data__updateUnitKindStrategy = '{{ updateUnitKindStrategy }}',
data__errorBudget = '{{ errorBudget }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND rolloutKindsId = '{{ rolloutKindsId }}' --required
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
createTime,
errorBudget,
etag,
labels,
rolloutOrchestrationStrategy,
uid,
unitFilter,
unitKind,
updateTime,
updateUnitKindStrategy;

DELETE examples

delete

Delete a single rollout kind.

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