Reference documentation and code samples for the Compute V1 Client class Reservation.
Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
Generated from protobuf message google.cloud.compute.v1.Reservation
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ aggregate_reservation | AllocationAggregateReservationReservation for aggregated resources, providing shape flexibility. |
↳ commitment | string[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. |
↳ creation_timestamp | string[Output Only] Creation timestamp in RFC3339 text format. |
↳ description | stringAn optional description of this resource. Provide this property when you create the resource. |
↳ id | int|string[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
↳ kind | string[Output Only] Type of the resource. Always compute#reservations for reservations. |
↳ name | stringThe name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
↳ resource_policies | array|Google\Protobuf\Internal\MapFieldResource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation. |
↳ resource_status | AllocationResourceStatus[Output Only] Status information for Reservation resource. |
↳ satisfies_pzs | bool[Output Only] Reserved for future use. |
↳ self_link | string[Output Only] Server-defined fully-qualified URL for this resource. |
↳ share_settings | ShareSettingsSpecify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation. |
↳ specific_reservation | AllocationSpecificSKUReservationReservation for instances with specific machine shapes. |
↳ specific_reservation_required | boolIndicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. |
↳ status | string[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. Check the Status enum for the list of possible values. |
↳ zone | stringZone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. |
getAggregateReservation
Reservation for aggregated resources, providing shape flexibility.
| Returns | |
|---|---|
| Type | Description |
AllocationAggregateReservation|null | |
hasAggregateReservation
clearAggregateReservation
setAggregateReservation
Reservation for aggregated resources, providing shape flexibility.
| Parameter | |
|---|---|
| Name | Description |
var | AllocationAggregateReservation |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCommitment
[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCommitment
clearCommitment
setCommitment
[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional description of this resource. Provide this property when you create the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var | int|string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] Type of the resource. Always compute#reservations for reservations.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#reservations for reservations.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourcePolicies
Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setResourcePolicies
Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
| Parameter | |
|---|---|
| Name | Description |
var | array|Google\Protobuf\Internal\MapField |
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceStatus
[Output Only] Status information for Reservation resource.
| Returns | |
|---|---|
| Type | Description |
AllocationResourceStatus|null | |
hasResourceStatus
clearResourceStatus
setResourceStatus
[Output Only] Status information for Reservation resource.
| Parameter | |
|---|---|
| Name | Description |
var | AllocationResourceStatus |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSatisfiesPzs
[Output Only] Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
[Output Only] Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getShareSettings
Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
| Returns | |
|---|---|
| Type | Description |
ShareSettings|null | |
hasShareSettings
clearShareSettings
setShareSettings
Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
| Parameter | |
|---|---|
| Name | Description |
var | ShareSettings |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpecificReservation
Reservation for instances with specific machine shapes.
| Returns | |
|---|---|
| Type | Description |
AllocationSpecificSKUReservation|null | |
hasSpecificReservation
clearSpecificReservation
setSpecificReservation
Reservation for instances with specific machine shapes.
| Parameter | |
|---|---|
| Name | Description |
var | AllocationSpecificSKUReservation |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpecificReservationRequired
Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasSpecificReservationRequired
clearSpecificReservationRequired
setSpecificReservationRequired
Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
Check the Status enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatus
clearStatus
setStatus
[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
Check the Status enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
| Returns | |
|---|---|
| Type | Description |
string | |
hasZone
clearZone
setZone
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |