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
Namespace
Google \ Cloud \ Compute \ V1Methods
__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.
hasAutoscalingPolicy
clearAutoscalingPolicy
setAutoscalingPolicy
Specifies how autoscaling should behave.
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
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.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getKind
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
string
hasKind
clearKind
setKind
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
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.
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.
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.
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.
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.
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.
var
string
$this
getNodeTemplate
URL of the node template to create the node group from.
string
hasNodeTemplate
clearNodeTemplate
setNodeTemplate
URL of the node template to create the node group from.
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
getShareSettings
Share-settings for the node group
hasShareSettings
clearShareSettings
setShareSettings
Share-settings for the node group
$this
getSize
[Output Only] The total number of nodes in the node group.
int
hasSize
clearSize
setSize
[Output Only] The total number of nodes in the node group.
var
int
$this
getStatus
Check the Status enum for the list of possible values.
string
hasStatus
clearStatus
setStatus
Check the Status enum for the list of possible values.
var
string
$this
getZone
[Output Only] The name of the zone where the node group resides, such as us-central1-a.
string
hasZone
clearZone
setZone
[Output Only] The name of the zone where the node group resides, such as us-central1-a.
var
string
$this
