Class: Google::Apis::ComputeBeta::Rollout

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Rollout

Returns a new instance of Rollout.



52219
52220
52221
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52219

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cancellation_time ⇒ String

Output only. The timestamp at which the Rollout was cancelled. Corresponds to the JSON property cancellationTime

Returns:

  • (String) 


52132
52133
52134
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52132

def cancellation_time
  @cancellation_time
end

#completion_time ⇒ String

Output only. The timestamp at which the Rollout was completed. Corresponds to the JSON property completionTime

Returns:

  • (String) 


52137
52138
52139
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52137

def completion_time
  @completion_time
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


52143
52144
52145
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52143

def creation_timestamp
  @creation_timestamp
end

#current_wave_number ⇒ Fixnum

Output only. The number of the currently running wave. Ex. 1 Corresponds to the JSON property currentWaveNumber

Returns:

  • (Fixnum) 


52149
52150
52151
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52149

def current_wave_number
  @current_wave_number
end

#description ⇒ String

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

Returns:

  • (String) 


52155
52156
52157
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52155

def description
  @description
end

#etag ⇒ String

Output only. etag of the Rollout Ex. abc1234 Corresponds to the JSON property etag

Returns:

  • (String) 


52161
52162
52163
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52161

def etag
  @etag
end

#id ⇒ Fixnum

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


52168
52169
52170
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52168

def id
  @id
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Always compute#rollout for rollouts. Corresponds to the JSON property kind

Returns:

  • (String) 


52174
52175
52176
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52174

def kind
  @kind
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


52185
52186
52187
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52185

def name
  @name
end

#rollout_entity ⇒ Google::Apis::ComputeBeta::RolloutRolloutEntity

Specifications of the resource to roll out. Corresponds to the JSON property rolloutEntity

Returns:



52190
52191
52192
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52190

def rollout_entity
  @rollout_entity
end

#rollout_plan ⇒ String

Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1 Corresponds to the JSON property rolloutPlan

Returns:

  • (String) 


52196
52197
52198
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52196

def rollout_plan
  @rollout_plan
end

#self_link ⇒ String

Output only. [Output Only] Server-defined fully-qualified URL for this resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


52202
52203
52204
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52202

def self_link
  @self_link
end

#self_link_with_id ⇒ String

Output only. [Output Only] Server-defined URL for this resource's resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


52207
52208
52209
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52207

def self_link_with_id
  @self_link_with_id
end

#state ⇒ String

Output only. The current state of the Rollout. Corresponds to the JSON property state

Returns:

  • (String) 


52212
52213
52214
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52212

def state
  @state
end

#wave_details ⇒ Array<Google::Apis::ComputeBeta::RolloutWaveDetails>

Output only. Details about each wave of the rollout. Corresponds to the JSON property waveDetails

Returns:



52217
52218
52219
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52217

def wave_details
  @wave_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



52224
52225
52226
52227
52228
52229
52230
52231
52232
52233
52234
52235
52236
52237
52238
52239
52240
 
# File 'lib/google/apis/compute_beta/classes.rb', line 52224

def update!(**args)
  @cancellation_time = args[:cancellation_time] if args.key?(:cancellation_time)
  @completion_time = args[:completion_time] if args.key?(:completion_time)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @current_wave_number = args[:current_wave_number] if args.key?(:current_wave_number)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @rollout_entity = args[:rollout_entity] if args.key?(:rollout_entity)
  @rollout_plan = args[:rollout_plan] if args.key?(:rollout_plan)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @state = args[:state] if args.key?(:state)
  @wave_details = args[:wave_details] if args.key?(:wave_details)
end