Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#creation_timestamp
def creation_timestamp() -> ::String
Returns
- (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
#creation_timestamp=
def creation_timestamp=(value) -> ::String
Parameter
- value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
Returns
- (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
#description
def description() -> ::String
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#id
def id() -> ::Integer
Returns
- (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#id=
def id=(value) -> ::Integer
Parameter
- value (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
- (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#kind
def kind() -> ::String
Returns
- (::String) — Output only. [Output Only] Type of the resource. Always compute#rolloutPlan for rolloutPlans.
#kind=
def kind=(value) -> ::String
Parameter
- value (::String) — Output only. [Output Only] Type of the resource. Always compute#rolloutPlan for rolloutPlans.
Returns
- (::String) — Output only. [Output Only] Type of the resource. Always compute#rolloutPlan for rolloutPlans.
#location_scope
def location_scope() -> ::String
Returns
- (::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.
#location_scope=
def location_scope=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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
def name() -> ::String
Returns
-
(::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.
#name=
def name=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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
def self_link() -> ::String
Returns
- (::String) — Output only. [Output Only] Server-defined fully-qualified URL for this resource.
#self_link=
def self_link=(value) -> ::String
Parameter
- value (::String) — Output only. [Output Only] Server-defined fully-qualified URL for this resource.
Returns
- (::String) — Output only. [Output Only] Server-defined fully-qualified URL for this resource.
#self_link_with_id
def self_link_with_id() -> ::String
Returns
- (::String) — Output only. [Output Only] Server-defined URL for this resource's resource id.
#self_link_with_id=
def self_link_with_id=(value) -> ::String
Parameter
- value (::String) — Output only. [Output Only] Server-defined URL for this resource's resource id.
Returns
- (::String) — Output only. [Output Only] Server-defined URL for this resource's resource id.
#waves
def waves() -> ::Array<::Google::Cloud::Compute::V1::RolloutPlanWave>
Returns
- (::Array<::Google::Cloud::Compute::V1::RolloutPlanWave>) — Required. The waves included in this rollout plan.
#waves=
def waves=(value) -> ::Array<::Google::Cloud::Compute::V1::RolloutPlanWave>
Parameter
- value (::Array<::Google::Cloud::Compute::V1::RolloutPlanWave>) — Required. The waves included in this rollout plan.
Returns
- (::Array<::Google::Cloud::Compute::V1::RolloutPlanWave>) — Required. The waves included in this rollout plan.