Reference documentation and code samples for the Compute V1 Client class Rollout.
Rollout resource.
A Rollout is a specific instance of a RolloutPlan. It represents a single execution of a strategy to roll out a specific resource. It also provides APIs to interact with the rollout.
Generated from protobuf message google.cloud.compute.v1.Rollout
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ cancellation_time
string
Output only. The timestamp at which the Rollout was cancelled.
↳ completion_time
string
Output only. The timestamp at which the Rollout was completed.
↳ creation_timestamp
string
Output only. [Output Only] Creation timestamp inRFC3339 text format.
↳ current_wave_number
int|string
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
↳ id
int|string
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind
string
Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.
↳ 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.
↳ rollout_entity
↳ rollout_plan
string
Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
↳ self_link
string
Output only. [Output Only] Server-defined fully-qualified URL for this resource.
↳ self_link_with_id
string
Output only. [Output Only] Server-defined URL for this resource's resource id.
↳ state
string
Output only. The current state of the Rollout. Check the State enum for the list of possible values.
↳ wave_details
getCancellationTime
Output only. The timestamp at which the Rollout was cancelled.
string
hasCancellationTime
clearCancellationTime
setCancellationTime
Output only. The timestamp at which the Rollout was cancelled.
var
string
$this
getCompletionTime
Output only. The timestamp at which the Rollout was completed.
string
hasCompletionTime
clearCompletionTime
setCompletionTime
Output only. The timestamp at which the Rollout was completed.
var
string
$this
getCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
var
string
$this
getCurrentWaveNumber
Output only. The number of the currently running wave.
Ex. 1
int|string
hasCurrentWaveNumber
clearCurrentWaveNumber
setCurrentWaveNumber
Output only. The number of the currently running wave.
Ex. 1
var
int|string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getEtag
Output only. etag of the Rollout Ex. abc1234
string
hasEtag
clearEtag
setEtag
Output only. etag of the Rollout Ex. abc1234
var
string
$this
getId
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getKind
Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.
string
hasKind
clearKind
setKind
Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.
var
string
$this
getName
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.
string
hasName
clearName
setName
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.
var
string
$this
getRolloutEntity
Required. The resource being rolled out.
hasRolloutEntity
clearRolloutEntity
setRolloutEntity
Required. The resource being rolled out.
$this
getRolloutPlan
Required. Rollout Plan used to model the Rollout.
Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
string
hasRolloutPlan
clearRolloutPlan
setRolloutPlan
Required. Rollout Plan used to model the Rollout.
Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
var
string
$this
getSelfLink
Output only. [Output Only] Server-defined fully-qualified URL for this resource.
string
hasSelfLink
clearSelfLink
setSelfLink
Output only. [Output Only] Server-defined fully-qualified URL for this resource.
var
string
$this
getSelfLinkWithId
Output only. [Output Only] Server-defined URL for this resource's resource id.
string
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
Output only. [Output Only] Server-defined URL for this resource's resource id.
var
string
$this
getState
Output only. The current state of the Rollout.
Check the State enum for the list of possible values.
string
hasState
clearState
setState
Output only. The current state of the Rollout.
Check the State enum for the list of possible values.
var
string
$this
getWaveDetails
Output only. Details about each wave of the rollout.
setWaveDetails
Output only. Details about each wave of the rollout.
$this
