Reference documentation and code samples for the Compute V1 Client class RolloutPlan.
RolloutPlan resource.
A RolloutPlan is the customer-defined strategy to divide a large-scale change into smaller increments, referred to as "waves". Each wave targets a specific portion of the overall affected area and defines criteria that must be met before progressing to the subsequent wave.
Generated from protobuf message google.cloud.compute.v1.RolloutPlan
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ creation_timestamp
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.
↳ 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#rolloutPlan for rolloutPlans.
↳ location_scope
string
The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL. Check the LocationScope enum for the list of possible values.
↳ 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.
↳ 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.
↳ waves
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
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
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#rolloutPlan for rolloutPlans.
string
hasKind
clearKind
setKind
Output only. [Output Only] Type of the resource. Always compute#rolloutPlan for rolloutPlans.
var
string
$this
getLocationScope
The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL.
Check the LocationScope enum for the list of possible values.
string
hasLocationScope
clearLocationScope
setLocationScope
The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL.
Check the LocationScope enum for the list of possible values.
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
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
getWaves
Required. The waves included in this rollout plan.
setWaves
Required. The waves included in this rollout plan.
$this
