Google Cloud Ai Platform V1 Client - Class BatchDedicatedResources (0.10.0)

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

A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ machine_spec Google\Cloud\AIPlatform\V1\MachineSpec

Required. Immutable. The specification of a single machine.

↳ starting_replica_count int

Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count

↳ max_replica_count int

Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.

getMachineSpec

Required. Immutable. The specification of a single machine.

Generated from protobuf field .google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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

hasMachineSpec

clearMachineSpec

setMachineSpec

Required. Immutable. The specification of a single machine.

Generated from protobuf field .google.cloud.aiplatform.v1.MachineSpec machine_spec = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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

getStartingReplicaCount

Immutable. The number of machine replicas used at the start of the batch operation.

If not set, Vertex AI decides starting number, not greater than max_replica_count

Generated from protobuf field int32 starting_replica_count = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
int

setStartingReplicaCount

Immutable. The number of machine replicas used at the start of the batch operation.

If not set, Vertex AI decides starting number, not greater than max_replica_count

Generated from protobuf field int32 starting_replica_count = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMaxReplicaCount

Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.

Generated from protobuf field int32 max_replica_count = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
int

setMaxReplicaCount

Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.

Generated from protobuf field int32 max_replica_count = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
var int
Returns
TypeDescription
$this