rollout_plans

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

Overview

Name	rollout_plans
Type	Resource
Id	google.compute.rollout_plans

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
kind	string	Output only. [Output Only] Type of the resource. Always compute#rolloutPlan for rolloutPlans. (default: compute#rolloutPlan)
locationScope	string	The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. (LOCATION_SCOPE_UNSPECIFIED, REGIONAL, ZONAL)
selfLink	string	Output only. [Output Only] Server-defined fully-qualified URL for this resource.
selfLinkWithId	string	Output only. [Output Only] Server-defined URL for this resource's resource id.
waves	array	Required. The waves included in this rollout plan.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
etag	string
items	array	A list of RolloutPlan resources.
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	Output only. [Output Only] Server-defined URL for this resource.
unreachables	array	Output only. [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, rolloutPlan		Gets details of a single project-scoped RolloutPlan.
list	select	project	filter, maxResults, pageToken, orderBy, returnPartialSuccess	Lists RolloutPlans in a given project and location.
insert	insert	project	requestId	Creates a new RolloutPlan in a given project and location.
delete	delete	project, rolloutPlan	requestId	Deletes a RolloutPlan.

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
project	string
rolloutPlan	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Gets details of a single project-scoped RolloutPlan.

SELECT
id,
name,
creationTimestamp,
description,
kind,
locationScope,
selfLink,
selfLinkWithId,
waves
FROM google.compute.rollout_plans
WHERE project = '{{ project }}' -- required
AND rolloutPlan = '{{ rolloutPlan }}' -- required
;

list

Lists RolloutPlans in a given project and location.

SELECT
id,
etag,
items,
nextPageToken,
selfLink,
unreachables,
warning
FROM google.compute.rollout_plans
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

Creates a new RolloutPlan in a given project and location.

INSERT INTO google.compute.rollout_plans (
data__locationScope,
data__description,
data__waves,
data__name,
project,
requestId
)
SELECT 
'{{ locationScope }}',
'{{ description }}',
'{{ waves }}',
'{{ name }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: rollout_plans
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the rollout_plans resource.
  - name: locationScope
    value: "{{ locationScope }}"
    description: |
      The location scope of the rollout plan. If not specified, the location
      scope is considered as ZONAL.
    valid_values: ['LOCATION_SCOPE_UNSPECIFIED', 'REGIONAL', 'ZONAL']
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: waves
    description: |
      Required. The waves included in this rollout plan.
    value:
      - displayName: "{{ displayName }}"
        selectors: "{{ selectors }}"
        validation:
          timeBasedValidationMetadata:
            waitDuration: "{{ waitDuration }}"
          type: "{{ type }}"
        orchestrationOptions:
          maxConcurrentLocations: "{{ maxConcurrentLocations }}"
          delays:
            - delimiter: "{{ delimiter }}"
              type: "{{ type }}"
              duration: "{{ duration }}"
          maxConcurrentResourcesPerLocation: "{{ maxConcurrentResourcesPerLocation }}"
        number: "{{ number }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      Specifically, the name must be 1-63 characters long and match the regular
      expression `[a-z]([-a-z0-9]*[a-z0-9])?`
      which means the first character must be a lowercase letter, and all
      following characters must be a dash, lowercase letter, or digit, except
      the last character, which cannot be a dash.
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes a RolloutPlan.

DELETE FROM google.compute.rollout_plans
WHERE project = '{{ project }}' --required
AND rolloutPlan = '{{ rolloutPlan }}' --required
AND requestId = '{{ requestId }}'
;