Class WorkerPoolSpec (3.14.0)

public final class WorkerPoolSpec extends GeneratedMessageV3 implements WorkerPoolSpecOrBuilder

Represents the spec of a worker pool in a job.

Protobuf type google.cloud.aiplatform.v1beta1.WorkerPoolSpec

Static Fields

CONTAINER_SPEC_FIELD_NUMBER

public static final int CONTAINER_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

DISK_SPEC_FIELD_NUMBER

public static final int DISK_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

MACHINE_SPEC_FIELD_NUMBER

public static final int MACHINE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

NFS_MOUNTS_FIELD_NUMBER

public static final int NFS_MOUNTS_FIELD_NUMBER
Field Value
TypeDescription
int

PYTHON_PACKAGE_SPEC_FIELD_NUMBER

public static final int PYTHON_PACKAGE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static WorkerPoolSpec getDefaultInstance()
Returns
TypeDescription
WorkerPoolSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static WorkerPoolSpec.Builder newBuilder()
Returns
TypeDescription
WorkerPoolSpec.Builder

newBuilder(WorkerPoolSpec prototype)

public static WorkerPoolSpec.Builder newBuilder(WorkerPoolSpec prototype)
Parameter
NameDescription
prototypeWorkerPoolSpec
Returns
TypeDescription
WorkerPoolSpec.Builder

parseDelimitedFrom(InputStream input)

public static WorkerPoolSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static WorkerPoolSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkerPoolSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkerPoolSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static WorkerPoolSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static WorkerPoolSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WorkerPoolSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<WorkerPoolSpec> parser()
Returns
TypeDescription
Parser<WorkerPoolSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContainerSpec()

public ContainerSpec getContainerSpec()

The custom container task.

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

Returns
TypeDescription
ContainerSpec

The containerSpec.

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

getDiskSpec()

public DiskSpec getDiskSpec()

Disk spec.

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

Returns
TypeDescription
DiskSpec

The diskSpec.

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.

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

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>

getParserForType()

public Parser<WorkerPoolSpec> getParserForType()
Returns
TypeDescription
Parser<WorkerPoolSpec>
Overrides

getPythonPackageSpec()

public PythonPackageSpec getPythonPackageSpec()

The Python packaged task.

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

Returns
TypeDescription
PythonPackageSpec

The pythonPackageSpec.

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTaskCase()

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkerPoolSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
WorkerPoolSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException