Compute V1 Client - Class NodeGroup (1.5.0)

Version 1.5.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

Reference documentation and code samples for the Compute V1 Client class 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.

Generated from protobuf message google.cloud.compute.v1.NodeGroup

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ autoscaling_policy	Google\Cloud\Compute\V1\NodeGroupAutoscalingPolicy Specifies how autoscaling should behave.
↳ creation_timestamp	string [Output Only] Creation timestamp in RFC3339 text format.
↳ description	string An optional description of this resource. Provide this property when you create the resource.
↳ fingerprint	string
↳ id	int|string [Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind	string [Output Only] The type of the resource. Always compute#nodeGroup for node group.
↳ location_hint	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_policy	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	Google\Cloud\Compute\V1\NodeGroupMaintenanceWindow
↳ name	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	string URL of the node template to create the node group from.
↳ self_link	string [Output Only] Server-defined URL for the resource.
↳ share_settings	Google\Cloud\Compute\V1\ShareSettings Share-settings for the node group
↳ size	int [Output Only] The total number of nodes in the node group.
↳ status	string Check the Status enum for the list of possible values.
↳ zone	string [Output Only] The name of the zone where the node group resides, such as us-central1-a.

getAutoscalingPolicy

Specifies how autoscaling should behave.

Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupAutoscalingPolicy autoscaling_policy = 221950041;

Returns
Type	Description
Google\Cloud\Compute\V1\NodeGroupAutoscalingPolicy|null

hasAutoscalingPolicy

clearAutoscalingPolicy

setAutoscalingPolicy

Specifies how autoscaling should behave.

Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupAutoscalingPolicy autoscaling_policy = 221950041;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\NodeGroupAutoscalingPolicy

Returns
Type	Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
Type	Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

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

Generated from protobuf field optional string description = 422937596;

Returns
Type	Description
string

hasDescription

clearDescription

setDescription

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

Generated from protobuf field optional string description = 422937596;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFingerprint

Generated from protobuf field optional string fingerprint = 234678500;

Returns
Type	Description
string

hasFingerprint

clearFingerprint

setFingerprint

Generated from protobuf field optional string fingerprint = 234678500;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getId

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

Generated from protobuf field optional uint64 id = 3355;

Returns
Type	Description
int|string

hasId

clearId

setId

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

Generated from protobuf field optional uint64 id = 3355;

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getKind

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

Generated from protobuf field optional string kind = 3292052;

Returns
Type	Description
string

hasKind

clearKind

setKind

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

Generated from protobuf field optional string kind = 3292052;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLocationHint

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.

Generated from protobuf field optional string location_hint = 350519505;

Returns
Type	Description
string

hasLocationHint

clearLocationHint

setLocationHint

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.

Generated from protobuf field optional string location_hint = 350519505;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMaintenancePolicy

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.

Generated from protobuf field optional string maintenance_policy = 528327646;

Returns
Type	Description
string

hasMaintenancePolicy

clearMaintenancePolicy

setMaintenancePolicy

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.

Generated from protobuf field optional string maintenance_policy = 528327646;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMaintenanceWindow

Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;

Returns
Type	Description
Google\Cloud\Compute\V1\NodeGroupMaintenanceWindow|null

hasMaintenanceWindow

clearMaintenanceWindow

setMaintenanceWindow

Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\NodeGroupMaintenanceWindow

Returns
Type	Description
$this

getName

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.

Generated from protobuf field optional string name = 3373707;

Returns
Type	Description
string

hasName

clearName

setName

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.

Generated from protobuf field optional string name = 3373707;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getNodeTemplate

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

Generated from protobuf field optional string node_template = 323154455;

Returns
Type	Description
string

hasNodeTemplate

clearNodeTemplate

setNodeTemplate

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

Generated from protobuf field optional string node_template = 323154455;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Returns
Type	Description
string

hasSelfLink

clearSelfLink

setSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getShareSettings

Share-settings for the node group

Generated from protobuf field optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;

Returns
Type	Description
Google\Cloud\Compute\V1\ShareSettings|null

hasShareSettings

clearShareSettings

setShareSettings

Share-settings for the node group

Generated from protobuf field optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\ShareSettings

Returns
Type	Description
$this

getSize

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

Generated from protobuf field optional int32 size = 3530753;

Returns
Type	Description
int

hasSize

clearSize

setSize

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

Generated from protobuf field optional int32 size = 3530753;

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStatus

Check the Status enum for the list of possible values.

Generated from protobuf field optional string status = 181260274;

Returns
Type	Description
string

hasStatus

clearStatus

setStatus

Check the Status enum for the list of possible values.

Generated from protobuf field optional string status = 181260274;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getZone

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

Generated from protobuf field optional string zone = 3744684;

Returns
Type	Description
string

hasZone

clearZone

setZone

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

Generated from protobuf field optional string zone = 3744684;

Parameter
Name	Description
var	string

Returns
Type	Description
$this