Class: Google::Cloud::Compute::V1::InstanceGroupManager

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.rb

Overview

Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_healing_policies ⇒ ::Array<::Google::Cloud::Compute::V1::InstanceGroupManagerAutoHealingPolicy>

Returns The autohealing policy for this managed instance group. You can specify only one value.

Returns:



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#base_instance_name ⇒ ::String

Returns 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.

Returns:

  • (::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.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#creation_timestamp ⇒ ::String

Returns [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

Returns:

  • (::String) —

    [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#current_actions ⇒ ::Google::Cloud::Compute::V1::InstanceGroupManagerActionsSummary

Returns [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.

Returns:



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns An optional description of this resource.

Returns:

  • (::String) —

    An optional description of this resource.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#distribution_policy ⇒ ::Google::Cloud::Compute::V1::DistributionPolicy

Returns Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

Returns:



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#fingerprint ⇒ ::String

Returns 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.

Returns:

  • (::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.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ ::Integer

Returns [Output Only] A unique identifier for this resource type. The server generates this identifier.

Returns:

  • (::Integer) —

    [Output Only] A unique identifier for this resource type. The server generates this identifier.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#instance_group ⇒ ::String

Returns [Output Only] The URL of the Instance Group resource.

Returns:

  • (::String) —

    [Output Only] The URL of the Instance Group resource.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#instance_template ⇒ ::String

Returns 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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Returns:

  • (::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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#kind ⇒ ::String

Returns [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

Returns:

  • (::String) —

    [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#named_ports ⇒ ::Array<::Google::Cloud::Compute::V1::NamedPort>

Returns Named ports configured for the Instance Groups complementary to this Instance Group Manager.

Returns:



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#region ⇒ ::String

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

Returns:

  • (::String) —

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



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#self_link ⇒ ::String

Returns [Output Only] The URL for this managed instance group. The server defines this URL.

Returns:

  • (::String) —

    [Output Only] The URL for this managed instance group. The server defines this URL.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#stateful_policy ⇒ ::Google::Cloud::Compute::V1::StatefulPolicy

Returns Stateful configuration for this Instanced Group Manager.

Returns:



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#status ⇒ ::Google::Cloud::Compute::V1::InstanceGroupManagerStatus

Returns [Output Only] The status of this managed instance group.

Returns:



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_pools ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::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.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_size ⇒ ::Integer

Returns The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.

Returns:

  • (::Integer) —

    The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_policy ⇒ ::Google::Cloud::Compute::V1::InstanceGroupManagerUpdatePolicy

Returns The update policy for this managed instance group.

Returns:



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#versions ⇒ ::Array<::Google::Cloud::Compute::V1::InstanceGroupManagerVersion>

Returns Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version 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.

Returns:

  • (::Array<::Google::Cloud::Compute::V1::InstanceGroupManagerVersion>) —

    Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version 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.



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#zone ⇒ ::String

Returns [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).

Returns:

  • (::String) —

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



11072
11073
11074
11075
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 11072

class InstanceGroupManager
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end