Compute V1 Client - Class AllocationAggregateReservation (1.17.0)

Reference documentation and code samples for the Compute V1 Client class AllocationAggregateReservation.

This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation.

Generated from protobuf message google.cloud.compute.v1.AllocationAggregateReservation

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ in_use_resources array<Google\Cloud\Compute\V1\AllocationAggregateReservationReservedResourceInfo>

[Output only] List of resources currently in use.

↳ reserved_resources array<Google\Cloud\Compute\V1\AllocationAggregateReservationReservedResourceInfo>

List of reserved resources (CPUs, memory, accelerators).

↳ vm_family string

The VM family that all instances scheduled against this reservation must belong to. Check the VmFamily enum for the list of possible values.

↳ workload_type string

The workload type of the instances that will target this reservation. Check the WorkloadType enum for the list of possible values.

getInUseResources

[Output only] List of resources currently in use.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setInUseResources

[Output only] List of resources currently in use.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\AllocationAggregateReservationReservedResourceInfo>
Returns
Type Description
$this

getReservedResources

List of reserved resources (CPUs, memory, accelerators).

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReservedResources

List of reserved resources (CPUs, memory, accelerators).

Parameter
Name Description
var array<Google\Cloud\Compute\V1\AllocationAggregateReservationReservedResourceInfo>
Returns
Type Description
$this

getVmFamily

The VM family that all instances scheduled against this reservation must belong to.

Check the VmFamily enum for the list of possible values.

Returns
Type Description
string

hasVmFamily

clearVmFamily

setVmFamily

The VM family that all instances scheduled against this reservation must belong to.

Check the VmFamily enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkloadType

The workload type of the instances that will target this reservation.

Check the WorkloadType enum for the list of possible values.

Returns
Type Description
string

hasWorkloadType

clearWorkloadType

setWorkloadType

The workload type of the instances that will target this reservation.

Check the WorkloadType enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this