Reference documentation and code samples for the Google Cloud Tpu V2 Client class Node.
A TPU instance.
Generated from protobuf message google.cloud.tpu.v2.Node
Namespace
Google \ Cloud \ Tpu \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Immutable. The name of the TPU.
↳ description
string
The user-supplied description of the TPU. Maximum of 512 characters.
↳ accelerator_type
string
Optional. The type of hardware accelerators associated with this node.
↳ state
int
Output only. The current state for the TPU Node.
↳ health_description
string
Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
↳ runtime_version
string
Required. The runtime version running in the Node.
↳ network_config
NetworkConfig
Network configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
↳ network_configs
array< NetworkConfig
>
Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
↳ cidr_block
string
The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
↳ service_account
ServiceAccount
The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.
↳ create_time
↳ scheduling_config
↳ network_endpoints
array< NetworkEndpoint
>
Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
↳ health
int
The health status of the TPU node.
↳ labels
↳ metadata
array| Google\Protobuf\Internal\MapField
Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
↳ tags
array
Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
↳ id
int|string
Output only. The unique identifier for the TPU Node.
↳ data_disks
↳ api_version
int
Output only. The API version that created this Node.
↳ symptoms
↳ shielded_instance_config
↳ accelerator_config
↳ queued_resource
string
Output only. The qualified name of the QueuedResource that requested this Node.
↳ multislice_node
bool
Output only. Whether the Node belongs to a Multislice group.
getName
Output only. Immutable. The name of the TPU.
string
setName
Output only. Immutable. The name of the TPU.
var
string
$this
getDescription
The user-supplied description of the TPU. Maximum of 512 characters.
string
setDescription
The user-supplied description of the TPU. Maximum of 512 characters.
var
string
$this
getAcceleratorType
Optional. The type of hardware accelerators associated with this node.
string
setAcceleratorType
Optional. The type of hardware accelerators associated with this node.
var
string
$this
getState
Output only. The current state for the TPU Node.
int
setState
Output only. The current state for the TPU Node.
var
int
$this
getHealthDescription
Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
string
setHealthDescription
Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
var
string
$this
getRuntimeVersion
Required. The runtime version running in the Node.
string
setRuntimeVersion
Required. The runtime version running in the Node.
var
string
$this
getNetworkConfig
Network configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
Network configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
$this
getNetworkConfigs
Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
setNetworkConfigs
Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
$this
getCidrBlock
The CIDR block that the TPU node will use when selecting an IP address.
This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
string
setCidrBlock
The CIDR block that the TPU node will use when selecting an IP address.
This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
var
string
$this
getServiceAccount
The Google Cloud Platform Service Account to be used by the TPU node VMs.
If None is specified, the default compute service account will be used.
hasServiceAccount
clearServiceAccount
setServiceAccount
The Google Cloud Platform Service Account to be used by the TPU node VMs.
If None is specified, the default compute service account will be used.
$this
getCreateTime
Output only. The time when the node was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the node was created.
$this
getSchedulingConfig
The scheduling options for this node.
hasSchedulingConfig
clearSchedulingConfig
setSchedulingConfig
The scheduling options for this node.
$this
getNetworkEndpoints
Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
setNetworkEndpoints
Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
$this
getHealth
The health status of the TPU node.
int
setHealth
The health status of the TPU node.
var
int
$this
getLabels
Resource labels to represent user-provided metadata.
setLabels
Resource labels to represent user-provided metadata.
$this
getMetadata
Custom metadata to apply to the TPU Node.
Can set startup-script and shutdown-script
setMetadata
Custom metadata to apply to the TPU Node.
Can set startup-script and shutdown-script
$this
getTags
Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
setTags
Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
var
string[]
$this
getId
Output only. The unique identifier for the TPU Node.
int|string
setId
Output only. The unique identifier for the TPU Node.
var
int|string
$this
getDataDisks
The additional data disks for the Node.
setDataDisks
The additional data disks for the Node.
$this
getApiVersion
Output only. The API version that created this Node.
int
setApiVersion
Output only. The API version that created this Node.
var
int
$this
getSymptoms
Output only. The Symptoms that have occurred to the TPU Node.
setSymptoms
Output only. The Symptoms that have occurred to the TPU Node.
$this
getShieldedInstanceConfig
Shielded Instance options.
hasShieldedInstanceConfig
clearShieldedInstanceConfig
setShieldedInstanceConfig
Shielded Instance options.
$this
getAcceleratorConfig
The AccleratorConfig for the TPU Node.
hasAcceleratorConfig
clearAcceleratorConfig
setAcceleratorConfig
The AccleratorConfig for the TPU Node.
$this
getQueuedResource
Output only. The qualified name of the QueuedResource that requested this Node.
string
setQueuedResource
Output only. The qualified name of the QueuedResource that requested this Node.
var
string
$this
getMultisliceNode
Output only. Whether the Node belongs to a Multislice group.
bool
setMultisliceNode
Output only. Whether the Node belongs to a Multislice group.
var
bool
$this
