rollouts

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

Overview

Name	rollouts
Type	Resource
Id	google.compute.rollouts

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])?)
cancellationTime	string	Output only. The timestamp at which the Rollout was cancelled.
completionTime	string	Output only. The timestamp at which the Rollout was completed.
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
currentWaveNumber	string (int64)	Output only. The number of the currently running wave. Ex. 1
description	string	An optional description of this resource. Provide this property when you create the resource.
etag	string	Output only. etag of the Rollout Ex. abc1234
kind	string	Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts. (default: compute#rollout)
pauseTime	string	Output only. The timestamp at which the Rollout was paused.
resumeTime	string	Output only. The timestamp at which the Rollout was resumed.
rolloutEntity	object	Required. The resource being rolled out. (id: RolloutRolloutEntity)
rolloutPlan	string	Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
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.
state	string	Output only. The current state of the Rollout. (CANCELLED, CANCELLING, CANCEL_FAILED, COMPLETED, COMPLETE_FAILED, COMPLETING, FAILED, PAUSED, PAUSE_FAILED, PAUSING, PROCESSING, READY, RESUMING, ROLLBACK_WAVE_FAILED, ROLLING_BACK, STATE_UNSPECIFIED, UNINITIALIZED, WAVE_FAILED)
waveDetails	array	Output only. Details about each wave of the rollout.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
etag	string
items	array	A list of Rollout 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, rollout		Gets details of a single project-scoped Rollout.
list	select	project	returnPartialSuccess, orderBy, maxResults, pageToken, filter	Lists Rollouts in a given project and location.
delete	delete	project, rollout	requestId	Deletes a Rollout.
resume	exec	project, rollout	etag, requestId	Resumes a Rollout.
cancel	exec	project, rollout	rollback, requestId	Cancels a Rollout.
pause	exec	project, rollout	requestId, etag	Pauses a Rollout.
advance	exec	project, rollout	requestId, currentWaveNumber	Advances a Rollout to the next wave, or completes it if no waves remain.

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
rollout	string
currentWaveNumber	string (int64)
etag	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
rollback	boolean

SELECT examples

get

Gets details of a single project-scoped Rollout.

SELECT
id,
name,
cancellationTime,
completionTime,
creationTimestamp,
currentWaveNumber,
description,
etag,
kind,
pauseTime,
resumeTime,
rolloutEntity,
rolloutPlan,
selfLink,
selfLinkWithId,
state,
waveDetails
FROM google.compute.rollouts
WHERE project = '{{ project }}' -- required
AND rollout = '{{ rollout }}' -- required
;

list

Lists Rollouts in a given project and location.

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

DELETE examples

delete

Deletes a Rollout.

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

Lifecycle Methods

resume

Resumes a Rollout.

EXEC google.compute.rollouts.resume 
@project='{{ project }}' --required, 
@rollout='{{ rollout }}' --required, 
@etag='{{ etag }}', 
@requestId='{{ requestId }}'
;

cancel

Cancels a Rollout.

EXEC google.compute.rollouts.cancel 
@project='{{ project }}' --required, 
@rollout='{{ rollout }}' --required, 
@rollback={{ rollback }}, 
@requestId='{{ requestId }}'
;

pause

Pauses a Rollout.

EXEC google.compute.rollouts.pause 
@project='{{ project }}' --required, 
@rollout='{{ rollout }}' --required, 
@requestId='{{ requestId }}', 
@etag='{{ etag }}'
;

advance

Advances a Rollout to the next wave, or completes it if no waves remain.

EXEC google.compute.rollouts.advance 
@project='{{ project }}' --required, 
@rollout='{{ rollout }}' --required, 
@requestId='{{ requestId }}', 
@currentWaveNumber='{{ currentWaveNumber }}'
;