Reference documentation and code samples for the Google Cloud Tpu V1 Client class Node.
A TPU instance.
Generated from protobuf message google.cloud.tpu.v1.Node
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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
Required. The type of hardware accelerators associated with this node. |
↳ ip_address |
string
Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. |
↳ port |
string
Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. |
↳ 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. |
↳ tensorflow_version |
string
Required. The version of Tensorflow running in the Node. |
↳ network |
string
The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. |
↳ 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 |
string
Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time when the node was created. |
↳ scheduling_config |
Google\Cloud\Tpu\V1\SchedulingConfig
The scheduling options for this node. |
↳ network_endpoints |
array<Google\Cloud\Tpu\V1\NetworkEndpoint>
Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first. |
↳ health |
int
The health status of the TPU node. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Resource labels to represent user-provided metadata. |
↳ use_service_networking |
bool
Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled. |
↳ api_version |
int
Output only. The API version that created this Node. |
↳ symptoms |
array<Google\Cloud\Tpu\V1\Symptom>
Output only. The Symptoms that have occurred to the TPU Node. |
getName
Output only. Immutable. The name of the TPU
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Immutable. The name of the TPU
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
The user-supplied description of the TPU. Maximum of 512 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
The user-supplied description of the TPU. Maximum of 512 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAcceleratorType
Required. The type of hardware accelerators associated with this node.
| Returns | |
|---|---|
| Type | Description |
string | |
setAcceleratorType
Required. The type of hardware accelerators associated with this node.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIpAddress
Output only. DEPRECATED! Use network_endpoints instead.
The network address for the TPU Node as visible to Compute Engine instances.
| Returns | |
|---|---|
| Type | Description |
string | |
setIpAddress
Output only. DEPRECATED! Use network_endpoints instead.
The network address for the TPU Node as visible to Compute Engine instances.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPort
Output only. DEPRECATED! Use network_endpoints instead.
The network port for the TPU Node as visible to Compute Engine instances.
| Returns | |
|---|---|
| Type | Description |
string | |
setPort
Output only. DEPRECATED! Use network_endpoints instead.
The network port for the TPU Node as visible to Compute Engine instances.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state for the TPU Node.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state for the TPU Node.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHealthDescription
Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
| Returns | |
|---|---|
| Type | Description |
string | |
setHealthDescription
Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTensorflowVersion
Required. The version of Tensorflow running in the Node.
| Returns | |
|---|---|
| Type | Description |
string | |
setTensorflowVersion
Required. The version of Tensorflow running in the Node.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetwork
The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
| Returns | |
|---|---|
| Type | Description |
string | |
setNetwork
The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceAccount
Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
| Returns | |
|---|---|
| Type | Description |
string | |
setServiceAccount
Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time when the node was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the node was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchedulingConfig
The scheduling options for this node.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Tpu\V1\SchedulingConfig|null | |
hasSchedulingConfig
clearSchedulingConfig
setSchedulingConfig
The scheduling options for this node.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Tpu\V1\SchedulingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetworkEndpoints
Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNetworkEndpoints
Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Tpu\V1\NetworkEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHealth
The health status of the TPU node.
| Returns | |
|---|---|
| Type | Description |
int | |
setHealth
The health status of the TPU node.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Resource labels to represent user-provided metadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Resource labels to represent user-provided metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUseServiceNetworking
Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node.
If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
| Returns | |
|---|---|
| Type | Description |
bool | |
setUseServiceNetworking
Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node.
If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApiVersion
Output only. The API version that created this Node.
| Returns | |
|---|---|
| Type | Description |
int | |
setApiVersion
Output only. The API version that created this Node.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSymptoms
Output only. The Symptoms that have occurred to the TPU Node.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSymptoms
Output only. The Symptoms that have occurred to the TPU Node.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Tpu\V1\Symptom>
|
| Returns | |
|---|---|
| Type | Description |
$this | |