Class: Google::Apis::ComputeBeta::InstanceGroupManager

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



7880
7881
7882
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7880

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

Instance Attribute Details

#auto_healing_policies ⇒ Array<Google::Apis::ComputeBeta::InstanceGroupManagerAutoHealingPolicy>

The autohealing policy for this managed instance group. You can specify only one value. Corresponds to the JSON property autoHealingPolicies

Returns:



7735
7736
7737
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7735

def auto_healing_policies
  @auto_healing_policies
end

#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) 


7743
7744
7745
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7743

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) 


7749
7750
7751
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7749

def creation_timestamp
  @creation_timestamp
end

#current_actions ⇒ Google::Apis::ComputeBeta::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:



7755
7756
7757
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7755

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) 


7761
7762
7763
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7761

def description
  @description
end

#distribution_policy ⇒ Google::Apis::ComputeBeta::DistributionPolicy

Policy valid only for regional managed instance groups. Corresponds to the JSON property distributionPolicy

Returns:



7766
7767
7768
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7766

def distribution_policy
  @distribution_policy
end

#failover_action ⇒ String

The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. Corresponds to the JSON property failoverAction

Returns:

  • (String) 


7772
7773
7774
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7772

def failover_action
  @failover_action
end

#fingerprint ⇒ String

[Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


7779
7780
7781
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7779

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) 


7785
7786
7787
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7785

def id
  @id
end

#instance_group ⇒ String

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

Returns:

  • (String) 


7790
7791
7792
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7790

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) 


7797
7798
7799
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7797

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) 


7803
7804
7805
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7803

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) 


7809
7810
7811
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7809

def name
  @name
end

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

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

Returns:



7815
7816
7817
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7815

def named_ports
  @named_ports
end

#pending_actions ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerPendingActionsSummary

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

Returns:



7821
7822
7823
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7821

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


7827
7828
7829
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7827

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) 


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

def self_link
  @self_link
end

#service_account ⇒ String

[Output Only] The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account projectNumber@cloudservices.gserviceaccount.com is used. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


7841
7842
7843
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7841

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


7848
7849
7850
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7848

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) 


7855
7856
7857
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7855

def target_size
  @target_size
end

#update_policy ⇒ Google::Apis::ComputeBeta::InstanceGroupManagerUpdatePolicy

The update policy for this managed instance group. Corresponds to the JSON property updatePolicy

Returns:



7860
7861
7862
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7860

def update_policy
  @update_policy
end

#versions ⇒ Array<Google::Apis::ComputeBeta::InstanceGroupManagerVersion>

Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate. Every template can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. Corresponds to the JSON property versions

Returns:



7872
7873
7874
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7872

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


7878
7879
7880
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7878

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7885

def update!(**args)
  @auto_healing_policies = args[:auto_healing_policies] if args.key?(:auto_healing_policies)
  @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)
  @failover_action = args[:failover_action] if args.key?(:failover_action)
  @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)
  @pending_actions = args[:pending_actions] if args.key?(:pending_actions)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @service_account = args[:service_account] if args.key?(:service_account)
  @target_pools = args[:target_pools] if args.key?(:target_pools)
  @target_size = args[:target_size] if args.key?(:target_size)
  @update_policy = args[:update_policy] if args.key?(:update_policy)
  @versions = args[:versions] if args.key?(:versions)
  @zone = args[:zone] if args.key?(:zone)
end