Class QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder (2.84.0)

public static final class QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder extends GeneratedMessage.Builder<QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder> implements QueuedResource.Tpu.NodeSpec.MultiNodeParamsOrBuilder

Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams

Static Methods

getDescriptor()

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

Methods

build()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams build()
Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams

buildPartial()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams buildPartial()
Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams

clear()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder clear()
Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder
Overrides

clearNodeCount()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder clearNodeCount()

Required. Number of nodes with this spec. The system will attempt to provison "node_count" nodes as part of the request. This needs to be > 1.

int32 node_count = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.

clearNodeIdPrefix()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder clearNodeIdPrefix()

Prefix of node_ids in case of multi-node request Should follow the ^[A-Za-z0-9_.~+%-]+$ regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.

string node_id_prefix = 2;

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.

clearWorkloadType()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder clearWorkloadType()

Optional. The workload type for the multi-node request.

.google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType workload_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.

getDefaultInstanceForType()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams getDefaultInstanceForType()
Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams

getDescriptorForType()

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

getNodeCount()

public int getNodeCount()

Required. Number of nodes with this spec. The system will attempt to provison "node_count" nodes as part of the request. This needs to be > 1.

int32 node_count = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The nodeCount.

getNodeIdPrefix()

public String getNodeIdPrefix()

Prefix of node_ids in case of multi-node request Should follow the ^[A-Za-z0-9_.~+%-]+$ regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.

string node_id_prefix = 2;

Returns
Type Description
String

The nodeIdPrefix.

getNodeIdPrefixBytes()

public ByteString getNodeIdPrefixBytes()

Prefix of node_ids in case of multi-node request Should follow the ^[A-Za-z0-9_.~+%-]+$ regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.

string node_id_prefix = 2;

Returns
Type Description
ByteString

The bytes for nodeIdPrefix.

getWorkloadType()

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType getWorkloadType()

Optional. The workload type for the multi-node request.

.google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType workload_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType

The workloadType.

getWorkloadTypeValue()

public int getWorkloadTypeValue()

Optional. The workload type for the multi-node request.

.google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType workload_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for workloadType.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(QueuedResource.Tpu.NodeSpec.MultiNodeParams other)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder mergeFrom(QueuedResource.Tpu.NodeSpec.MultiNodeParams other)
Parameter
Name Description
other QueuedResource.Tpu.NodeSpec.MultiNodeParams
Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder
Overrides

setNodeCount(int value)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder setNodeCount(int value)

Required. Number of nodes with this spec. The system will attempt to provison "node_count" nodes as part of the request. This needs to be > 1.

int32 node_count = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The nodeCount to set.

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.

setNodeIdPrefix(String value)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder setNodeIdPrefix(String value)

Prefix of node_ids in case of multi-node request Should follow the ^[A-Za-z0-9_.~+%-]+$ regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.

string node_id_prefix = 2;

Parameter
Name Description
value String

The nodeIdPrefix to set.

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.

setNodeIdPrefixBytes(ByteString value)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder setNodeIdPrefixBytes(ByteString value)

Prefix of node_ids in case of multi-node request Should follow the ^[A-Za-z0-9_.~+%-]+$ regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.

string node_id_prefix = 2;

Parameter
Name Description
value ByteString

The bytes for nodeIdPrefix to set.

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.

setWorkloadType(QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType value)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder setWorkloadType(QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType value)

Optional. The workload type for the multi-node request.

.google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType workload_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType

The workloadType to set.

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.

setWorkloadTypeValue(int value)

public QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder setWorkloadTypeValue(int value)

Optional. The workload type for the multi-node request.

.google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams.WorkloadType workload_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for workloadType to set.

Returns
Type Description
QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

This builder for chaining.