Class Node (1.10.0)

Version 1.10.0

• 1.19.1 (latest)
• 1.19.0
• 1.18.5
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.2
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.2
• 1.6.0
• 1.5.2
• 1.4.1
• 1.3.4
• 1.2.1
• 1.1.0
• 1.0.2
• 0.2.2
• 0.1.0

Node(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A TPU instance.

Attributes
Name	Description
name	str Output only. Immutable. The name of the TPU.
description	str The user-supplied description of the TPU. Maximum of 512 characters.
accelerator_type	str Required. The type of hardware accelerators associated with this node.
state	google.cloud.tpu_v2.types.Node.State Output only. The current state for the TPU Node.
health_description	str Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
runtime_version	str Required. The runtime version running in the Node.
network_config	google.cloud.tpu_v2.types.NetworkConfig Network configurations for the TPU node.
cidr_block	str 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.types.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_pb2.Timestamp Output only. The time when the node was created.
scheduling_config	google.cloud.tpu_v2.types.SchedulingConfig The scheduling options for this node.
network_endpoints	MutableSequence[google.cloud.tpu_v2.types.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	google.cloud.tpu_v2.types.Node.Health The health status of the TPU node.
labels	MutableMapping[str, str] Resource labels to represent user-provided metadata.
metadata	MutableMapping[str, str] Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
tags	MutableSequence[str] Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
id	int Output only. The unique identifier for the TPU Node.
data_disks	MutableSequence[google.cloud.tpu_v2.types.AttachedDisk] The additional data disks for the Node.
api_version	google.cloud.tpu_v2.types.Node.ApiVersion Output only. The API version that created this Node.
symptoms	MutableSequence[google.cloud.tpu_v2.types.Symptom] Output only. The Symptoms that have occurred to the TPU Node.
shielded_instance_config	google.cloud.tpu_v2.types.ShieldedInstanceConfig Shielded Instance options.
accelerator_config	google.cloud.tpu_v2.types.AcceleratorConfig The AccleratorConfig for the TPU Node.

Classes

ApiVersion

ApiVersion(value)

TPU API Version.

Values: API_VERSION_UNSPECIFIED (0): API version is unknown. V1_ALPHA1 (1): TPU API V1Alpha1 version. V1 (2): TPU API V1 version. V2_ALPHA1 (3): TPU API V2Alpha1 version. V2 (4): TPU API V2 version.

Health

Health(value)

Health defines the status of a TPU node as reported by Health Monitor.

Values: HEALTH_UNSPECIFIED (0): Health status is unknown: not initialized or failed to retrieve. HEALTHY (1): The resource is healthy. TIMEOUT (3): The resource is unresponsive. UNHEALTHY_TENSORFLOW (4): The in-guest ML stack is unhealthy. UNHEALTHY_MAINTENANCE (5): The node is under maintenance/priority boost caused rescheduling and will resume running once rescheduled.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

MetadataEntry

MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

Represents the different states of a TPU node during its lifecycle.

Values: STATE_UNSPECIFIED (0): TPU node state is not known/set. CREATING (1): TPU node is being created. READY (2): TPU node has been created. RESTARTING (3): TPU node is restarting. REIMAGING (4): TPU node is undergoing reimaging. DELETING (5): TPU node is being deleted. REPAIRING (6): TPU node is being repaired and may be unusable. Details can be found in the help_description field. STOPPED (8): TPU node is stopped. STOPPING (9): TPU node is currently stopping. STARTING (10): TPU node is currently starting. PREEMPTED (11): TPU node has been preempted. Only applies to Preemptible TPU Nodes. TERMINATED (12): TPU node has been terminated due to maintenance or has reached the end of its life cycle (for preemptible nodes). HIDING (13): TPU node is currently hiding. HIDDEN (14): TPU node has been hidden. UNHIDING (15): TPU node is currently unhiding.