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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
string
An 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
string
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.
↳ resource_policies
↳ resource_status
Google\Cloud\Compute\V1\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
Google\Cloud\Compute\V1\ShareSettings
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.
↳ specific_reservation
Google\Cloud\Compute\V1\AllocationSpecificSKUReservation
Reservation for instances with specific machine shapes.
↳ specific_reservation_required
bool
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.
↳ status
string
[Output Only] The status of the reservation. Check the Status enum for the list of possible values.
↳ zone
string
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
getCommitment
[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
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.
var
string
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getKind
[Output Only] Type of the resource. Always compute#reservations for reservations.
string
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#reservations for reservations.
var
string
$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.
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.
var
string
$this
getResourcePolicies
Generated from protobuf field map<string, string> resource_policies = 22220385;
setResourcePolicies
Generated from protobuf field map<string, string> resource_policies = 22220385;
$this
getResourceStatus
[Output Only] Status information for Reservation resource.
hasResourceStatus
clearResourceStatus
setResourceStatus
[Output Only] Status information for Reservation resource.
$this
getSatisfiesPzs
[Output Only] Reserved for future use.
bool
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
[Output Only] Reserved for future use.
var
bool
$this
getSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined fully-qualified URL for this resource.
var
string
$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.
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.
$this
getSpecificReservation
Reservation for instances with specific machine shapes.
hasSpecificReservation
clearSpecificReservation
setSpecificReservation
Reservation for instances with specific machine shapes.
$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.
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.
var
bool
$this
getStatus
[Output Only] The status of the reservation.
Check the Status enum for the list of possible values.
string
hasStatus
clearStatus
setStatus
[Output Only] The status of the reservation.
Check the Status enum for the list of possible values.
var
string
$this
getZone
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
string
hasZone
clearZone
setZone
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
var
string
$this
