Class: Google::Apis::ReplicapoolupdaterV1beta1::RollingUpdate

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/replicapoolupdater_v1beta1/classes.rb,
generated/google/apis/replicapoolupdater_v1beta1/representations.rb,
generated/google/apis/replicapoolupdater_v1beta1/representations.rb

Overview

The following represents a resource describing a single update (rollout) of a group of instances to the given template.

Defined Under Namespace

Classes: Error, Policy

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RollingUpdate

Returns a new instance of RollingUpdate.


564
565
566
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 564

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

Instance Attribute Details

#action_typeString

Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups. Corresponds to the JSON property actionType

Returns:

  • (String)

470
471
472
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 470

def action_type
  @action_type
end

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)

475
476
477
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 475

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional textual description of the resource; provided by the client when the resource is created. Corresponds to the JSON property description

Returns:

  • (String)

481
482
483
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 481

def description
  @description
end

#errorGoogle::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Error

[Output Only] Errors that occurred during the rolling update. Corresponds to the JSON property error


486
487
488
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 486

def error
  @error
end

#idString

[Output Only] Unique identifier for the resource; defined by the server. Corresponds to the JSON property id

Returns:

  • (String)

491
492
493
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 491

def id
  @id
end

#instance_groupString

Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set. Corresponds to the JSON property instanceGroup

Returns:

  • (String)

497
498
499
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 497

def instance_group
  @instance_group
end

#instance_group_managerString

Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set. Corresponds to the JSON property instanceGroupManager

Returns:

  • (String)

503
504
505
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 503

def instance_group_manager
  @instance_group_manager
end

#instance_templateString

Fully-qualified URL of an instance template to apply. Corresponds to the JSON property instanceTemplate

Returns:

  • (String)

508
509
510
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 508

def instance_template
  @instance_template
end

#kindString

[Output Only] Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String)

513
514
515
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 513

def kind
  @kind
end

#old_instance_templateString

Fully-qualified URL of the instance template encountered while starting the update. Corresponds to the JSON property oldInstanceTemplate

Returns:

  • (String)

519
520
521
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 519

def old_instance_template
  @old_instance_template
end

#policyGoogle::Apis::ReplicapoolupdaterV1beta1::RollingUpdate::Policy

Parameters of the update process. Corresponds to the JSON property policy


524
525
526
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 524

def policy
  @policy
end

#progressFixnum

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the update will be complete. This number should be monotonically increasing as the update progresses. Corresponds to the JSON property progress

Returns:

  • (Fixnum)

532
533
534
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 532

def progress
  @progress
end

[Output Only] The fully qualified URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String)

537
538
539
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 537

def self_link
  @self_link
end

#statusString

[Output Only] Status of the update. Possible values are:

  • "ROLLING_FORWARD": The update is going forward.
  • "ROLLING_BACK": The update is being rolled back.
  • "PAUSED": The update is temporarily paused (inactive).
  • "ROLLED_OUT": The update is finished, all instances have been updated successfully.
  • "ROLLED_BACK": The update is finished, all instances have been reverted to the previous template.
  • "CANCELLED": The update is paused and no longer can be resumed, undefined how many instances are running in which template. Corresponds to the JSON property status

Returns:

  • (String)

551
552
553
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 551

def status
  @status
end

#status_messageString

[Output Only] An optional textual description of the current status of the update. Corresponds to the JSON property statusMessage

Returns:

  • (String)

557
558
559
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 557

def status_message
  @status_message
end

#userString

[Output Only] User who requested the update, for example: [email protected]. Corresponds to the JSON property user

Returns:

  • (String)

562
563
564
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 562

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'generated/google/apis/replicapoolupdater_v1beta1/classes.rb', line 569

def update!(**args)
  @action_type = args[:action_type] if args.key?(:action_type)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @error = args[:error] if args.key?(:error)
  @id = args[:id] if args.key?(:id)
  @instance_group = args[:instance_group] if args.key?(:instance_group)
  @instance_group_manager = args[:instance_group_manager] if args.key?(:instance_group_manager)
  @instance_template = args[:instance_template] if args.key?(:instance_template)
  @kind = args[:kind] if args.key?(:kind)
  @old_instance_template = args[:old_instance_template] if args.key?(:old_instance_template)
  @policy = args[:policy] if args.key?(:policy)
  @progress = args[:progress] if args.key?(:progress)
  @self_link = args[:self_link] if args.key?(:self_link)
  @status = args[:status] if args.key?(:status)
  @status_message = args[:status_message] if args.key?(:status_message)
  @user = args[:user] if args.key?(:user)
end