Compute V1 Client - Class ReservationAffinity (1.20.0)

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

Specifies the reservations that this instance can consume from.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ consume_reservation_typestring

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. Check the ConsumeReservationType enum for the list of possible values.

↳ keystring

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

↳ valuesarray

Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

getConsumeReservationType

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

Check the ConsumeReservationType enum for the list of possible values.

Returns
TypeDescription
string

hasConsumeReservationType

clearConsumeReservationType

setConsumeReservationType

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

Check the ConsumeReservationType enum for the list of possible values.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getKey

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

Returns
TypeDescription
string

hasKey

clearKey

setKey

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getValues

Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setValues

Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Parameter
NameDescription
varstring[]
Returns
TypeDescription
$this