Class: Google::Cloud::Compute::V1::NodeGroup

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 sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.

Defined Under Namespace

Modules: MaintenancePolicy, Status

Instance Attribute Summary collapse

Instance Attribute Details

#autoscaling_policy ⇒ ::Google::Cloud::Compute::V1::NodeGroupAutoscalingPolicy

Returns Specifies how autoscaling should behave.

Returns:



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#creation_timestamp ⇒ ::String

Returns [Output Only] Creation timestamp in RFC3339 text format.

Returns:

  • (::String) —

    [Output Only] Creation timestamp in RFC3339 text format.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#description ⇒ ::String

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

  • (::String) —

    An optional description of this resource. Provide this property when you create the resource.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#fingerprint ⇒ ::String

Returns:

  • (::String) 


20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#id ⇒ ::Integer

Returns [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

  • (::Integer) —

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#kind ⇒ ::String

Returns [Output Only] The type of the resource. Always compute#nodeGroup for node group.

Returns:

  • (::String) —

    [Output Only] The type of the resource. Always compute#nodeGroup for node group.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#location_hint ⇒ ::String

Returns An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

Returns:

  • (::String) —

    An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#maintenance_policy ⇒ ::String

Returns Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. Check the MaintenancePolicy enum for the list of possible values.

Returns:

  • (::String) —

    Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. Check the MaintenancePolicy enum for the list of possible values.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#maintenance_window ⇒ ::Google::Cloud::Compute::V1::NodeGroupMaintenanceWindow

Returns:



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#name ⇒ ::String

Returns The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. 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.

Returns:

  • (::String) —

    The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. 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.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#node_template ⇒ ::String

Returns URL of the node template to create the node group from.

Returns:

  • (::String) —

    URL of the node template to create the node group from.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#self_link ⇒ ::String

Returns [Output Only] Server-defined URL for the resource.

Returns:

  • (::String) —

    [Output Only] Server-defined URL for the resource.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#share_settings ⇒ ::Google::Cloud::Compute::V1::ShareSettings

Returns Share-settings for the node group.

Returns:



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#size ⇒ ::Integer

Returns [Output Only] The total number of nodes in the node group.

Returns:

  • (::Integer) —

    [Output Only] The total number of nodes in the node group.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#status ⇒ ::String

Returns Check the Status enum for the list of possible values.

Returns:

  • (::String) —

    Check the Status enum for the list of possible values.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end

#zone ⇒ ::String

Returns [Output Only] The name of the zone where the node group resides, such as us-central1-a.

Returns:

  • (::String) —

    [Output Only] The name of the zone where the node group resides, such as us-central1-a.



20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20435

class NodeGroup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
  module MaintenancePolicy
    # A value indicating that the enum field is not set.
    UNDEFINED_MAINTENANCE_POLICY = 0

    # Allow the node and corresponding instances to retain default maintenance behavior.
    DEFAULT = 115_302_945

    MAINTENANCE_POLICY_UNSPECIFIED = 72_964_182

    # When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.
    MIGRATE_WITHIN_NODE_GROUP = 153_483_394

    # Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true.
    RESTART_IN_PLACE = 228_647_325
  end

  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    CREATING = 455_564_985

    DELETING = 528_602_024

    INVALID = 530_283_991

    READY = 77_848_963
  end
end