Reference documentation and code samples for the Compute V1 Client class NodeTemplate.
Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances.
Generated from protobuf message google.cloud.compute.v1.NodeTemplate
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ accelerators |
array<Google\Cloud\Compute\V1\AcceleratorConfig>
|
↳ cpu_overcommit_type |
string
CPU overcommit. Check the CpuOvercommitType enum for the list of possible values. |
↳ 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. |
↳ disks |
array<Google\Cloud\Compute\V1\LocalDisk>
|
↳ 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#nodeTemplate for node templates. |
↳ 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_affinity_labels |
array|Google\Protobuf\Internal\MapField
Labels to use for node affinity, which will be used in instance scheduling. |
↳ node_type |
string
The node type to use for nodes group that are created from this template. |
↳ node_type_flexibility |
Google\Cloud\Compute\V1\NodeTemplateNodeTypeFlexibility
The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. |
↳ region |
string
[Output Only] The name of the region where the node template resides, such as us-central1. |
↳ self_link |
string
[Output Only] Server-defined URL for the resource. |
↳ server_binding |
Google\Cloud\Compute\V1\ServerBinding
Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. |
↳ status |
string
[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. Check the Status enum for the list of possible values. |
↳ status_message |
string
[Output Only] An optional, human-readable explanation of the status. |
getAccelerators
Generated from protobuf field repeated .google.cloud.compute.v1.AcceleratorConfig accelerators = 269577064;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAccelerators
Generated from protobuf field repeated .google.cloud.compute.v1.AcceleratorConfig accelerators = 269577064;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\AcceleratorConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCpuOvercommitType
CPU overcommit.
Check the CpuOvercommitType enum for the list of possible values.
Generated from protobuf field optional string cpu_overcommit_type = 247727959;
| Returns | |
|---|---|
| Type | Description |
string | |
hasCpuOvercommitType
clearCpuOvercommitType
setCpuOvercommitType
CPU overcommit.
Check the CpuOvercommitType enum for the list of possible values.
Generated from protobuf field optional string cpu_overcommit_type = 247727959;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 | |
getDisks
Generated from protobuf field repeated .google.cloud.compute.v1.LocalDisk disks = 95594102;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDisks
Generated from protobuf field repeated .google.cloud.compute.v1.LocalDisk disks = 95594102;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\LocalDisk>
|
| 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#nodeTemplate for node templates.
Generated from protobuf field optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.
Generated from protobuf field optional string kind = 3292052;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 | |
getNodeAffinityLabels
Labels to use for node affinity, which will be used in instance scheduling.
Generated from protobuf field map<string, string> node_affinity_labels = 339007161;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setNodeAffinityLabels
Labels to use for node affinity, which will be used in instance scheduling.
Generated from protobuf field map<string, string> node_affinity_labels = 339007161;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNodeType
The node type to use for nodes group that are created from this template.
Generated from protobuf field optional string node_type = 465832791;
| Returns | |
|---|---|
| Type | Description |
string | |
hasNodeType
clearNodeType
setNodeType
The node type to use for nodes group that are created from this template.
Generated from protobuf field optional string node_type = 465832791;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNodeTypeFlexibility
The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both.
Generated from protobuf field optional .google.cloud.compute.v1.NodeTemplateNodeTypeFlexibility node_type_flexibility = 315257905;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\NodeTemplateNodeTypeFlexibility|null | |
hasNodeTypeFlexibility
clearNodeTypeFlexibility
setNodeTypeFlexibility
The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both.
Generated from protobuf field optional .google.cloud.compute.v1.NodeTemplateNodeTypeFlexibility node_type_flexibility = 315257905;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\NodeTemplateNodeTypeFlexibility
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
[Output Only] The name of the region where the node template resides, such as us-central1.
Generated from protobuf field optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
string | |
hasRegion
clearRegion
setRegion
[Output Only] The name of the region where the node template resides, such as us-central1.
Generated from protobuf field optional string region = 138946292;
| 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 | |
getServerBinding
Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information.
Generated from protobuf field optional .google.cloud.compute.v1.ServerBinding server_binding = 208179593;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\ServerBinding|null | |
hasServerBinding
clearServerBinding
setServerBinding
Sets the binding properties for the physical server. Valid values include: - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information.
Generated from protobuf field optional .google.cloud.compute.v1.ServerBinding server_binding = 208179593;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\ServerBinding
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING.
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
[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING.
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 | |
getStatusMessage
[Output Only] An optional, human-readable explanation of the status.
Generated from protobuf field optional string status_message = 297428154;
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatusMessage
clearStatusMessage
setStatusMessage
[Output Only] An optional, human-readable explanation of the status.
Generated from protobuf field optional string status_message = 297428154;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |