Interface NodeOrBuilder (2.17.0)

Version 2.17.0

• 2.55.0 (latest)
• 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

getAcceleratorType()

public abstract String getAcceleratorType()

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

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

Returns
Type	Description
String	The acceleratorType.

getAcceleratorTypeBytes()

public abstract ByteString getAcceleratorTypeBytes()

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

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

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.v1.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.v1.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

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.v1.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.v1.Node.Health health = 22;

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

getIpAddress() (deprecated)

public abstract String getIpAddress()

Deprecated. google.cloud.tpu.v1.Node.ip_address is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=279

Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

string ip_address = 8 [deprecated = true];

Returns
Type	Description
String	The ipAddress.

getIpAddressBytes() (deprecated)

public abstract ByteString getIpAddressBytes()

Deprecated. google.cloud.tpu.v1.Node.ip_address is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=279

Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.

string ip_address = 8 [deprecated = true];

Returns
Type	Description
ByteString	The bytes for ipAddress.

getLabels()

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

getName()

public abstract String getName()

Output only. Immutable. The name of the TPU

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

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) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getNetwork()

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

string network = 12;

Returns
Type	Description
String	The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

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.

string network = 12;

Returns
Type	Description
ByteString	The bytes for network.

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 Tensorflow clients of the node reach out to the 0th entry in this map first.

repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out to the 0th entry in this map first.

repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out to the 0th entry in this map first.

repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out to the 0th entry in this map first.

repeated .google.cloud.tpu.v1.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 Tensorflow clients of the node reach out to the 0th entry in this map first.

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

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

getPort() (deprecated)

public abstract String getPort()

Deprecated. google.cloud.tpu.v1.Node.port is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=283

Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

string port = 14 [deprecated = true];

Returns
Type	Description
String	The port.

getPortBytes() (deprecated)

public abstract ByteString getPortBytes()

Deprecated. google.cloud.tpu.v1.Node.port is deprecated. See google/cloud/tpu/v1/cloud_tpu.proto;l=283

Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.

string port = 14 [deprecated = true];

Returns
Type	Description
ByteString	The bytes for port.

getSchedulingConfig()

public abstract SchedulingConfig getSchedulingConfig()

The scheduling options for this node.

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

Returns
Type	Description
SchedulingConfig	The schedulingConfig.

getSchedulingConfigOrBuilder()

public abstract SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()

The scheduling options for this node.

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

Returns
Type	Description
SchedulingConfigOrBuilder

getServiceAccount()

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

string service_account = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

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.

string service_account = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for serviceAccount.

getState()

public abstract Node.State getState()

Output only. The current state for the TPU Node.

.google.cloud.tpu.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getTensorflowVersion()

public abstract String getTensorflowVersion()

Required. The version of Tensorflow running in the Node.

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

Returns
Type	Description
String	The tensorflowVersion.

getTensorflowVersionBytes()

public abstract ByteString getTensorflowVersionBytes()

Required. The version of Tensorflow running in the Node.

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

Returns
Type	Description
ByteString	The bytes for tensorflowVersion.

getUseServiceNetworking()

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

bool use_service_networking = 27;

Returns
Type	Description
boolean	The useServiceNetworking.

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.

hasSchedulingConfig()

public abstract boolean hasSchedulingConfig()

The scheduling options for this node.

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

Returns
Type	Description
boolean	Whether the schedulingConfig field is set.