Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::NodeGroup (v2.15.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::NodeGroup.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#autoscaling_policy

def autoscaling_policy() -> ::Google::Cloud::Compute::V1::NodeGroupAutoscalingPolicy

Returns

(::Google::Cloud::Compute::V1::NodeGroupAutoscalingPolicy) — Specifies how autoscaling should behave.

#autoscaling_policy=

def autoscaling_policy=(value) -> ::Google::Cloud::Compute::V1::NodeGroupAutoscalingPolicy

Parameter

value (::Google::Cloud::Compute::V1::NodeGroupAutoscalingPolicy) — Specifies how autoscaling should behave.

Returns

(::Google::Cloud::Compute::V1::NodeGroupAutoscalingPolicy) — Specifies how autoscaling should behave.

#creation_timestamp

def creation_timestamp() -> ::String

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String

Parameter

value (::String) — [Output Only] Creation timestamp in RFC3339 text format.

Returns

(::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String

Returns

(::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String

Parameter

value (::String) — 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.

#fingerprint

def fingerprint() -> ::String

Returns

(::String)

#fingerprint=

def fingerprint=(value) -> ::String

Parameter

value (::String)

Returns

(::String)

#id

def id() -> ::Integer

Returns

(::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer

Parameter

value (::Integer) — [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.

#kind

def kind() -> ::String

Returns

(::String) — [Output Only] The type of the resource. Always compute#nodeGroup for node group.

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — [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.

#location_hint

def location_hint() -> ::String

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.

#location_hint=

def location_hint=(value) -> ::String

Parameter

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

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.

#maintenance_interval

def maintenance_interval() -> ::String

Returns

(::String) — Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED and RECURRENT. Check the MaintenanceInterval enum for the list of possible values.

#maintenance_interval=

def maintenance_interval=(value) -> ::String

Parameter

value (::String) — Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED and RECURRENT. Check the MaintenanceInterval enum for the list of possible values.

Returns

(::String) — Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED and RECURRENT. Check the MaintenanceInterval enum for the list of possible values.

#maintenance_policy

def maintenance_policy() -> ::String

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.

#maintenance_policy=

def maintenance_policy=(value) -> ::String

Parameter

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

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.

#maintenance_window

def maintenance_window() -> ::Google::Cloud::Compute::V1::NodeGroupMaintenanceWindow

Returns

(::Google::Cloud::Compute::V1::NodeGroupMaintenanceWindow)

#maintenance_window=

def maintenance_window=(value) -> ::Google::Cloud::Compute::V1::NodeGroupMaintenanceWindow

Parameter

value (::Google::Cloud::Compute::V1::NodeGroupMaintenanceWindow)

Returns

(::Google::Cloud::Compute::V1::NodeGroupMaintenanceWindow)

#name

def name() -> ::String

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.

#name=

def name=(value) -> ::String

Parameter

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

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.

#node_template

def node_template() -> ::String

Returns

(::String) — URL of the node template to create the node group from.

#node_template=

def node_template=(value) -> ::String

Parameter

value (::String) — URL of the node template to create the node group from.

Returns

(::String) — URL of the node template to create the node group from.

#self_link

def self_link() -> ::String

Returns

(::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String

Parameter

value (::String) — [Output Only] Server-defined URL for the resource.

Returns

(::String) — [Output Only] Server-defined URL for the resource.

#share_settings

def share_settings() -> ::Google::Cloud::Compute::V1::ShareSettings

Returns

(::Google::Cloud::Compute::V1::ShareSettings) — Share-settings for the node group

#share_settings=

def share_settings=(value) -> ::Google::Cloud::Compute::V1::ShareSettings

Parameter

value (::Google::Cloud::Compute::V1::ShareSettings) — Share-settings for the node group

Returns

(::Google::Cloud::Compute::V1::ShareSettings) — Share-settings for the node group

#size

def size() -> ::Integer

Returns

(::Integer) — [Output Only] The total number of nodes in the node group.

#size=

def size=(value) -> ::Integer

Parameter

value (::Integer) — [Output Only] The total number of nodes in the node group.

Returns

(::Integer) — [Output Only] The total number of nodes in the node group.

#status

def status() -> ::String

Returns

(::String) — Check the Status enum for the list of possible values.

#status=

def status=(value) -> ::String

Parameter

value (::String) — Check the Status enum for the list of possible values.

Returns

(::String) — Check the Status enum for the list of possible values.

#zone

def zone() -> ::String

Returns

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

#zone=

def zone=(value) -> ::String

Parameter

value (::String) — [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.