Class: Google::Apis::ComputeV1::Rollout

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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.



50430
50431
50432
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50430

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) 


50333
50334
50335
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50333

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) 


50338
50339
50340
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50338

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) 


50344
50345
50346
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50344

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) 


50350
50351
50352
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50350

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) 


50356
50357
50358
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50356

def description
  @description
end

#etag ⇒ String

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

Returns:

  • (String) 


50362
50363
50364
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50362

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) 


50369
50370
50371
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50369

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) 


50375
50376
50377
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50375

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) 


50386
50387
50388
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50386

def name
  @name
end

#pause_time ⇒ String

Output only. The timestamp at which the Rollout was paused. Corresponds to the JSON property pauseTime

Returns:

  • (String) 


50391
50392
50393
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50391

def pause_time
  @pause_time
end

#resume_time ⇒ String

Output only. The timestamp at which the Rollout was resumed. Corresponds to the JSON property resumeTime

Returns:

  • (String) 


50396
50397
50398
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50396

def resume_time
  @resume_time
end

#rollout_entity ⇒ Google::Apis::ComputeV1::RolloutRolloutEntity

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

Returns:



50401
50402
50403
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50401

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) 


50407
50408
50409
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50407

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) 


50413
50414
50415
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50413

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) 


50418
50419
50420
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50418

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) 


50423
50424
50425
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50423

def state
  @state
end

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

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

Returns:



50428
50429
50430
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50428

def wave_details
  @wave_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



50435
50436
50437
50438
50439
50440
50441
50442
50443
50444
50445
50446
50447
50448
50449
50450
50451
50452
50453
 
# File 'lib/google/apis/compute_v1/classes.rb', line 50435

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)
  @pause_time = args[:pause_time] if args.key?(:pause_time)
  @resume_time = args[:resume_time] if args.key?(:resume_time)
  @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