Class NodeGroup (1.10.1)

NodeGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
`autoscaling_policy`	`google.cloud.compute_v1.types.NodeGroupAutoscalingPolicy` Specifies how autoscaling should behave. This field is a member of `oneof`_ `_autoscaling_policy`.
`creation_timestamp`	`str` [Output Only] Creation timestamp in RFC3339 text format. This field is a member of `oneof`_ `_creation_timestamp`.
`description`	`str` An optional description of this resource. Provide this property when you create the resource. This field is a member of `oneof`_ `_description`.
`fingerprint`	`str` This field is a member of `oneof`_ `_fingerprint`.
`id`	`int` [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of `oneof`_ `_id`.
`kind`	`str` [Output Only] The type of the resource. Always compute#nodeGroup for node group. This field is a member of `oneof`_ `_kind`.
`location_hint`	`str` 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. This field is a member of `oneof`_ `_location_hint`.
`maintenance_policy`	`str` 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. This field is a member of `oneof`_ `_maintenance_policy`.
`maintenance_window`	`google.cloud.compute_v1.types.NodeGroupMaintenanceWindow` This field is a member of `oneof`_ `_maintenance_window`.
`name`	`str` 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. This field is a member of `oneof`_ `_name`.
`node_template`	`str` URL of the node template to create the node group from. This field is a member of `oneof`_ `_node_template`.
`self_link`	`str` [Output Only] Server-defined URL for the resource. This field is a member of `oneof`_ `_self_link`.
`share_settings`	`google.cloud.compute_v1.types.ShareSettings` Share-settings for the node group This field is a member of `oneof`_ `_share_settings`.
`size`	`int` [Output Only] The total number of nodes in the node group. This field is a member of `oneof`_ `_size`.
`status`	`str` Check the Status enum for the list of possible values. This field is a member of `oneof`_ `_status`.
`zone`	`str` [Output Only] The name of the zone where the node group resides, such as us-central1-a. This field is a member of `oneof`_ `_zone`.

Classes

MaintenancePolicy

MaintenancePolicy(value)

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.

Values: UNDEFINED_MAINTENANCE_POLICY (0): A value indicating that the enum field is not set. DEFAULT (115302945): Allow the node and corresponding instances to retain default maintenance behavior. MAINTENANCE_POLICY_UNSPECIFIED (72964182): No description available. MIGRATE_WITHIN_NODE_GROUP (153483394): 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. RESTART_IN_PLACE (228647325): 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.

Status

Status(value)

Values: UNDEFINED_STATUS (0): A value indicating that the enum field is not set. CREATING (455564985): No description available. DELETING (528602024): No description available. INVALID (530283991): No description available. READY (77848963): No description available.