Class: Google::Apis::ComputeV1::InstanceGroupManager

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

Overview

An Instance Group Manager resource. (== resource_for beta. instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1. regionInstanceGroupManagers ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ InstanceGroupManager

Returns a new instance of InstanceGroupManager



7892
7893
7894
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7892

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

Instance Attribute Details

#base_instance_name ⇒ String

The base instance name to use for instances in this group. The value must be 1- 58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. Corresponds to the JSON property baseInstanceName

Returns:

  • (String) 


7787
7788
7789
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7787

def base_instance_name
  @base_instance_name
end

#creation_timestamp ⇒ String

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


7793
7794
7795
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7793

def creation_timestamp
  @creation_timestamp
end

#current_actions ⇒ Google::Apis::ComputeV1::InstanceGroupManagerActionsSummary

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. Corresponds to the JSON property currentActions

Returns:



7799
7800
7801
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7799

def current_actions
  @current_actions
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) 


7805
7806
7807
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7805

def description
  @description
end

#distribution_policy ⇒ Google::Apis::ComputeV1::DistributionPolicy

Policy specifying intended distribution of instances in regional managed instance group. Corresponds to the JSON property distributionPolicy

Returns:



7811
7812
7813
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7811

def distribution_policy
  @distribution_policy
end

#fingerprint ⇒ String

Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


7822
7823
7824
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7822

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

[Output Only] A unique identifier for this resource type. The server generates this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


7828
7829
7830
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7828

def id
  @id
end

#instance_group ⇒ String

[Output Only] The URL of the Instance Group resource. Corresponds to the JSON property instanceGroup

Returns:

  • (String) 


7833
7834
7835
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7833

def instance_group
  @instance_group
end

#instance_template ⇒ String

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. Corresponds to the JSON property instanceTemplate

Returns:

  • (String) 


7840
7841
7842
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7840

def instance_template
  @instance_template
end

#kind ⇒ String

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. Corresponds to the JSON property kind

Returns:

  • (String) 


7846
7847
7848
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7846

def kind
  @kind
end

#name ⇒ String

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. Corresponds to the JSON property name

Returns:

  • (String) 


7852
7853
7854
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7852

def name
  @name
end

#named_ports ⇒ Array<Google::Apis::ComputeV1::NamedPort>

Named ports configured for the Instance Groups complementary to this Instance Group Manager. Corresponds to the JSON property namedPorts

Returns:



7858
7859
7860
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7858

def named_ports
  @named_ports
end

#region ⇒ String

[Output Only] The URL of the region where the managed instance group resides ( for regional resources). Corresponds to the JSON property region

Returns:

  • (String) 


7864
7865
7866
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7864

def region
  @region
end

#self_link ⇒ String

[Output Only] The URL for this managed instance group. The server defines this URL. Corresponds to the JSON property selfLink

Returns:

  • (String) 


7870
7871
7872
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7870

def self_link
  @self_link
end

#target_pools ⇒ Array<String>

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. Corresponds to the JSON property targetPools

Returns:

  • (Array<String>) 


7877
7878
7879
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7877

def target_pools
  @target_pools
end

#target_size ⇒ Fixnum

The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. Corresponds to the JSON property targetSize

Returns:

  • (Fixnum) 


7884
7885
7886
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7884

def target_size
  @target_size
end

#zone ⇒ String

[Output Only] The URL of the zone where the managed instance group is located ( for zonal resources). Corresponds to the JSON property zone

Returns:

  • (String) 


7890
7891
7892
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7890

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7897

def update!(**args)
  @base_instance_name = args[:base_instance_name] if args.key?(:base_instance_name)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @current_actions = args[:current_actions] if args.key?(:current_actions)
  @description = args[:description] if args.key?(:description)
  @distribution_policy = args[:distribution_policy] if args.key?(:distribution_policy)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @instance_group = args[:instance_group] if args.key?(:instance_group)
  @instance_template = args[:instance_template] if args.key?(:instance_template)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @named_ports = args[:named_ports] if args.key?(:named_ports)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @target_pools = args[:target_pools] if args.key?(:target_pools)
  @target_size = args[:target_size] if args.key?(:target_size)
  @zone = args[:zone] if args.key?(:zone)
end