Interface NodeOrBuilder (2.40.0)

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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getAcceleratorConfig()

public abstract AcceleratorConfig getAcceleratorConfig()

The AccleratorConfig for the TPU Node.

.google.cloud.tpu.v2alpha1.AcceleratorConfig accelerator_config = 44;

Returns
TypeDescription
AcceleratorConfig

The acceleratorConfig.

getAcceleratorConfigOrBuilder()

public abstract AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()

The AccleratorConfig for the TPU Node.

.google.cloud.tpu.v2alpha1.AcceleratorConfig accelerator_config = 44;

Returns
TypeDescription
AcceleratorConfigOrBuilder

getAcceleratorType()

public abstract String getAcceleratorType()

The type of hardware accelerators associated with this node.

string accelerator_type = 5;

Returns
TypeDescription
String

The acceleratorType.

getAcceleratorTypeBytes()

public abstract ByteString getAcceleratorTypeBytes()

The type of hardware accelerators associated with this node.

string accelerator_type = 5;

Returns
TypeDescription
ByteString

The bytes for acceleratorType.

getApiVersion()

public abstract Node.ApiVersion getApiVersion()

Output only. The API version that created this Node.

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

Returns
TypeDescription
Node.ApiVersion

The apiVersion.

getApiVersionValue()

public abstract int getApiVersionValue()

Output only. The API version that created this Node.

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

Returns
TypeDescription
int

The enum numeric value on the wire for apiVersion.

getBootDiskConfig()

public abstract BootDiskConfig getBootDiskConfig()

Optional. Boot disk configuration.

.google.cloud.tpu.v2alpha1.BootDiskConfig boot_disk_config = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
BootDiskConfig

The bootDiskConfig.

getBootDiskConfigOrBuilder()

public abstract BootDiskConfigOrBuilder getBootDiskConfigOrBuilder()

Optional. Boot disk configuration.

.google.cloud.tpu.v2alpha1.BootDiskConfig boot_disk_config = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
BootDiskConfigOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDataDisks(int index)

public abstract AttachedDisk getDataDisks(int index)

The additional data disks for the Node.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachedDisk

getDataDisksCount()

public abstract int getDataDisksCount()

The additional data disks for the Node.

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

Returns
TypeDescription
int

getDataDisksList()

public abstract List<AttachedDisk> getDataDisksList()

The additional data disks for the Node.

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

Returns
TypeDescription
List<AttachedDisk>

getDataDisksOrBuilder(int index)

public abstract AttachedDiskOrBuilder getDataDisksOrBuilder(int index)

The additional data disks for the Node.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachedDiskOrBuilder

getDataDisksOrBuilderList()

public abstract List<? extends AttachedDiskOrBuilder> getDataDisksOrBuilderList()

The additional data disks for the Node.

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

Returns
TypeDescription
List<? extends com.google.cloud.tpu.v2alpha1.AttachedDiskOrBuilder>

getDescription()

public abstract String getDescription()

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

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getHealth()

public abstract Node.Health getHealth()

The health status of the TPU node.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for healthDescription.

getHealthValue()

public abstract int getHealthValue()

The health status of the TPU node.

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

Returns
TypeDescription
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
TypeDescription
long

The id.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Returns
TypeDescription
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMetadata() (deprecated)

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getMultisliceNode()

public abstract boolean getMultisliceNode()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getNetworkConfig()

public abstract NetworkConfig getNetworkConfig()

Network configurations for the TPU node.

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

Returns
TypeDescription
NetworkConfig

The networkConfig.

getNetworkConfigOrBuilder()

public abstract NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Network configurations for the TPU node.

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

Returns
TypeDescription
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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v2alpha1.NetworkEndpoint network_endpoints = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.tpu.v2alpha1.NetworkEndpointOrBuilder>

getQueuedResource()

public abstract String getQueuedResource()

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

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

Returns
TypeDescription
String

The queuedResource.

getQueuedResourceBytes()

public abstract ByteString getQueuedResourceBytes()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for runtimeVersion.

getSchedulingConfig()

public abstract SchedulingConfig getSchedulingConfig()

The scheduling options for this node.

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

Returns
TypeDescription
SchedulingConfig

The schedulingConfig.

getSchedulingConfigOrBuilder()

public abstract SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()

The scheduling options for this node.

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

Returns
TypeDescription
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.v2alpha1.ServiceAccount service_account = 37;

Returns
TypeDescription
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.v2alpha1.ServiceAccount service_account = 37;

Returns
TypeDescription
ServiceAccountOrBuilder

getShieldedInstanceConfig()

public abstract ShieldedInstanceConfig getShieldedInstanceConfig()

Shielded Instance options.

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

Returns
TypeDescription
ShieldedInstanceConfig

The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Shielded Instance options.

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

Returns
TypeDescription
ShieldedInstanceConfigOrBuilder

getState()

public abstract Node.State getState()

Output only. The current state for the TPU Node.

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

Returns
TypeDescription
Node.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state for the TPU Node.

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

Returns
TypeDescription
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.v2alpha1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Symptom

getSymptomsCount()

public abstract int getSymptomsCount()

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

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

Returns
TypeDescription
int

getSymptomsList()

public abstract List<Symptom> getSymptomsList()

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

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

Returns
TypeDescription
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.v2alpha1.Symptom symptoms = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
SymptomOrBuilder

getSymptomsOrBuilderList()

public abstract List<? extends SymptomOrBuilder> getSymptomsOrBuilderList()

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

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

Returns
TypeDescription
List<? extends com.google.cloud.tpu.v2alpha1.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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
List<String>

A list containing the tags.

hasAcceleratorConfig()

public abstract boolean hasAcceleratorConfig()

The AccleratorConfig for the TPU Node.

.google.cloud.tpu.v2alpha1.AcceleratorConfig accelerator_config = 44;

Returns
TypeDescription
boolean

Whether the acceleratorConfig field is set.

hasBootDiskConfig()

public abstract boolean hasBootDiskConfig()

Optional. Boot disk configuration.

.google.cloud.tpu.v2alpha1.BootDiskConfig boot_disk_config = 49 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the bootDiskConfig 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
TypeDescription
boolean

Whether the createTime field is set.

hasNetworkConfig()

public abstract boolean hasNetworkConfig()

Network configurations for the TPU node.

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

Returns
TypeDescription
boolean

Whether the networkConfig field is set.

hasSchedulingConfig()

public abstract boolean hasSchedulingConfig()

The scheduling options for this node.

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

Returns
TypeDescription
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.v2alpha1.ServiceAccount service_account = 37;

Returns
TypeDescription
boolean

Whether the serviceAccount field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

Shielded Instance options.

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

Returns
TypeDescription
boolean

Whether the shieldedInstanceConfig field is set.