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 | |
|---|---|
| Name | Description |
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.
Generated from protobuf field .google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\ContainerSpec|null | |
hasContainerSpec
setContainerSpec
The custom container task.
Generated from protobuf field .google.cloud.aiplatform.v1.ContainerSpec container_spec = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\ContainerSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPythonPackageSpec
The Python packaged task.
Generated from protobuf field .google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\PythonPackageSpec|null | |
hasPythonPackageSpec
setPythonPackageSpec
The Python packaged task.
Generated from protobuf field .google.cloud.aiplatform.v1.PythonPackageSpec python_package_spec = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\PythonPackageSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMachineSpec
Optional. Immutable. The specification of a single machine.
Generated from protobuf field .google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\MachineSpec|null | |
hasMachineSpec
clearMachineSpec
setMachineSpec
Optional. Immutable. The specification of a single machine.
Generated from protobuf field .google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\MachineSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReplicaCount
Optional. The number of worker replicas to use for this worker pool.
Generated from protobuf field int64 replica_count = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int|string | |
setReplicaCount
Optional. The number of worker replicas to use for this worker pool.
Generated from protobuf field int64 replica_count = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNfsMounts
Optional. List of NFS mount spec.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNfsMounts
Optional. List of NFS mount spec.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.NfsMount nfs_mounts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\NfsMount>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiskSpec
Disk spec.
Generated from protobuf field .google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\DiskSpec|null | |
hasDiskSpec
clearDiskSpec
setDiskSpec
Disk spec.
Generated from protobuf field .google.cloud.aiplatform.v1.DiskSpec disk_spec = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\DiskSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTask
| Returns | |
|---|---|
| Type | Description |
string | |