Class WorkerPoolSpec.Builder (3.47.0)

public static final class WorkerPoolSpec.Builder extends GeneratedMessageV3.Builder<WorkerPoolSpec.Builder> implements WorkerPoolSpecOrBuilder

Represents the spec of a worker pool in a job.

Protobuf type google.cloud.aiplatform.v1.WorkerPoolSpec

Static Methods

getDescriptor()

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

Methods

addAllNfsMounts(Iterable<? extends NfsMount> values)

public WorkerPoolSpec.Builder addAllNfsMounts(Iterable<? extends NfsMount> values)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.NfsMount>
Returns
Type Description
WorkerPoolSpec.Builder

addNfsMounts(NfsMount value)

public WorkerPoolSpec.Builder addNfsMounts(NfsMount value)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value NfsMount
Returns
Type Description
WorkerPoolSpec.Builder

addNfsMounts(NfsMount.Builder builderForValue)

public WorkerPoolSpec.Builder addNfsMounts(NfsMount.Builder builderForValue)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue NfsMount.Builder
Returns
Type Description
WorkerPoolSpec.Builder

addNfsMounts(int index, NfsMount value)

public WorkerPoolSpec.Builder addNfsMounts(int index, NfsMount value)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value NfsMount
Returns
Type Description
WorkerPoolSpec.Builder

addNfsMounts(int index, NfsMount.Builder builderForValue)

public WorkerPoolSpec.Builder addNfsMounts(int index, NfsMount.Builder builderForValue)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue NfsMount.Builder
Returns
Type Description
WorkerPoolSpec.Builder

addNfsMountsBuilder()

public NfsMount.Builder addNfsMountsBuilder()

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NfsMount.Builder

addNfsMountsBuilder(int index)

public NfsMount.Builder addNfsMountsBuilder(int index)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NfsMount.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public WorkerPoolSpec build()
Returns
Type Description
WorkerPoolSpec

buildPartial()

public WorkerPoolSpec buildPartial()
Returns
Type Description
WorkerPoolSpec

clear()

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

clearContainerSpec()

public WorkerPoolSpec.Builder clearContainerSpec()

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Returns
Type Description
WorkerPoolSpec.Builder

clearDiskSpec()

public WorkerPoolSpec.Builder clearDiskSpec()

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Returns
Type Description
WorkerPoolSpec.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearMachineSpec()

public WorkerPoolSpec.Builder clearMachineSpec()

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
WorkerPoolSpec.Builder

clearNfsMounts()

public WorkerPoolSpec.Builder clearNfsMounts()

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkerPoolSpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPythonPackageSpec()

public WorkerPoolSpec.Builder clearPythonPackageSpec()

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Returns
Type Description
WorkerPoolSpec.Builder

clearReplicaCount()

public WorkerPoolSpec.Builder clearReplicaCount()

Optional. The number of worker replicas to use for this worker pool.

int64 replica_count = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkerPoolSpec.Builder

This builder for chaining.

clearTask()

public WorkerPoolSpec.Builder clearTask()
Returns
Type Description
WorkerPoolSpec.Builder

clone()

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

getContainerSpec()

public ContainerSpec getContainerSpec()

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Returns
Type Description
ContainerSpec

The containerSpec.

getContainerSpecBuilder()

public ContainerSpec.Builder getContainerSpecBuilder()

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Returns
Type Description
ContainerSpec.Builder

getContainerSpecOrBuilder()

public ContainerSpecOrBuilder getContainerSpecOrBuilder()

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Returns
Type Description
ContainerSpecOrBuilder

getDefaultInstanceForType()

public WorkerPoolSpec getDefaultInstanceForType()
Returns
Type Description
WorkerPoolSpec

getDescriptorForType()

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

getDiskSpec()

public DiskSpec getDiskSpec()

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Returns
Type Description
DiskSpec

The diskSpec.

getDiskSpecBuilder()

public DiskSpec.Builder getDiskSpecBuilder()

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Returns
Type Description
DiskSpec.Builder

getDiskSpecOrBuilder()

public DiskSpecOrBuilder getDiskSpecOrBuilder()

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Returns
Type Description
DiskSpecOrBuilder

getMachineSpec()

public MachineSpec getMachineSpec()

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
MachineSpec

The machineSpec.

getMachineSpecBuilder()

public MachineSpec.Builder getMachineSpecBuilder()

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
MachineSpec.Builder

getMachineSpecOrBuilder()

public MachineSpecOrBuilder getMachineSpecOrBuilder()

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
MachineSpecOrBuilder

getNfsMounts(int index)

public NfsMount getNfsMounts(int index)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NfsMount

getNfsMountsBuilder(int index)

public NfsMount.Builder getNfsMountsBuilder(int index)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NfsMount.Builder

getNfsMountsBuilderList()

public List<NfsMount.Builder> getNfsMountsBuilderList()

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getNfsMountsCount()

public int getNfsMountsCount()

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getNfsMountsList()

public List<NfsMount> getNfsMountsList()

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<NfsMount>

getNfsMountsOrBuilder(int index)

public NfsMountOrBuilder getNfsMountsOrBuilder(int index)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NfsMountOrBuilder

getNfsMountsOrBuilderList()

public List<? extends NfsMountOrBuilder> getNfsMountsOrBuilderList()

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.NfsMountOrBuilder>

getPythonPackageSpec()

public PythonPackageSpec getPythonPackageSpec()

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Returns
Type Description
PythonPackageSpec

The pythonPackageSpec.

getPythonPackageSpecBuilder()

public PythonPackageSpec.Builder getPythonPackageSpecBuilder()

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Returns
Type Description
PythonPackageSpec.Builder

getPythonPackageSpecOrBuilder()

public PythonPackageSpecOrBuilder getPythonPackageSpecOrBuilder()

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Returns
Type Description
PythonPackageSpecOrBuilder

getReplicaCount()

public long getReplicaCount()

Optional. The number of worker replicas to use for this worker pool.

int64 replica_count = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The replicaCount.

getTaskCase()

public WorkerPoolSpec.TaskCase getTaskCase()
Returns
Type Description
WorkerPoolSpec.TaskCase

hasContainerSpec()

public boolean hasContainerSpec()

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Returns
Type Description
boolean

Whether the containerSpec field is set.

hasDiskSpec()

public boolean hasDiskSpec()

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Returns
Type Description
boolean

Whether the diskSpec field is set.

hasMachineSpec()

public boolean hasMachineSpec()

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the machineSpec field is set.

hasPythonPackageSpec()

public boolean hasPythonPackageSpec()

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Returns
Type Description
boolean

Whether the pythonPackageSpec field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeContainerSpec(ContainerSpec value)

public WorkerPoolSpec.Builder mergeContainerSpec(ContainerSpec value)

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Parameter
Name Description
value ContainerSpec
Returns
Type Description
WorkerPoolSpec.Builder

mergeDiskSpec(DiskSpec value)

public WorkerPoolSpec.Builder mergeDiskSpec(DiskSpec value)

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Parameter
Name Description
value DiskSpec
Returns
Type Description
WorkerPoolSpec.Builder

mergeFrom(WorkerPoolSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMachineSpec(MachineSpec value)

public WorkerPoolSpec.Builder mergeMachineSpec(MachineSpec value)

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value MachineSpec
Returns
Type Description
WorkerPoolSpec.Builder

mergePythonPackageSpec(PythonPackageSpec value)

public WorkerPoolSpec.Builder mergePythonPackageSpec(PythonPackageSpec value)

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Parameter
Name Description
value PythonPackageSpec
Returns
Type Description
WorkerPoolSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeNfsMounts(int index)

public WorkerPoolSpec.Builder removeNfsMounts(int index)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
WorkerPoolSpec.Builder

setContainerSpec(ContainerSpec value)

public WorkerPoolSpec.Builder setContainerSpec(ContainerSpec value)

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Parameter
Name Description
value ContainerSpec
Returns
Type Description
WorkerPoolSpec.Builder

setContainerSpec(ContainerSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setContainerSpec(ContainerSpec.Builder builderForValue)

The custom container task.

.google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;

Parameter
Name Description
builderForValue ContainerSpec.Builder
Returns
Type Description
WorkerPoolSpec.Builder

setDiskSpec(DiskSpec value)

public WorkerPoolSpec.Builder setDiskSpec(DiskSpec value)

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Parameter
Name Description
value DiskSpec
Returns
Type Description
WorkerPoolSpec.Builder

setDiskSpec(DiskSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setDiskSpec(DiskSpec.Builder builderForValue)

Disk spec.

.google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;

Parameter
Name Description
builderForValue DiskSpec.Builder
Returns
Type Description
WorkerPoolSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setMachineSpec(MachineSpec value)

public WorkerPoolSpec.Builder setMachineSpec(MachineSpec value)

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value MachineSpec
Returns
Type Description
WorkerPoolSpec.Builder

setMachineSpec(MachineSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setMachineSpec(MachineSpec.Builder builderForValue)

Optional. Immutable. The specification of a single machine.

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue MachineSpec.Builder
Returns
Type Description
WorkerPoolSpec.Builder

setNfsMounts(int index, NfsMount value)

public WorkerPoolSpec.Builder setNfsMounts(int index, NfsMount value)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value NfsMount
Returns
Type Description
WorkerPoolSpec.Builder

setNfsMounts(int index, NfsMount.Builder builderForValue)

public WorkerPoolSpec.Builder setNfsMounts(int index, NfsMount.Builder builderForValue)

Optional. List of NFS mount spec.

repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue NfsMount.Builder
Returns
Type Description
WorkerPoolSpec.Builder

setPythonPackageSpec(PythonPackageSpec value)

public WorkerPoolSpec.Builder setPythonPackageSpec(PythonPackageSpec value)

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Parameter
Name Description
value PythonPackageSpec
Returns
Type Description
WorkerPoolSpec.Builder

setPythonPackageSpec(PythonPackageSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setPythonPackageSpec(PythonPackageSpec.Builder builderForValue)

The Python packaged task.

.google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;

Parameter
Name Description
builderForValue PythonPackageSpec.Builder
Returns
Type Description
WorkerPoolSpec.Builder

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

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

setReplicaCount(long value)

public WorkerPoolSpec.Builder setReplicaCount(long value)

Optional. The number of worker replicas to use for this worker pool.

int64 replica_count = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The replicaCount to set.

Returns
Type Description
WorkerPoolSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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