Google Cloud Ai Platform V1 Client - Class ResourcePool (1.4.0)

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

Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ id string

Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.

↳ machine_spec Google\Cloud\AIPlatform\V1\MachineSpec

Required. Immutable. The specification of a single machine.

↳ replica_count int|string

Optional. The total number of machines to use for this resource pool.

↳ disk_spec Google\Cloud\AIPlatform\V1\DiskSpec

Optional. Disk spec for the machine in this node pool.

↳ used_replica_count int|string

Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.

↳ autoscaling_spec Google\Cloud\AIPlatform\V1\ResourcePool\AutoscalingSpec

Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling

getId

Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.

Returns
Type Description
string

setId

Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.

Parameter
Name Description
var string
Returns
Type Description
$this

getMachineSpec

Required. Immutable. The specification of a single machine.

Returns
Type Description
Google\Cloud\AIPlatform\V1\MachineSpec|null

hasMachineSpec

clearMachineSpec

setMachineSpec

Required. Immutable. The specification of a single machine.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\MachineSpec
Returns
Type Description
$this

getReplicaCount

Optional. The total number of machines to use for this resource pool.

Returns
Type Description
int|string

hasReplicaCount

clearReplicaCount

setReplicaCount

Optional. The total number of machines to use for this resource pool.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDiskSpec

Optional. Disk spec for the machine in this node pool.

Returns
Type Description
Google\Cloud\AIPlatform\V1\DiskSpec|null

hasDiskSpec

clearDiskSpec

setDiskSpec

Optional. Disk spec for the machine in this node pool.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\DiskSpec
Returns
Type Description
$this

getUsedReplicaCount

Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.

Returns
Type Description
int|string

setUsedReplicaCount

Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getAutoscalingSpec

Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling

Returns
Type Description
Google\Cloud\AIPlatform\V1\ResourcePool\AutoscalingSpec|null

hasAutoscalingSpec

clearAutoscalingSpec

setAutoscalingSpec

Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ResourcePool\AutoscalingSpec
Returns
Type Description
$this