Class WorkerPoolSpec (3.45.0)

public final class WorkerPoolSpec extends GeneratedMessageV3 implements WorkerPoolSpecOrBuilder

Represents the spec of a worker pool in a job.

Protobuf type google.cloud.aiplatform.v1.WorkerPoolSpec

Static Fields

CONTAINER_SPEC_FIELD_NUMBER

public static final int CONTAINER_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DISK_SPEC_FIELD_NUMBER

public static final int DISK_SPEC_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_SPEC_FIELD_NUMBER

public static final int MACHINE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

NFS_MOUNTS_FIELD_NUMBER

public static final int NFS_MOUNTS_FIELD_NUMBER
Field Value
Type Description
int

PYTHON_PACKAGE_SPEC_FIELD_NUMBER

public static final int PYTHON_PACKAGE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WorkerPoolSpec getDefaultInstance()
Returns
Type Description
WorkerPoolSpec

getDescriptor()

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

newBuilder()

public static WorkerPoolSpec.Builder newBuilder()
Returns
Type Description
WorkerPoolSpec.Builder

newBuilder(WorkerPoolSpec prototype)

public static WorkerPoolSpec.Builder newBuilder(WorkerPoolSpec prototype)
Parameter
Name Description
prototype WorkerPoolSpec
Returns
Type Description
WorkerPoolSpec.Builder

parseDelimitedFrom(InputStream input)

public static WorkerPoolSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WorkerPoolSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkerPoolSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkerPoolSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WorkerPoolSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WorkerPoolSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkerPoolSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkerPoolSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WorkerPoolSpec> parser()
Returns
Type Description
Parser<WorkerPoolSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContainerSpec()

public ContainerSpec getContainerSpec()

The custom container task.

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

Returns
Type Description
ContainerSpec

The containerSpec.

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

getDiskSpec()

public DiskSpec getDiskSpec()

Disk spec.

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

Returns
Type Description
DiskSpec

The diskSpec.

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.

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

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>

getParserForType()

public Parser<WorkerPoolSpec> getParserForType()
Returns
Type Description
Parser<WorkerPoolSpec>
Overrides

getPythonPackageSpec()

public PythonPackageSpec getPythonPackageSpec()

The Python packaged task.

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

Returns
Type Description
PythonPackageSpec

The pythonPackageSpec.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkerPoolSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WorkerPoolSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException