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 messagegoogle.cloud.compute.v1.NodeTemplate
[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[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.
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 fieldrepeated .google.cloud.compute.v1.AcceleratorConfig accelerators = 269577064;
[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#nodeTemplate for node templates.
Returns
Type
Description
string
hasKind
clearKind
setKind
[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.
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.
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
getNodeAffinityLabels
Labels to use for node affinity, which will be used in instance scheduling.
[Output Only] The name of the region where the node template resides, such as us-central1.
Returns
Type
Description
string
hasRegion
clearRegion
setRegion
[Output Only] The name of the region where the node template resides, such as us-central1.
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
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class NodeTemplate (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.NodeTemplate)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.NodeTemplate)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.NodeTemplate)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.NodeTemplate)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.NodeTemplate)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.NodeTemplate)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.NodeTemplate)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.NodeTemplate)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.NodeTemplate)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.NodeTemplate)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.NodeTemplate)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.NodeTemplate)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.NodeTemplate)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.NodeTemplate)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.NodeTemplate)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.NodeTemplate)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.NodeTemplate)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.NodeTemplate)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.NodeTemplate)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.NodeTemplate)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.NodeTemplate)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.NodeTemplate)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.NodeTemplate)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.NodeTemplate)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.NodeTemplate)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.NodeTemplate)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.NodeTemplate)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.NodeTemplate)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.NodeTemplate)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.NodeTemplate) \nReference documentation and code samples for the Compute V1 Client class NodeTemplate.\n\nRepresent 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.\n\nGenerated from protobuf message `google.cloud.compute.v1.NodeTemplate`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAccelerators\n\nGenerated from protobuf field `repeated .google.cloud.compute.v1.AcceleratorConfig accelerators = 269577064;`\n\n### setAccelerators\n\nGenerated from protobuf field `repeated .google.cloud.compute.v1.AcceleratorConfig accelerators = 269577064;`\n\n### getCpuOvercommitType\n\nCPU overcommit.\n\nCheck the CpuOvercommitType enum for the list of possible values.\n\n### hasCpuOvercommitType\n\n### clearCpuOvercommitType\n\n### setCpuOvercommitType\n\nCPU overcommit.\n\nCheck the CpuOvercommitType enum for the list of possible values.\n\n### getCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### hasCreationTimestamp\n\n### clearCreationTimestamp\n\n### setCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### getDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### getDisks\n\nGenerated from protobuf field `repeated .google.cloud.compute.v1.LocalDisk disks = 95594102;`\n\n### setDisks\n\nGenerated from protobuf field `repeated .google.cloud.compute.v1.LocalDisk disks = 95594102;`\n\n### getId\n\n\\[Output Only\\] The unique identifier for the resource. This identifier is defined by the server.\n\n### hasId\n\n### clearId\n\n### setId\n\n\\[Output Only\\] The unique identifier for the resource. This identifier is defined by the server.\n\n### getKind\n\n\\[Output Only\\] The type of the resource. Always compute#nodeTemplate for node templates.\n\n### hasKind\n\n### clearKind\n\n### setKind\n\n\\[Output Only\\] The type of the resource. Always compute#nodeTemplate for node templates.\n\n### getName\n\nThe 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.\n\n### hasName\n\n### clearName\n\n### setName\n\nThe 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.\n\n### getNodeAffinityLabels\n\nLabels to use for node affinity, which will be used in instance scheduling.\n\n### setNodeAffinityLabels\n\nLabels to use for node affinity, which will be used in instance scheduling.\n\n### getNodeType\n\nThe node type to use for nodes group that are created from this template.\n\n### hasNodeType\n\n### clearNodeType\n\n### setNodeType\n\nThe node type to use for nodes group that are created from this template.\n\n### getNodeTypeFlexibility\n\nDo not use. Instead, use the node_type property.\n\n### hasNodeTypeFlexibility\n\n### clearNodeTypeFlexibility\n\n### setNodeTypeFlexibility\n\nDo not use. Instead, use the node_type property.\n\n### getRegion\n\n\\[Output Only\\] The name of the region where the node template resides, such as us-central1.\n\n### hasRegion\n\n### clearRegion\n\n### setRegion\n\n\\[Output Only\\] The name of the region where the node template resides, such as us-central1.\n\n### getSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### hasSelfLink\n\n### clearSelfLink\n\n### setSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### getServerBinding\n\nSets 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.\n\n### hasServerBinding\n\n### clearServerBinding\n\n### setServerBinding\n\nSets 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.\n\n### getStatus\n\n\\[Output Only\\] The status of the node template. One of the following values: CREATING, READY, and DELETING.\n\nCheck the Status enum for the list of possible values.\n\n### hasStatus\n\n### clearStatus\n\n### setStatus\n\n\\[Output Only\\] The status of the node template. One of the following values: CREATING, READY, and DELETING.\n\nCheck the Status enum for the list of possible values.\n\n### getStatusMessage\n\n\\[Output Only\\] An optional, human-readable explanation of the status.\n\n### hasStatusMessage\n\n### clearStatusMessage\n\n### setStatusMessage\n\n\\[Output Only\\] An optional, human-readable explanation of the status."]]
