Google Cloud Tpu V2 Client - Class Node (1.2.0)

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 \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ 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 Google\Cloud\Tpu\V2\NetworkConfig

Network configurations for the TPU node.

↳ 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 Google\Cloud\Tpu\V2\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 Google\Protobuf\Timestamp

Output only. The time when the node was created.

↳ scheduling_config Google\Cloud\Tpu\V2\SchedulingConfig

The scheduling options for this node.

↳ network_endpoints array<Google\Cloud\Tpu\V2\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 array|Google\Protobuf\Internal\MapField

Resource labels to represent user-provided metadata.

↳ 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 array<Google\Cloud\Tpu\V2\AttachedDisk>

The additional data disks for the Node.

↳ api_version int

Output only. The API version that created this Node.

↳ symptoms array<Google\Cloud\Tpu\V2\Symptom>

Output only. The Symptoms that have occurred to the TPU Node.

↳ shielded_instance_config Google\Cloud\Tpu\V2\ShieldedInstanceConfig

Shielded Instance options.

↳ accelerator_config Google\Cloud\Tpu\V2\AcceleratorConfig

The AccleratorConfig for the TPU Node.

getName

Output only. Immutable. The name of the TPU.

Returns
TypeDescription
string

setName

Output only. Immutable. The name of the TPU.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

The user-supplied description of the TPU. Maximum of 512 characters.

Returns
TypeDescription
string

setDescription

The user-supplied description of the TPU. Maximum of 512 characters.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAcceleratorType

Required. The type of hardware accelerators associated with this node.

Returns
TypeDescription
string

setAcceleratorType

Required. The type of hardware accelerators associated with this node.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The current state for the TPU Node.

Returns
TypeDescription
int

setState

Output only. The current state for the TPU Node.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getHealthDescription

Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.

Returns
TypeDescription
string

setHealthDescription

Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRuntimeVersion

Required. The runtime version running in the Node.

Returns
TypeDescription
string

setRuntimeVersion

Required. The runtime version running in the Node.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNetworkConfig

Network configurations for the TPU node.

Returns
TypeDescription
Google\Cloud\Tpu\V2\NetworkConfig|null

hasNetworkConfig

clearNetworkConfig

setNetworkConfig

Network configurations for the TPU node.

Parameter
NameDescription
var Google\Cloud\Tpu\V2\NetworkConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Cloud\Tpu\V2\ServiceAccount|null

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.

Parameter
NameDescription
var Google\Cloud\Tpu\V2\ServiceAccount
Returns
TypeDescription
$this

getCreateTime

Output only. The time when the node was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the node was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getSchedulingConfig

The scheduling options for this node.

Returns
TypeDescription
Google\Cloud\Tpu\V2\SchedulingConfig|null

hasSchedulingConfig

clearSchedulingConfig

setSchedulingConfig

The scheduling options for this node.

Parameter
NameDescription
var Google\Cloud\Tpu\V2\SchedulingConfig
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

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.

Parameter
NameDescription
var array<Google\Cloud\Tpu\V2\NetworkEndpoint>
Returns
TypeDescription
$this

getHealth

The health status of the TPU node.

Returns
TypeDescription
int

setHealth

The health status of the TPU node.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLabels

Resource labels to represent user-provided metadata.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Resource labels to represent user-provided metadata.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getMetadata

Custom metadata to apply to the TPU Node.

Can set startup-script and shutdown-script

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setMetadata

Custom metadata to apply to the TPU Node.

Can set startup-script and shutdown-script

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getTags

Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTags

Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getId

Output only. The unique identifier for the TPU Node.

Returns
TypeDescription
int|string

setId

Output only. The unique identifier for the TPU Node.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getDataDisks

The additional data disks for the Node.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDataDisks

The additional data disks for the Node.

Parameter
NameDescription
var array<Google\Cloud\Tpu\V2\AttachedDisk>
Returns
TypeDescription
$this

getApiVersion

Output only. The API version that created this Node.

Returns
TypeDescription
int

setApiVersion

Output only. The API version that created this Node.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSymptoms

Output only. The Symptoms that have occurred to the TPU Node.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSymptoms

Output only. The Symptoms that have occurred to the TPU Node.

Parameter
NameDescription
var array<Google\Cloud\Tpu\V2\Symptom>
Returns
TypeDescription
$this

getShieldedInstanceConfig

Shielded Instance options.

Returns
TypeDescription
Google\Cloud\Tpu\V2\ShieldedInstanceConfig|null

hasShieldedInstanceConfig

clearShieldedInstanceConfig

setShieldedInstanceConfig

Shielded Instance options.

Parameter
NameDescription
var Google\Cloud\Tpu\V2\ShieldedInstanceConfig
Returns
TypeDescription
$this

getAcceleratorConfig

The AccleratorConfig for the TPU Node.

Returns
TypeDescription
Google\Cloud\Tpu\V2\AcceleratorConfig|null

hasAcceleratorConfig

clearAcceleratorConfig

setAcceleratorConfig

The AccleratorConfig for the TPU Node.

Parameter
NameDescription
var Google\Cloud\Tpu\V2\AcceleratorConfig
Returns
TypeDescription
$this