Google Cloud Ai Platform V1 Client - Class WorkerPoolSpec (0.17.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class WorkerPoolSpec.

Represents the spec of a worker pool in a job.

Generated from protobuf message google.cloud.aiplatform.v1.WorkerPoolSpec

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ container_spec Google\Cloud\AIPlatform\V1\ContainerSpec

The custom container task.

↳ python_package_spec Google\Cloud\AIPlatform\V1\PythonPackageSpec

The Python packaged task.

↳ machine_spec Google\Cloud\AIPlatform\V1\MachineSpec

Optional. Immutable. The specification of a single machine.

↳ replica_count int|string

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

↳ nfs_mounts array<Google\Cloud\AIPlatform\V1\NfsMount>

Optional. List of NFS mount spec.

↳ disk_spec Google\Cloud\AIPlatform\V1\DiskSpec

Disk spec.

getContainerSpec

The custom container task.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ContainerSpec|null

hasContainerSpec

setContainerSpec

The custom container task.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\ContainerSpec
Returns
TypeDescription
$this

getPythonPackageSpec

The Python packaged task.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\PythonPackageSpec|null

hasPythonPackageSpec

setPythonPackageSpec

The Python packaged task.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\PythonPackageSpec
Returns
TypeDescription
$this

getMachineSpec

Optional. Immutable. The specification of a single machine.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\MachineSpec|null

hasMachineSpec

clearMachineSpec

setMachineSpec

Optional. Immutable. The specification of a single machine.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\MachineSpec
Returns
TypeDescription
$this

getReplicaCount

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

Returns
TypeDescription
int|string

setReplicaCount

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getNfsMounts

Optional. List of NFS mount spec.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNfsMounts

Optional. List of NFS mount spec.

Parameter
NameDescription
var array<Google\Cloud\AIPlatform\V1\NfsMount>
Returns
TypeDescription
$this

getDiskSpec

Disk spec.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\DiskSpec|null

hasDiskSpec

clearDiskSpec

setDiskSpec

Disk spec.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\DiskSpec
Returns
TypeDescription
$this

getTask

Returns
TypeDescription
string