Class Reservation (1.23.0)

Reservation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
aggregate_reservation google.cloud.compute_v1.types.AllocationAggregateReservation
Reservation for aggregated resources, providing shape flexibility. This field is a member of oneof_ _aggregate_reservation.
commitment str
[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. This field is a member of oneof_ _commitment.
creation_timestamp str
[Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
description str
An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
id int
[Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind str
[Output Only] Type of the resource. Always compute#reservations for reservations. This field is a member of oneof_ _kind.
name str
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. This field is a member of oneof_ _name.
resource_policies MutableMapping[str, str]
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.
resource_status google.cloud.compute_v1.types.AllocationResourceStatus
[Output Only] Status information for Reservation resource. This field is a member of oneof_ _resource_status.
satisfies_pzs bool
[Output Only] Reserved for future use. This field is a member of oneof_ _satisfies_pzs.
self_link str
[Output Only] Server-defined fully-qualified URL for this resource. This field is a member of oneof_ _self_link.
share_settings google.cloud.compute_v1.types.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. This field is a member of oneof_ _share_settings.
specific_reservation google.cloud.compute_v1.types.AllocationSpecificSKUReservation
Reservation for instances with specific machine shapes. This field is a member of oneof_ _specific_reservation.
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. This field is a member of oneof_ _specific_reservation_required.
status str
[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. This field is a member of oneof_ _status.
zone str
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. This field is a member of oneof_ _zone.

Classes

ResourcePoliciesEntry

ResourcePoliciesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Status

Status(value)

[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.