Service for the reservations resource.
https://cloud.google.com/compute/docs/reference/rest/v1/reservations
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
ReservationsClient(ReservationsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReservationsClient const &
|
ReservationsClient(ReservationsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReservationsClient &&
|
ReservationsClient(std::shared_ptr< ReservationsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ReservationsConnection >
|
opts |
Options
|
Operators
operator=(ReservationsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReservationsClient const &
|
Returns | |
---|---|
Type | Description |
ReservationsClient & |
operator=(ReservationsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ReservationsClient &&
|
Returns | |
---|---|
Type | Description |
ReservationsClient & |
Functions
AggregatedListReservations(std::string const &, Options)
Retrieves an aggregated list of reservations.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/aggregatedList
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::ReservationsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListReservations(google::cloud::cpp::compute::reservations::v1::AggregatedListReservationsRequest, Options)
Retrieves an aggregated list of reservations.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::AggregatedListReservationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< std::pair< std::string, google::cloud::cpp::compute::v1::ReservationsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteReservation(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified reservation.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
reservation |
std::string const &
Name of the reservation to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteReservation(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified reservation.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
reservation |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteReservation(google::cloud::cpp::compute::reservations::v1::DeleteReservationRequest const &, Options)
Deletes the specified reservation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::DeleteReservationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
DeleteReservation(NoAwaitTag, google::cloud::cpp::compute::reservations::v1::DeleteReservationRequest const &, Options)
Deletes the specified reservation.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::reservations::v1::DeleteReservationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteReservation(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified reservation.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetReservation(std::string const &, std::string const &, std::string const &, Options)
Retrieves information about the specified reservation.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
reservation |
std::string const &
Name of the reservation to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Reservation > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Reservation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetReservation(google::cloud::cpp::compute::reservations::v1::GetReservationRequest const &, Options)
Retrieves information about the specified reservation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::GetReservationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Reservation > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Reservation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(std::string const &, std::string const &, std::string const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/getIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::cloud::cpp::compute::reservations::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/getIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertReservation(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Reservation const &, Options)
Creates a new reservation.
For more information, read Reserving zonal resources. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/insert
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
reservation_resource |
google::cloud::cpp::compute::v1::Reservation const &
The Reservation for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertReservation(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Reservation const &, Options)
Creates a new reservation.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
reservation_resource |
google::cloud::cpp::compute::v1::Reservation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertReservation(google::cloud::cpp::compute::reservations::v1::InsertReservationRequest const &, Options)
Creates a new reservation.
For more information, read Reserving zonal resources. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/insert
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::InsertReservationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
InsertReservation(NoAwaitTag, google::cloud::cpp::compute::reservations::v1::InsertReservationRequest const &, Options)
Creates a new reservation.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::reservations::v1::InsertReservationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertReservation(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a new reservation.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListReservations(std::string const &, std::string const &, Options)
A list of all the reservations that have been configured for the specified project in specified zone.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::Reservation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListReservations(google::cloud::cpp::compute::reservations::v1::ListReservationsRequest, Options)
A list of all the reservations that have been configured for the specified project in specified zone.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::ListReservationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::Reservation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
Resize(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ReservationsResizeRequest const &, Options)
Resizes the reservation (applicable to standalone reservations only).
For more information, read Modifying reservations. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/resize
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
reservation |
std::string const &
Name of the reservation to update. |
reservations_resize_request_resource |
google::cloud::cpp::compute::v1::ReservationsResizeRequest const &
The ReservationsResizeRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
Resize(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ReservationsResizeRequest const &, Options)
Resizes the reservation (applicable to standalone reservations only).
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
reservation |
std::string const &
|
reservations_resize_request_resource |
google::cloud::cpp::compute::v1::ReservationsResizeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Resize(google::cloud::cpp::compute::reservations::v1::ResizeRequest const &, Options)
Resizes the reservation (applicable to standalone reservations only).
For more information, read Modifying reservations. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/resize
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::ResizeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
Resize(NoAwaitTag, google::cloud::cpp::compute::reservations::v1::ResizeRequest const &, Options)
Resizes the reservation (applicable to standalone reservations only).
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::reservations::v1::ResizeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
Resize(google::cloud::cpp::compute::v1::Operation const &, Options)
Resizes the reservation (applicable to standalone reservations only).
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
SetIamPolicy(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ZoneSetPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/setIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
zone_set_policy_request_resource |
google::cloud::cpp::compute::v1::ZoneSetPolicyRequest const &
The ZoneSetPolicyRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::cloud::cpp::compute::reservations::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/reservations/setIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::SetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TestPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
test_permissions_request_resource |
google::cloud::cpp::compute::v1::TestPermissionsRequest const &
The TestPermissionsRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::cloud::cpp::compute::reservations::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::TestIamPermissionsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateReservation(std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Reservation const &, Options)
Update share settings of the reservation.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
reservation |
std::string const &
Name of the reservation to update. |
update_mask |
std::string const &
Update_mask indicates fields to be updated as part of this request. |
reservation_resource |
google::cloud::cpp::compute::v1::Reservation const &
The Reservation for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
UpdateReservation(NoAwaitTag, std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Reservation const &, Options)
Update share settings of the reservation.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
project |
std::string const &
|
zone |
std::string const &
|
reservation |
std::string const &
|
update_mask |
std::string const &
|
reservation_resource |
google::cloud::cpp::compute::v1::Reservation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateReservation(google::cloud::cpp::compute::reservations::v1::UpdateReservationRequest const &, Options)
Update share settings of the reservation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::reservations::v1::UpdateReservationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
A |
UpdateReservation(NoAwaitTag, google::cloud::cpp::compute::reservations::v1::UpdateReservationRequest const &, Options)
Update share settings of the reservation.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::reservations::v1::UpdateReservationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateReservation(google::cloud::cpp::compute::v1::Operation const &, Options)
Update share settings of the reservation.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |