Class WorkerPoolSpec.Builder (3.23.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.v1beta1.WorkerPoolSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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.v1beta1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.NfsMount>
Returns
TypeDescription
WorkerPoolSpec.Builder

addNfsMounts(NfsMount value)

public WorkerPoolSpec.Builder addNfsMounts(NfsMount value)

Optional. List of NFS mount spec.

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

Parameter
NameDescription
valueNfsMount
Returns
TypeDescription
WorkerPoolSpec.Builder

addNfsMounts(NfsMount.Builder builderForValue)

public WorkerPoolSpec.Builder addNfsMounts(NfsMount.Builder builderForValue)

Optional. List of NFS mount spec.

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

Parameter
NameDescription
builderForValueNfsMount.Builder
Returns
TypeDescription
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.v1beta1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
valueNfsMount
Returns
TypeDescription
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.v1beta1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
builderForValueNfsMount.Builder
Returns
TypeDescription
WorkerPoolSpec.Builder

addNfsMountsBuilder()

public NfsMount.Builder addNfsMountsBuilder()

Optional. List of NFS mount spec.

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

Returns
TypeDescription
NfsMount.Builder

addNfsMountsBuilder(int index)

public NfsMount.Builder addNfsMountsBuilder(int index)

Optional. List of NFS mount spec.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsMount.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WorkerPoolSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

build()

public WorkerPoolSpec build()
Returns
TypeDescription
WorkerPoolSpec

buildPartial()

public WorkerPoolSpec buildPartial()
Returns
TypeDescription
WorkerPoolSpec

clear()

public WorkerPoolSpec.Builder clear()
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

clearContainerSpec()

public WorkerPoolSpec.Builder clearContainerSpec()

The custom container task.

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

Returns
TypeDescription
WorkerPoolSpec.Builder

clearDiskSpec()

public WorkerPoolSpec.Builder clearDiskSpec()

Disk spec.

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

Returns
TypeDescription
WorkerPoolSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public WorkerPoolSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

clearMachineSpec()

public WorkerPoolSpec.Builder clearMachineSpec()

Optional. Immutable. The specification of a single machine.

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

Returns
TypeDescription
WorkerPoolSpec.Builder

clearNfsMounts()

public WorkerPoolSpec.Builder clearNfsMounts()

Optional. List of NFS mount spec.

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

Returns
TypeDescription
WorkerPoolSpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public WorkerPoolSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

clearPythonPackageSpec()

public WorkerPoolSpec.Builder clearPythonPackageSpec()

The Python packaged task.

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

Returns
TypeDescription
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
TypeDescription
WorkerPoolSpec.Builder

This builder for chaining.

clearTask()

public WorkerPoolSpec.Builder clearTask()
Returns
TypeDescription
WorkerPoolSpec.Builder

clone()

public WorkerPoolSpec.Builder clone()
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

getContainerSpec()

public ContainerSpec getContainerSpec()

The custom container task.

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

Returns
TypeDescription
ContainerSpec

The containerSpec.

getContainerSpecBuilder()

public ContainerSpec.Builder getContainerSpecBuilder()

The custom container task.

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

Returns
TypeDescription
ContainerSpec.Builder

getContainerSpecOrBuilder()

public ContainerSpecOrBuilder getContainerSpecOrBuilder()

The custom container task.

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

Returns
TypeDescription
ContainerSpecOrBuilder

getDefaultInstanceForType()

public WorkerPoolSpec getDefaultInstanceForType()
Returns
TypeDescription
WorkerPoolSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDiskSpec()

public DiskSpec getDiskSpec()

Disk spec.

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

Returns
TypeDescription
DiskSpec

The diskSpec.

getDiskSpecBuilder()

public DiskSpec.Builder getDiskSpecBuilder()

Disk spec.

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

Returns
TypeDescription
DiskSpec.Builder

getDiskSpecOrBuilder()

public DiskSpecOrBuilder getDiskSpecOrBuilder()

Disk spec.

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

Returns
TypeDescription
DiskSpecOrBuilder

getMachineSpec()

public MachineSpec getMachineSpec()

Optional. Immutable. The specification of a single machine.

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

Returns
TypeDescription
MachineSpec

The machineSpec.

getMachineSpecBuilder()

public MachineSpec.Builder getMachineSpecBuilder()

Optional. Immutable. The specification of a single machine.

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

Returns
TypeDescription
MachineSpec.Builder

getMachineSpecOrBuilder()

public MachineSpecOrBuilder getMachineSpecOrBuilder()

Optional. Immutable. The specification of a single machine.

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

Returns
TypeDescription
MachineSpecOrBuilder

getNfsMounts(int index)

public NfsMount getNfsMounts(int index)

Optional. List of NFS mount spec.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsMount

getNfsMountsBuilder(int index)

public NfsMount.Builder getNfsMountsBuilder(int index)

Optional. List of NFS mount spec.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsMount.Builder

getNfsMountsBuilderList()

public List<NfsMount.Builder> getNfsMountsBuilderList()

Optional. List of NFS mount spec.

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

Returns
TypeDescription
List<Builder>

getNfsMountsCount()

public int getNfsMountsCount()

Optional. List of NFS mount spec.

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

Returns
TypeDescription
int

getNfsMountsList()

public List<NfsMount> getNfsMountsList()

Optional. List of NFS mount spec.

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

Returns
TypeDescription
List<NfsMount>

getNfsMountsOrBuilder(int index)

public NfsMountOrBuilder getNfsMountsOrBuilder(int index)

Optional. List of NFS mount spec.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsMountOrBuilder

getNfsMountsOrBuilderList()

public List<? extends NfsMountOrBuilder> getNfsMountsOrBuilderList()

Optional. List of NFS mount spec.

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

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.NfsMountOrBuilder>

getPythonPackageSpec()

public PythonPackageSpec getPythonPackageSpec()

The Python packaged task.

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

Returns
TypeDescription
PythonPackageSpec

The pythonPackageSpec.

getPythonPackageSpecBuilder()

public PythonPackageSpec.Builder getPythonPackageSpecBuilder()

The Python packaged task.

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

Returns
TypeDescription
PythonPackageSpec.Builder

getPythonPackageSpecOrBuilder()

public PythonPackageSpecOrBuilder getPythonPackageSpecOrBuilder()

The Python packaged task.

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

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

The replicaCount.

getTaskCase()

public WorkerPoolSpec.TaskCase getTaskCase()
Returns
TypeDescription
WorkerPoolSpec.TaskCase

hasContainerSpec()

public boolean hasContainerSpec()

The custom container task.

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

Returns
TypeDescription
boolean

Whether the containerSpec field is set.

hasDiskSpec()

public boolean hasDiskSpec()

Disk spec.

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

Returns
TypeDescription
boolean

Whether the diskSpec field is set.

hasMachineSpec()

public boolean hasMachineSpec()

Optional. Immutable. The specification of a single machine.

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

Returns
TypeDescription
boolean

Whether the machineSpec field is set.

hasPythonPackageSpec()

public boolean hasPythonPackageSpec()

The Python packaged task.

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

Returns
TypeDescription
boolean

Whether the pythonPackageSpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeContainerSpec(ContainerSpec value)

public WorkerPoolSpec.Builder mergeContainerSpec(ContainerSpec value)

The custom container task.

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

Parameter
NameDescription
valueContainerSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

mergeDiskSpec(DiskSpec value)

public WorkerPoolSpec.Builder mergeDiskSpec(DiskSpec value)

Disk spec.

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

Parameter
NameDescription
valueDiskSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

mergeFrom(WorkerPoolSpec other)

public WorkerPoolSpec.Builder mergeFrom(WorkerPoolSpec other)
Parameter
NameDescription
otherWorkerPoolSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WorkerPoolSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WorkerPoolSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

mergeMachineSpec(MachineSpec value)

public WorkerPoolSpec.Builder mergeMachineSpec(MachineSpec value)

Optional. Immutable. The specification of a single machine.

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

Parameter
NameDescription
valueMachineSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

mergePythonPackageSpec(PythonPackageSpec value)

public WorkerPoolSpec.Builder mergePythonPackageSpec(PythonPackageSpec value)

The Python packaged task.

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

Parameter
NameDescription
valuePythonPackageSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WorkerPoolSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

removeNfsMounts(int index)

public WorkerPoolSpec.Builder removeNfsMounts(int index)

Optional. List of NFS mount spec.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
WorkerPoolSpec.Builder

setContainerSpec(ContainerSpec value)

public WorkerPoolSpec.Builder setContainerSpec(ContainerSpec value)

The custom container task.

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

Parameter
NameDescription
valueContainerSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

setContainerSpec(ContainerSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setContainerSpec(ContainerSpec.Builder builderForValue)

The custom container task.

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

Parameter
NameDescription
builderForValueContainerSpec.Builder
Returns
TypeDescription
WorkerPoolSpec.Builder

setDiskSpec(DiskSpec value)

public WorkerPoolSpec.Builder setDiskSpec(DiskSpec value)

Disk spec.

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

Parameter
NameDescription
valueDiskSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

setDiskSpec(DiskSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setDiskSpec(DiskSpec.Builder builderForValue)

Disk spec.

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

Parameter
NameDescription
builderForValueDiskSpec.Builder
Returns
TypeDescription
WorkerPoolSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WorkerPoolSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

setMachineSpec(MachineSpec value)

public WorkerPoolSpec.Builder setMachineSpec(MachineSpec value)

Optional. Immutable. The specification of a single machine.

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

Parameter
NameDescription
valueMachineSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

setMachineSpec(MachineSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setMachineSpec(MachineSpec.Builder builderForValue)

Optional. Immutable. The specification of a single machine.

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

Parameter
NameDescription
builderForValueMachineSpec.Builder
Returns
TypeDescription
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.v1beta1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
valueNfsMount
Returns
TypeDescription
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.v1beta1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
builderForValueNfsMount.Builder
Returns
TypeDescription
WorkerPoolSpec.Builder

setPythonPackageSpec(PythonPackageSpec value)

public WorkerPoolSpec.Builder setPythonPackageSpec(PythonPackageSpec value)

The Python packaged task.

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

Parameter
NameDescription
valuePythonPackageSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

setPythonPackageSpec(PythonPackageSpec.Builder builderForValue)

public WorkerPoolSpec.Builder setPythonPackageSpec(PythonPackageSpec.Builder builderForValue)

The Python packaged task.

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

Parameter
NameDescription
builderForValuePythonPackageSpec.Builder
Returns
TypeDescription
WorkerPoolSpec.Builder

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

public WorkerPoolSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The replicaCount to set.

Returns
TypeDescription
WorkerPoolSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WorkerPoolSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides