Class Node.Builder (2.55.0) 

public static final class Node.Builder extends GeneratedMessageV3.Builder<Node.Builder> implements NodeOrBuilder

A TPU instance.

Protobuf type google.cloud.tpu.v2alpha1.Node

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Node.Builder

Implements

NodeOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDataDisks(Iterable<? extends AttachedDisk> values)

public Node.Builder addAllDataDisks(Iterable<? extends AttachedDisk> values)

The additional data disks for the Node.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.tpu.v2alpha1.AttachedDisk>
Returns
Type Description
Node.Builder

addAllNetworkEndpoints(Iterable<? extends NetworkEndpoint> values)

public Node.Builder addAllNetworkEndpoints(Iterable<? extends NetworkEndpoint> values)

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
Name Description
values Iterable<? extends com.google.cloud.tpu.v2alpha1.NetworkEndpoint>
Returns
Type Description
Node.Builder

addAllSymptoms(Iterable<? extends Symptom> values)

public Node.Builder addAllSymptoms(Iterable<? extends Symptom> values)

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
Name Description
values Iterable<? extends com.google.cloud.tpu.v2alpha1.Symptom>
Returns
Type Description
Node.Builder

addAllTags(Iterable<String> values)

public Node.Builder addAllTags(Iterable<String> values)

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
values Iterable<String>

The tags to add.
Returns
Type Description
Node.Builder

This builder for chaining.

addDataDisks(AttachedDisk value)

public Node.Builder addDataDisks(AttachedDisk value)

The additional data disks for the Node.

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

Parameter
Name Description
value AttachedDisk
Returns
Type Description
Node.Builder

addDataDisks(AttachedDisk.Builder builderForValue)

public Node.Builder addDataDisks(AttachedDisk.Builder builderForValue)

The additional data disks for the Node.

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

Parameter
Name Description
builderForValue AttachedDisk.Builder
Returns
Type Description
Node.Builder

addDataDisks(int index, AttachedDisk value)

public Node.Builder addDataDisks(int index, AttachedDisk value)

The additional data disks for the Node.

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

Parameters
Name Description
index int
value AttachedDisk
Returns
Type Description
Node.Builder

addDataDisks(int index, AttachedDisk.Builder builderForValue)

public Node.Builder addDataDisks(int index, AttachedDisk.Builder builderForValue)

The additional data disks for the Node.

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

Parameters
Name Description
index int
builderForValue AttachedDisk.Builder
Returns
Type Description
Node.Builder

addDataDisksBuilder()

public AttachedDisk.Builder addDataDisksBuilder()

The additional data disks for the Node.

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

Returns
Type Description
AttachedDisk.Builder

addDataDisksBuilder(int index)

public AttachedDisk.Builder addDataDisksBuilder(int index)

The additional data disks for the Node.

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

Parameter
Name Description
index int
Returns
Type Description
AttachedDisk.Builder

addNetworkEndpoints(NetworkEndpoint value)

public Node.Builder addNetworkEndpoints(NetworkEndpoint value)

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
Name Description
value NetworkEndpoint
Returns
Type Description
Node.Builder

addNetworkEndpoints(NetworkEndpoint.Builder builderForValue)

public Node.Builder addNetworkEndpoints(NetworkEndpoint.Builder builderForValue)

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
Name Description
builderForValue NetworkEndpoint.Builder
Returns
Type Description
Node.Builder

addNetworkEndpoints(int index, NetworkEndpoint value)

public Node.Builder addNetworkEndpoints(int index, NetworkEndpoint value)

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];

Parameters
Name Description
index int
value NetworkEndpoint
Returns
Type Description
Node.Builder

addNetworkEndpoints(int index, NetworkEndpoint.Builder builderForValue)

public Node.Builder addNetworkEndpoints(int index, NetworkEndpoint.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue NetworkEndpoint.Builder
Returns
Type Description
Node.Builder

addNetworkEndpointsBuilder()

public NetworkEndpoint.Builder addNetworkEndpointsBuilder()

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
Type Description
NetworkEndpoint.Builder

addNetworkEndpointsBuilder(int index)

public NetworkEndpoint.Builder addNetworkEndpointsBuilder(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
Name Description
index int
Returns
Type Description
NetworkEndpoint.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Node.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Node.Builder
Overrides

addSymptoms(Symptom value)

public Node.Builder addSymptoms(Symptom value)

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
Name Description
value Symptom
Returns
Type Description
Node.Builder

addSymptoms(Symptom.Builder builderForValue)

public Node.Builder addSymptoms(Symptom.Builder builderForValue)

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
Name Description
builderForValue Symptom.Builder
Returns
Type Description
Node.Builder

addSymptoms(int index, Symptom value)

public Node.Builder addSymptoms(int index, Symptom value)

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];

Parameters
Name Description
index int
value Symptom
Returns
Type Description
Node.Builder

addSymptoms(int index, Symptom.Builder builderForValue)

public Node.Builder addSymptoms(int index, Symptom.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Symptom.Builder
Returns
Type Description
Node.Builder

addSymptomsBuilder()

public Symptom.Builder addSymptomsBuilder()

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
Type Description
Symptom.Builder

addSymptomsBuilder(int index)

public Symptom.Builder addSymptomsBuilder(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
Name Description
index int
Returns
Type Description
Symptom.Builder

addTags(String value)

public Node.Builder addTags(String value)

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
value String

The tags to add.
Returns
Type Description
Node.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public Node.Builder addTagsBytes(ByteString value)

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
value ByteString

The bytes of the tags to add.
Returns
Type Description
Node.Builder

This builder for chaining.

build()

public Node build()
Returns
Type Description
Node

buildPartial()

public Node buildPartial()
Returns
Type Description
Node

clear()

public Node.Builder clear()
Returns
Type Description
Node.Builder
Overrides

clearAcceleratorConfig()

public Node.Builder clearAcceleratorConfig()

The AccleratorConfig for the TPU Node.

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

Returns
Type Description
Node.Builder

clearAcceleratorType()

public Node.Builder clearAcceleratorType()

The type of hardware accelerators associated with this node.

string accelerator_type = 5;

Returns
Type Description
Node.Builder

This builder for chaining.

clearApiVersion()

public Node.Builder clearApiVersion()

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
Type Description
Node.Builder

This builder for chaining.

clearBootDiskConfig()

public Node.Builder clearBootDiskConfig()

Optional. Boot disk configuration.

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

Returns
Type Description
Node.Builder

clearCidrBlock()

public Node.Builder clearCidrBlock()

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
Node.Builder

This builder for chaining.

clearCreateTime()

public Node.Builder clearCreateTime()

Output only. The time when the node was created.

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

Returns
Type Description
Node.Builder

clearDataDisks()

public Node.Builder clearDataDisks()

The additional data disks for the Node.

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

Returns
Type Description
Node.Builder

clearDescription()

public Node.Builder clearDescription()

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

string description = 3;

Returns
Type Description
Node.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Node.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Node.Builder
Overrides

clearHealth()

public Node.Builder clearHealth()

The health status of the TPU node.

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

Returns
Type Description
Node.Builder

This builder for chaining.

clearHealthDescription()

public Node.Builder clearHealthDescription()

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
Node.Builder

This builder for chaining.

clearId()

public Node.Builder clearId()

Output only. The unique identifier for the TPU Node.

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

Returns
Type Description
Node.Builder

This builder for chaining.

clearLabels()

public Node.Builder clearLabels()
Returns
Type Description
Node.Builder

clearMetadata()

public Node.Builder clearMetadata()
Returns
Type Description
Node.Builder

clearMultisliceNode()

public Node.Builder clearMultisliceNode()

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

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

Returns
Type Description
Node.Builder

This builder for chaining.

clearName()

public Node.Builder clearName()

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
Node.Builder

This builder for chaining.

clearNetworkConfig()

public Node.Builder clearNetworkConfig()

Network configurations for the TPU node.

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

Returns
Type Description
Node.Builder

clearNetworkEndpoints()

public Node.Builder clearNetworkEndpoints()

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
Type Description
Node.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Node.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Node.Builder
Overrides

clearQueuedResource()

public Node.Builder clearQueuedResource()

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

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

Returns
Type Description
Node.Builder

This builder for chaining.

clearRuntimeVersion()

public Node.Builder clearRuntimeVersion()

Required. The runtime version running in the Node.

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

Returns
Type Description
Node.Builder

This builder for chaining.

clearSchedulingConfig()

public Node.Builder clearSchedulingConfig()

The scheduling options for this node.

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

Returns
Type Description
Node.Builder

clearServiceAccount()

public Node.Builder clearServiceAccount()

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
Type Description
Node.Builder

clearShieldedInstanceConfig()

public Node.Builder clearShieldedInstanceConfig()

Shielded Instance options.

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

Returns
Type Description
Node.Builder

clearState()

public Node.Builder clearState()

Output only. The current state for the TPU Node.

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

Returns
Type Description
Node.Builder

This builder for chaining.

clearSymptoms()

public Node.Builder clearSymptoms()

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
Type Description
Node.Builder

clearTags()

public Node.Builder clearTags()

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
Node.Builder

This builder for chaining.

clone()

public Node.Builder clone()
Returns
Type Description
Node.Builder
Overrides

containsLabels(String key)

public 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 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 AcceleratorConfig getAcceleratorConfig()

The AccleratorConfig for the TPU Node.

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

Returns
Type Description
AcceleratorConfig

The acceleratorConfig.

getAcceleratorConfigBuilder()

public AcceleratorConfig.Builder getAcceleratorConfigBuilder()

The AccleratorConfig for the TPU Node.

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

Returns
Type Description
AcceleratorConfig.Builder

getAcceleratorConfigOrBuilder()

public AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()

The AccleratorConfig for the TPU Node.

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

Returns
Type Description
AcceleratorConfigOrBuilder

getAcceleratorType()

public String getAcceleratorType()

The type of hardware accelerators associated with this node.

string accelerator_type = 5;

Returns
Type Description
String

The acceleratorType.

getAcceleratorTypeBytes()

public ByteString getAcceleratorTypeBytes()

The type of hardware accelerators associated with this node.

string accelerator_type = 5;

Returns
Type Description
ByteString

The bytes for acceleratorType.

getApiVersion()

public 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
Type Description
Node.ApiVersion

The apiVersion.

getApiVersionValue()

public 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
Type Description
int

The enum numeric value on the wire for apiVersion.

getBootDiskConfig()

public BootDiskConfig getBootDiskConfig()

Optional. Boot disk configuration.

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

Returns
Type Description
BootDiskConfig

The bootDiskConfig.

getBootDiskConfigBuilder()

public BootDiskConfig.Builder getBootDiskConfigBuilder()

Optional. Boot disk configuration.

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

Returns
Type Description
BootDiskConfig.Builder

getBootDiskConfigOrBuilder()

public BootDiskConfigOrBuilder getBootDiskConfigOrBuilder()

Optional. Boot disk configuration.

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

Returns
Type Description
BootDiskConfigOrBuilder

getCidrBlock()

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the node was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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 AttachedDisk getDataDisks(int index)

The additional data disks for the Node.

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

Parameter
Name Description
index int
Returns
Type Description
AttachedDisk

getDataDisksBuilder(int index)

public AttachedDisk.Builder getDataDisksBuilder(int index)

The additional data disks for the Node.

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

Parameter
Name Description
index int
Returns
Type Description
AttachedDisk.Builder

getDataDisksBuilderList()

public List<AttachedDisk.Builder> getDataDisksBuilderList()

The additional data disks for the Node.

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

Returns
Type Description
List<Builder>

getDataDisksCount()

public int getDataDisksCount()

The additional data disks for the Node.

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

Returns
Type Description
int

getDataDisksList()

public List<AttachedDisk> getDataDisksList()

The additional data disks for the Node.

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

Returns
Type Description
List<AttachedDisk>

getDataDisksOrBuilder(int index)

public AttachedDiskOrBuilder getDataDisksOrBuilder(int index)

The additional data disks for the Node.

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

Parameter
Name Description
index int
Returns
Type Description
AttachedDiskOrBuilder

getDataDisksOrBuilderList()

public List<? extends AttachedDiskOrBuilder> getDataDisksOrBuilderList()

The additional data disks for the Node.

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

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

getDefaultInstanceForType()

public Node getDefaultInstanceForType()
Returns
Type Description
Node

getDescription()

public String getDescription()

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

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHealth()

public Node.Health getHealth()

The health status of the TPU node.

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

Returns
Type Description
Node.Health

The health.

getHealthDescription()

public 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 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 int getHealthValue()

The health status of the TPU node.

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

Returns
Type Description
int

The enum numeric value on the wire for health.

getId()

public 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Returns
Type Description
int

getLabelsMap()

public 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 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 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 Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public 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 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 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 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 boolean getMultisliceNode()

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

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

Returns
Type Description
boolean

The multisliceNode.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableMetadata() (deprecated)

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public 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 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 NetworkConfig getNetworkConfig()

Network configurations for the TPU node.

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

Returns
Type Description
NetworkConfig

The networkConfig.

getNetworkConfigBuilder()

public NetworkConfig.Builder getNetworkConfigBuilder()

Network configurations for the TPU node.

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

Returns
Type Description
NetworkConfig.Builder

getNetworkConfigOrBuilder()

public NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Network configurations for the TPU node.

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

Returns
Type Description
NetworkConfigOrBuilder

getNetworkEndpoints(int index)

public 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
Name Description
index int
Returns
Type Description
NetworkEndpoint

getNetworkEndpointsBuilder(int index)

public NetworkEndpoint.Builder getNetworkEndpointsBuilder(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
Name Description
index int
Returns
Type Description
NetworkEndpoint.Builder

getNetworkEndpointsBuilderList()

public List<NetworkEndpoint.Builder> getNetworkEndpointsBuilderList()

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
Type Description
List<Builder>

getNetworkEndpointsCount()

public 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
Type Description
int

getNetworkEndpointsList()

public 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
Type Description
List<NetworkEndpoint>

getNetworkEndpointsOrBuilder(int index)

public 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
Name Description
index int
Returns
Type Description
NetworkEndpointOrBuilder

getNetworkEndpointsOrBuilderList()

public 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
Type Description
List<? extends com.google.cloud.tpu.v2alpha1.NetworkEndpointOrBuilder>

getQueuedResource()

public 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
Type Description
String

The queuedResource.

getQueuedResourceBytes()

public 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
Type Description
ByteString

The bytes for queuedResource.

getRuntimeVersion()

public 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 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 SchedulingConfig getSchedulingConfig()

The scheduling options for this node.

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

Returns
Type Description
SchedulingConfig

The schedulingConfig.

getSchedulingConfigBuilder()

public SchedulingConfig.Builder getSchedulingConfigBuilder()

The scheduling options for this node.

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

Returns
Type Description
SchedulingConfig.Builder

getSchedulingConfigOrBuilder()

public SchedulingConfigOrBuilder getSchedulingConfigOrBuilder()

The scheduling options for this node.

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

Returns
Type Description
SchedulingConfigOrBuilder

getServiceAccount()

public 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
Type Description
ServiceAccount

The serviceAccount.

getServiceAccountBuilder()

public ServiceAccount.Builder getServiceAccountBuilder()

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
Type Description
ServiceAccount.Builder

getServiceAccountOrBuilder()

public 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
Type Description
ServiceAccountOrBuilder

getShieldedInstanceConfig()

public ShieldedInstanceConfig getShieldedInstanceConfig()

Shielded Instance options.

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

Returns
Type Description
ShieldedInstanceConfig

The shieldedInstanceConfig.

getShieldedInstanceConfigBuilder()

public ShieldedInstanceConfig.Builder getShieldedInstanceConfigBuilder()

Shielded Instance options.

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

Returns
Type Description
ShieldedInstanceConfig.Builder

getShieldedInstanceConfigOrBuilder()

public ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Shielded Instance options.

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

Returns
Type Description
ShieldedInstanceConfigOrBuilder

getState()

public 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
Type Description
Node.State

The state.

getStateValue()

public 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
Type Description
int

The enum numeric value on the wire for state.

getSymptoms(int index)

public 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
Name Description
index int
Returns
Type Description
Symptom

getSymptomsBuilder(int index)

public Symptom.Builder getSymptomsBuilder(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
Name Description
index int
Returns
Type Description
Symptom.Builder

getSymptomsBuilderList()

public List<Symptom.Builder> getSymptomsBuilderList()

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
Type Description
List<Builder>

getSymptomsCount()

public 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
Type Description
int

getSymptomsList()

public 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
Type Description
List<Symptom>

getSymptomsOrBuilder(int index)

public 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
Name Description
index int
Returns
Type Description
SymptomOrBuilder

getSymptomsOrBuilderList()

public 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
Type Description
List<? extends com.google.cloud.tpu.v2alpha1.SymptomOrBuilder>

getTags(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the tags.

hasAcceleratorConfig()

public boolean hasAcceleratorConfig()

The AccleratorConfig for the TPU Node.

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

Returns
Type Description
boolean

Whether the acceleratorConfig field is set.

hasBootDiskConfig()

public boolean hasBootDiskConfig()

Optional. Boot disk configuration.

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

Returns
Type Description
boolean

Whether the bootDiskConfig field is set.

hasCreateTime()

public 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 boolean hasNetworkConfig()

Network configurations for the TPU node.

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

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasSchedulingConfig()

public boolean hasSchedulingConfig()

The scheduling options for this node.

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

Returns
Type Description
boolean

Whether the schedulingConfig field is set.

hasServiceAccount()

public 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
Type Description
boolean

Whether the serviceAccount field is set.

hasShieldedInstanceConfig()

public boolean hasShieldedInstanceConfig()

Shielded Instance options.

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

Returns
Type Description
boolean

Whether the shieldedInstanceConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAcceleratorConfig(AcceleratorConfig value)

public Node.Builder mergeAcceleratorConfig(AcceleratorConfig value)

The AccleratorConfig for the TPU Node.

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

Parameter
Name Description
value AcceleratorConfig
Returns
Type Description
Node.Builder

mergeBootDiskConfig(BootDiskConfig value)

public Node.Builder mergeBootDiskConfig(BootDiskConfig value)

Optional. Boot disk configuration.

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

Parameter
Name Description
value BootDiskConfig
Returns
Type Description
Node.Builder

mergeCreateTime(Timestamp value)

public Node.Builder mergeCreateTime(Timestamp value)

Output only. The time when the node was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Node.Builder

mergeFrom(Node other)

public Node.Builder mergeFrom(Node other)
Parameter
Name Description
other Node
Returns
Type Description
Node.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Node.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Node.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Node.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Node.Builder
Overrides

mergeNetworkConfig(NetworkConfig value)

public Node.Builder mergeNetworkConfig(NetworkConfig value)

Network configurations for the TPU node.

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

Parameter
Name Description
value NetworkConfig
Returns
Type Description
Node.Builder

mergeSchedulingConfig(SchedulingConfig value)

public Node.Builder mergeSchedulingConfig(SchedulingConfig value)

The scheduling options for this node.

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

Parameter
Name Description
value SchedulingConfig
Returns
Type Description
Node.Builder

mergeServiceAccount(ServiceAccount value)

public Node.Builder mergeServiceAccount(ServiceAccount value)

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;

Parameter
Name Description
value ServiceAccount
Returns
Type Description
Node.Builder

mergeShieldedInstanceConfig(ShieldedInstanceConfig value)

public Node.Builder mergeShieldedInstanceConfig(ShieldedInstanceConfig value)

Shielded Instance options.

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

Parameter
Name Description
value ShieldedInstanceConfig
Returns
Type Description
Node.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Node.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Node.Builder
Overrides

putAllLabels(Map<String,String> values)

public Node.Builder putAllLabels(Map<String,String> values)

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Node.Builder

putAllMetadata(Map<String,String> values)

public Node.Builder putAllMetadata(Map<String,String> values)

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

map<string, string> metadata = 34;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Node.Builder

putLabels(String key, String value)

public Node.Builder putLabels(String key, String value)

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Parameters
Name Description
key String
value String
Returns
Type Description
Node.Builder

putMetadata(String key, String value)

public Node.Builder putMetadata(String key, String value)

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
value String
Returns
Type Description
Node.Builder

removeDataDisks(int index)

public Node.Builder removeDataDisks(int index)

The additional data disks for the Node.

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

Parameter
Name Description
index int
Returns
Type Description
Node.Builder

removeLabels(String key)

public Node.Builder removeLabels(String key)

Resource labels to represent user-provided metadata.

map<string, string> labels = 24;

Parameter
Name Description
key String
Returns
Type Description
Node.Builder

removeMetadata(String key)

public Node.Builder removeMetadata(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
Node.Builder

removeNetworkEndpoints(int index)

public Node.Builder removeNetworkEndpoints(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
Name Description
index int
Returns
Type Description
Node.Builder

removeSymptoms(int index)

public Node.Builder removeSymptoms(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
Name Description
index int
Returns
Type Description
Node.Builder

setAcceleratorConfig(AcceleratorConfig value)

public Node.Builder setAcceleratorConfig(AcceleratorConfig value)

The AccleratorConfig for the TPU Node.

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

Parameter
Name Description
value AcceleratorConfig
Returns
Type Description
Node.Builder

setAcceleratorConfig(AcceleratorConfig.Builder builderForValue)

public Node.Builder setAcceleratorConfig(AcceleratorConfig.Builder builderForValue)

The AccleratorConfig for the TPU Node.

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

Parameter
Name Description
builderForValue AcceleratorConfig.Builder
Returns
Type Description
Node.Builder

setAcceleratorType(String value)

public Node.Builder setAcceleratorType(String value)

The type of hardware accelerators associated with this node.

string accelerator_type = 5;

Parameter
Name Description
value String

The acceleratorType to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setAcceleratorTypeBytes(ByteString value)

public Node.Builder setAcceleratorTypeBytes(ByteString value)

The type of hardware accelerators associated with this node.

string accelerator_type = 5;

Parameter
Name Description
value ByteString

The bytes for acceleratorType to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setApiVersion(Node.ApiVersion value)

public Node.Builder setApiVersion(Node.ApiVersion value)

Output only. The API version that created this Node.

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

Parameter
Name Description
value Node.ApiVersion

The apiVersion to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setApiVersionValue(int value)

public Node.Builder setApiVersionValue(int value)

Output only. The API version that created this Node.

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

Parameter
Name Description
value int

The enum numeric value on the wire for apiVersion to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setBootDiskConfig(BootDiskConfig value)

public Node.Builder setBootDiskConfig(BootDiskConfig value)

Optional. Boot disk configuration.

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

Parameter
Name Description
value BootDiskConfig
Returns
Type Description
Node.Builder

setBootDiskConfig(BootDiskConfig.Builder builderForValue)

public Node.Builder setBootDiskConfig(BootDiskConfig.Builder builderForValue)

Optional. Boot disk configuration.

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

Parameter
Name Description
builderForValue BootDiskConfig.Builder
Returns
Type Description
Node.Builder

setCidrBlock(String value)

public Node.Builder setCidrBlock(String value)

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;

Parameter
Name Description
value String

The cidrBlock to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setCidrBlockBytes(ByteString value)

public Node.Builder setCidrBlockBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for cidrBlock to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Node.Builder setCreateTime(Timestamp value)

Output only. The time when the node was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Node.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Node.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the node was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Node.Builder

setDataDisks(int index, AttachedDisk value)

public Node.Builder setDataDisks(int index, AttachedDisk value)

The additional data disks for the Node.

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

Parameters
Name Description
index int
value AttachedDisk
Returns
Type Description
Node.Builder

setDataDisks(int index, AttachedDisk.Builder builderForValue)

public Node.Builder setDataDisks(int index, AttachedDisk.Builder builderForValue)

The additional data disks for the Node.

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

Parameters
Name Description
index int
builderForValue AttachedDisk.Builder
Returns
Type Description
Node.Builder

setDescription(String value)

public Node.Builder setDescription(String value)

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

string description = 3;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Node.Builder setDescriptionBytes(ByteString value)

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

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Node.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Node.Builder
Overrides

setHealth(Node.Health value)

public Node.Builder setHealth(Node.Health value)

The health status of the TPU node.

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

Parameter
Name Description
value Node.Health

The health to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setHealthDescription(String value)

public Node.Builder setHealthDescription(String value)

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];

Parameter
Name Description
value String

The healthDescription to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setHealthDescriptionBytes(ByteString value)

public Node.Builder setHealthDescriptionBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for healthDescription to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setHealthValue(int value)

public Node.Builder setHealthValue(int value)

The health status of the TPU node.

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

Parameter
Name Description
value int

The enum numeric value on the wire for health to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setId(long value)

public Node.Builder setId(long value)

Output only. The unique identifier for the TPU Node.

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

Parameter
Name Description
value long

The id to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setMultisliceNode(boolean value)

public Node.Builder setMultisliceNode(boolean value)

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

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

Parameter
Name Description
value boolean

The multisliceNode to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setName(String value)

public Node.Builder setName(String value)

Output only. Immutable. The name of the TPU.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Node.Builder setNameBytes(ByteString value)

Output only. Immutable. The name of the TPU.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setNetworkConfig(NetworkConfig value)

public Node.Builder setNetworkConfig(NetworkConfig value)

Network configurations for the TPU node.

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

Parameter
Name Description
value NetworkConfig
Returns
Type Description
Node.Builder

setNetworkConfig(NetworkConfig.Builder builderForValue)

public Node.Builder setNetworkConfig(NetworkConfig.Builder builderForValue)

Network configurations for the TPU node.

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

Parameter
Name Description
builderForValue NetworkConfig.Builder
Returns
Type Description
Node.Builder

setNetworkEndpoints(int index, NetworkEndpoint value)

public Node.Builder setNetworkEndpoints(int index, NetworkEndpoint value)

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];

Parameters
Name Description
index int
value NetworkEndpoint
Returns
Type Description
Node.Builder

setNetworkEndpoints(int index, NetworkEndpoint.Builder builderForValue)

public Node.Builder setNetworkEndpoints(int index, NetworkEndpoint.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue NetworkEndpoint.Builder
Returns
Type Description
Node.Builder

setQueuedResource(String value)

public Node.Builder setQueuedResource(String value)

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

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

Parameter
Name Description
value String

The queuedResource to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setQueuedResourceBytes(ByteString value)

public Node.Builder setQueuedResourceBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for queuedResource to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Node.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Node.Builder
Overrides

setRuntimeVersion(String value)

public Node.Builder setRuntimeVersion(String value)

Required. The runtime version running in the Node.

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

Parameter
Name Description
value String

The runtimeVersion to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setRuntimeVersionBytes(ByteString value)

public Node.Builder setRuntimeVersionBytes(ByteString value)

Required. The runtime version running in the Node.

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

Parameter
Name Description
value ByteString

The bytes for runtimeVersion to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setSchedulingConfig(SchedulingConfig value)

public Node.Builder setSchedulingConfig(SchedulingConfig value)

The scheduling options for this node.

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

Parameter
Name Description
value SchedulingConfig
Returns
Type Description
Node.Builder

setSchedulingConfig(SchedulingConfig.Builder builderForValue)

public Node.Builder setSchedulingConfig(SchedulingConfig.Builder builderForValue)

The scheduling options for this node.

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

Parameter
Name Description
builderForValue SchedulingConfig.Builder
Returns
Type Description
Node.Builder

setServiceAccount(ServiceAccount value)

public Node.Builder setServiceAccount(ServiceAccount value)

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;

Parameter
Name Description
value ServiceAccount
Returns
Type Description
Node.Builder

setServiceAccount(ServiceAccount.Builder builderForValue)

public Node.Builder setServiceAccount(ServiceAccount.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ServiceAccount.Builder
Returns
Type Description
Node.Builder

setShieldedInstanceConfig(ShieldedInstanceConfig value)

public Node.Builder setShieldedInstanceConfig(ShieldedInstanceConfig value)

Shielded Instance options.

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

Parameter
Name Description
value ShieldedInstanceConfig
Returns
Type Description
Node.Builder

setShieldedInstanceConfig(ShieldedInstanceConfig.Builder builderForValue)

public Node.Builder setShieldedInstanceConfig(ShieldedInstanceConfig.Builder builderForValue)

Shielded Instance options.

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

Parameter
Name Description
builderForValue ShieldedInstanceConfig.Builder
Returns
Type Description
Node.Builder

setState(Node.State value)

public Node.Builder setState(Node.State value)

Output only. The current state for the TPU Node.

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

Parameter
Name Description
value Node.State

The state to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setStateValue(int value)

public Node.Builder setStateValue(int value)

Output only. The current state for the TPU Node.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setSymptoms(int index, Symptom value)

public Node.Builder setSymptoms(int index, Symptom value)

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];

Parameters
Name Description
index int
value Symptom
Returns
Type Description
Node.Builder

setSymptoms(int index, Symptom.Builder builderForValue)

public Node.Builder setSymptoms(int index, Symptom.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Symptom.Builder
Returns
Type Description
Node.Builder

setTags(int index, String value)

public Node.Builder setTags(int index, String value)

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

repeated string tags = 40;

Parameters
Name Description
index int

The index to set the value at.
value String

The tags to set.
Returns
Type Description
Node.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Node.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Node.Builder
Overrides