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.
data
array
Optional. Data for populating the Message object.
↳ autoscaling_policy
↳ 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
↳ 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
↳ 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;
hasAutoscalingPolicy
clearAutoscalingPolicy
setAutoscalingPolicy
Specifies how autoscaling should behave.
Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupAutoscalingPolicy autoscaling_policy = 221950041;
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
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;
var
string
$this
getFingerprint
Generated from protobuf field optional string fingerprint = 234678500;
string
hasFingerprint
clearFingerprint
setFingerprint
Generated from protobuf field optional string fingerprint = 234678500;
var
string
$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;
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;
var
int|string
$this
getKind
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
Generated from protobuf field optional string kind = 3292052;
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;
var
string
$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;
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;
var
string
$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;
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;
var
string
$this
getMaintenanceWindow
Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;
hasMaintenanceWindow
clearMaintenanceWindow
setMaintenanceWindow
Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;
$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;
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;
var
string
$this
getNodeTemplate
URL of the node template to create the node group from.
Generated from protobuf field optional string node_template = 323154455;
string
hasNodeTemplate
clearNodeTemplate
setNodeTemplate
URL of the node template to create the node group from.
Generated from protobuf field optional string node_template = 323154455;
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
var
string
$this
getShareSettings
Share-settings for the node group
Generated from protobuf field optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
hasShareSettings
clearShareSettings
setShareSettings
Share-settings for the node group
Generated from protobuf field optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
$this
getSize
[Output Only] The total number of nodes in the node group.
Generated from protobuf field optional int32 size = 3530753;
int
hasSize
clearSize
setSize
[Output Only] The total number of nodes in the node group.
Generated from protobuf field optional int32 size = 3530753;
var
int
$this
getStatus
Check the Status enum for the list of possible values.
Generated from protobuf field optional string status = 181260274;
string
hasStatus
clearStatus
setStatus
Check the Status enum for the list of possible values.
Generated from protobuf field optional string status = 181260274;
var
string
$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;
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;
var
string
$this
