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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ autoscaling_policy |
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_interval |
string
Specifies the frequency of planned maintenance events. The accepted values are: |
↳ 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 |
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 |
↳ 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 |
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.
| Returns | |
|---|---|
| Type | Description |
NodeGroupAutoscalingPolicy|null |
|
hasAutoscalingPolicy
clearAutoscalingPolicy
setAutoscalingPolicy
Specifies how autoscaling should behave.
| Parameter | |
|---|---|
| Name | Description |
var |
NodeGroupAutoscalingPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
An optional description of this resource. Provide this property when you create the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
| 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.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKind
clearKind
setKind
[Output Only] The type of the resource. Always compute#nodeGroup for node group.
| 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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenanceInterval
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 | |
|---|---|
| Type | Description |
string |
|
hasMaintenanceInterval
clearMaintenanceInterval
setMaintenanceInterval
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.
| 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.
| 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.
| 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 |
NodeGroupMaintenanceWindow|null |
|
hasMaintenanceWindow
clearMaintenanceWindow
setMaintenanceWindow
Generated from protobuf field optional .google.cloud.compute.v1.NodeGroupMaintenanceWindow maintenance_window = 186374812;
| Parameter | |
|---|---|
| Name | Description |
var |
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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNodeTemplate
URL of the node template to create the node group from.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasNodeTemplate
clearNodeTemplate
setNodeTemplate
URL of the node template to create the node group from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
[Output Only] Server-defined URL for the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShareSettings
Share-settings for the node group
| Returns | |
|---|---|
| Type | Description |
ShareSettings|null |
|
hasShareSettings
clearShareSettings
setShareSettings
Share-settings for the node group
| Parameter | |
|---|---|
| Name | Description |
var |
ShareSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSize
[Output Only] The total number of nodes in the node group.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasSize
clearSize
setSize
[Output Only] The total number of nodes in the node group.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Check the Status enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasStatus
clearStatus
setStatus
Check the Status enum for the list of possible values.
| 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasZone
clearZone
setZone
[Output Only] The name of the zone where the node group resides, such as us-central1-a.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|