Interface NodeOrBuilder (2.55.0)

Version 2.55.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.2.6

public interface NodeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script

map<string, string> metadata = 34;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAcceleratorConfig()

public abstract AcceleratorConfig getAcceleratorConfig()

The AccleratorConfig for the TPU Node.

.google.cloud.tpu.v2.AcceleratorConfig accelerator_config = 46;

Returns
Type	Description
AcceleratorConfig	The acceleratorConfig.

getAcceleratorConfigOrBuilder()

public abstract AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()

The AccleratorConfig for the TPU Node.

.google.cloud.tpu.v2.AcceleratorConfig accelerator_config = 46;

Returns
Type	Description
AcceleratorConfigOrBuilder

getAcceleratorType()

public abstract String getAcceleratorType()

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

string accelerator_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The acceleratorType.

getAcceleratorTypeBytes()

public abstract ByteString getAcceleratorTypeBytes()

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

string accelerator_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for acceleratorType.

getApiVersion()

public abstract Node.ApiVersion getApiVersion()

Output only. The API version that created this Node.

.google.cloud.tpu.v2.Node.ApiVersion api_version = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Node.ApiVersion	The apiVersion.

getApiVersionValue()

public abstract int getApiVersionValue()

Output only. The API version that created this Node.

.google.cloud.tpu.v2.Node.ApiVersion api_version = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for apiVersion.

getCidrBlock()

public abstract String 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 cidr_block = 13;

Returns
Type	Description
String	The cidrBlock.

getCidrBlockBytes()

public abstract ByteString getCidrBlockBytes()

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 cidr_block = 13;

Returns
Type	Description
ByteString	The bytes for cidrBlock.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time when the node was created.

.google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the node was created.

.google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDataDisks(int index)

public abstract AttachedDisk getDataDisks(int index)

The additional data disks for the Node.

repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

Parameter
Name	Description
index	int

Returns
Type	Description
AttachedDisk

getDataDisksCount()

public abstract int getDataDisksCount()

The additional data disks for the Node.

repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

Returns
Type	Description
int

getDataDisksList()

public abstract List<AttachedDisk> getDataDisksList()

The additional data disks for the Node.

repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

Returns
Type	Description
List<AttachedDisk>

getDataDisksOrBuilder(int index)

public abstract AttachedDiskOrBuilder getDataDisksOrBuilder(int index)

The additional data disks for the Node.

repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

Parameter
Name	Description
index	int

Returns
Type	Description
AttachedDiskOrBuilder

getDataDisksOrBuilderList()

public abstract List<? extends AttachedDiskOrBuilder> getDataDisksOrBuilderList()

The additional data disks for the Node.

repeated .google.cloud.tpu.v2.AttachedDisk data_disks = 41;

Returns
Type	Description
List<? extends com.google.cloud.tpu.v2.AttachedDiskOrBuilder>

getDescription()

public abstract String getDescription()

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

string description = 3;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 3;

Returns
Type	Description
ByteString	The bytes for description.

getHealth()

public abstract Node.Health getHealth()

The health status of the TPU node.

.google.cloud.tpu.v2.Node.Health health = 22;

Returns
Type	Description
Node.Health	The health.

getHealthDescription()

public abstract String getHealthDescription()

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

string health_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The healthDescription.

getHealthDescriptionBytes()

public abstract ByteString getHealthDescriptionBytes()

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

string health_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for healthDescription.

getHealthValue()

public abstract int getHealthValue()

The health status of the TPU node.

.google.cloud.tpu.v2.Node.Health health = 22;

Returns
Type	Description
int	The enum numeric value on the wire for health.

getId()

public abstract long getId()

Output only. The unique identifier for the TPU Node.

int64 id = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
long	The id.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMetadata() (deprecated)

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type	Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script

map<string, string> metadata = 34;

Returns
Type	Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script

map<string, string> metadata = 34;

Returns
Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script

map<string, string> metadata = 34;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script

map<string, string> metadata = 34;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMultisliceNode()

public abstract boolean getMultisliceNode()

Output only. Whether the Node belongs to a Multislice group.

bool multislice_node = 48 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The multisliceNode.

getName()

public abstract String getName()

Output only. Immutable. The name of the TPU.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Immutable. The name of the TPU.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getNetworkConfig()

public abstract NetworkConfig getNetworkConfig()

Network configurations for the TPU node.

.google.cloud.tpu.v2.NetworkConfig network_config = 36;

Returns
Type	Description
NetworkConfig	The networkConfig.

getNetworkConfigOrBuilder()

public abstract NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Network configurations for the TPU node.

.google.cloud.tpu.v2.NetworkConfig network_config = 36;

Returns
Type	Description
NetworkConfigOrBuilder

getNetworkEndpoints(int index)

public abstract NetworkEndpoint getNetworkEndpoints(int index)

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.

repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
NetworkEndpoint

getNetworkEndpointsCount()

public abstract int getNetworkEndpointsCount()

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.

repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getNetworkEndpointsList()

public abstract List<NetworkEndpoint> getNetworkEndpointsList()

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.

repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<NetworkEndpoint>

getNetworkEndpointsOrBuilder(int index)

public abstract NetworkEndpointOrBuilder getNetworkEndpointsOrBuilder(int index)

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.

repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
NetworkEndpointOrBuilder

getNetworkEndpointsOrBuilderList()

public abstract List<? extends NetworkEndpointOrBuilder> getNetworkEndpointsOrBuilderList()

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.

repeated .google.cloud.tpu.v2.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.tpu.v2.NetworkEndpointOrBuilder>

getQueuedResource()

public abstract String getQueuedResource()

Output only. The qualified name of the QueuedResource that requested this Node.

string queued_resource = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The queuedResource.

getQueuedResourceBytes()

public abstract ByteString getQueuedResourceBytes()

Output only. The qualified name of the QueuedResource that requested this Node.

string queued_resource = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for queuedResource.

getRuntimeVersion()

public abstract String getRuntimeVersion()

Required. The runtime version running in the Node.

string runtime_version = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The runtimeVersion.

getRuntimeVersionBytes()

public abstract ByteString getRuntimeVersionBytes()

Required. The runtime version running in the Node.

string runtime_version = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for runtimeVersion.

getSchedulingConfig()

public abstract SchedulingConfig getSchedulingConfig()

The scheduling options for this node.

.google.cloud.tpu.v2.SchedulingConfig scheduling_config = 17;

Returns
Type	Description
SchedulingConfig	The schedulingConfig.

getSchedulingConfigOrBuilder()

public abstract SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()

The scheduling options for this node.

.google.cloud.tpu.v2.SchedulingConfig scheduling_config = 17;

Returns
Type	Description
SchedulingConfigOrBuilder

getServiceAccount()

public abstract ServiceAccount 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.

.google.cloud.tpu.v2.ServiceAccount service_account = 37;

Returns
Type	Description
ServiceAccount	The serviceAccount.

getServiceAccountOrBuilder()

public abstract ServiceAccountOrBuilder getServiceAccountOrBuilder()

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.

.google.cloud.tpu.v2.ServiceAccount service_account = 37;

Returns
Type	Description
ServiceAccountOrBuilder

getShieldedInstanceConfig()

public abstract ShieldedInstanceConfig getShieldedInstanceConfig()

Shielded Instance options.

.google.cloud.tpu.v2.ShieldedInstanceConfig shielded_instance_config = 45;

Returns
Type	Description
ShieldedInstanceConfig	The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Shielded Instance options.

.google.cloud.tpu.v2.ShieldedInstanceConfig shielded_instance_config = 45;

Returns
Type	Description
ShieldedInstanceConfigOrBuilder

getState()

public abstract Node.State getState()

Output only. The current state for the TPU Node.

.google.cloud.tpu.v2.Node.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Node.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state for the TPU Node.

.google.cloud.tpu.v2.Node.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getSymptoms(int index)

public abstract Symptom getSymptoms(int index)

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

repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Symptom

getSymptomsCount()

public abstract int getSymptomsCount()

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

repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getSymptomsList()

public abstract List<Symptom> getSymptomsList()

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

repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Symptom>

getSymptomsOrBuilder(int index)

public abstract SymptomOrBuilder getSymptomsOrBuilder(int index)

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

repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
SymptomOrBuilder

getSymptomsOrBuilderList()

public abstract List<? extends SymptomOrBuilder> getSymptomsOrBuilderList()

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

repeated .google.cloud.tpu.v2.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.tpu.v2.SymptomOrBuilder>

getTags(int index)

public abstract String getTags(int index)

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

repeated string tags = 40;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The tags at the given index.

getTagsBytes(int index)

public abstract ByteString getTagsBytes(int index)

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

repeated string tags = 40;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the tags at the given index.

getTagsCount()

public abstract int getTagsCount()

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

repeated string tags = 40;

Returns
Type	Description
int	The count of tags.

getTagsList()

public abstract List<String> getTagsList()

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

repeated string tags = 40;

Returns
Type	Description
List<String>	A list containing the tags.

hasAcceleratorConfig()

public abstract boolean hasAcceleratorConfig()

The AccleratorConfig for the TPU Node.

.google.cloud.tpu.v2.AcceleratorConfig accelerator_config = 46;

Returns
Type	Description
boolean	Whether the acceleratorConfig field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time when the node was created.

.google.protobuf.Timestamp create_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasNetworkConfig()

public abstract boolean hasNetworkConfig()

Network configurations for the TPU node.

.google.cloud.tpu.v2.NetworkConfig network_config = 36;

Returns
Type	Description
boolean	Whether the networkConfig field is set.

hasSchedulingConfig()

public abstract boolean hasSchedulingConfig()

The scheduling options for this node.

.google.cloud.tpu.v2.SchedulingConfig scheduling_config = 17;

Returns
Type	Description
boolean	Whether the schedulingConfig field is set.

hasServiceAccount()

public abstract boolean hasServiceAccount()

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.

.google.cloud.tpu.v2.ServiceAccount service_account = 37;

Returns
Type	Description
boolean	Whether the serviceAccount field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

Shielded Instance options.

.google.cloud.tpu.v2.ShieldedInstanceConfig shielded_instance_config = 45;

Returns
Type	Description
boolean	Whether the shieldedInstanceConfig field is set.