Compute V1 Client - Class Rollout (2.10.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 RolloutRolloutEntity

Required. The resource being rolled out.
↳ 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 array<RolloutWaveDetails>

Output only. Details about each wave of the rollout.

getCancellationTime

Output only. The timestamp at which the Rollout was cancelled.

Returns
Type Description
string

hasCancellationTime

clearCancellationTime

setCancellationTime

Output only. The timestamp at which the Rollout was cancelled.

Parameter
Name Description
var string
Returns
Type Description
$this

getCompletionTime

Output only. The timestamp at which the Rollout was completed.

Returns
Type Description
string

hasCompletionTime

clearCompletionTime

setCompletionTime

Output only. The timestamp at which the Rollout was completed.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getCurrentWaveNumber

Output only. The number of the currently running wave.

Ex. 1

Returns
Type Description
int|string

hasCurrentWaveNumber

clearCurrentWaveNumber

setCurrentWaveNumber

Output only. The number of the currently running wave.

Ex. 1

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Output only. etag of the Rollout Ex. abc1234

Returns
Type Description
string

hasEtag

clearEtag

setEtag

Output only. etag of the Rollout Ex. abc1234

Parameter
Name Description
var string
Returns
Type Description
$this

getId

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type Description
int|string

hasId

clearId

setId

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getKind

Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.

Returns
Type Description
string

hasKind

clearKind

setKind

Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getRolloutEntity

Required. The resource being rolled out.

Returns
Type Description
RolloutRolloutEntity|null

hasRolloutEntity

clearRolloutEntity

setRolloutEntity

Required. The resource being rolled out.

Parameter
Name Description
var RolloutRolloutEntity
Returns
Type Description
$this

getRolloutPlan

Required. Rollout Plan used to model the Rollout.

Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1

Returns
Type Description
string

hasRolloutPlan

clearRolloutPlan

setRolloutPlan

Required. Rollout Plan used to model the Rollout.

Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLinkWithId

Output only. [Output Only] Server-defined URL for this resource's resource id.

Returns
Type Description
string

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

Output only. [Output Only] Server-defined URL for this resource's resource id.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current state of the Rollout.

Check the State enum for the list of possible values.

Returns
Type Description
string

hasState

clearState

setState

Output only. The current state of the Rollout.

Check the State enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getWaveDetails

Output only. Details about each wave of the rollout.

Returns
Type Description
Google\Protobuf\RepeatedField<RolloutWaveDetails>

setWaveDetails

Output only. Details about each wave of the rollout.

Parameter
Name Description
var array<RolloutWaveDetails>
Returns
Type Description
$this