Class ReservationsClient (2.16.0)

Version 2.16.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

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.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.ReservationsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

AggregatedListReservations(google::cloud::cpp::compute::reservations::v1::AggregatedListReservationsRequest, Options)

Retrieves an aggregated list of reservations.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.AggregatedListReservationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.ReservationsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteReservation(std::string const &, std::string const &, std::string const &, Options)

Deletes the specified reservation.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/delete

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteReservation(google::cloud::cpp::compute::reservations::v1::DeleteReservationRequest const &, Options)

Deletes the specified reservation.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/delete

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.DeleteReservationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetReservation(std::string const &, std::string const &, std::string const &, Options)

Retrieves information about the specified reservation.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/get

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 StatusOr contains the error details.

GetReservation(google::cloud::cpp::compute::reservations::v1::GetReservationRequest const &, Options)

Retrieves information about the specified reservation.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/get

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.GetReservationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.InsertReservationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/list

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.Reservation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/list

Parameters
Name	Description
request	google::cloud::cpp::compute::reservations::v1::ListReservationsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.ListReservationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.Reservation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.ResizeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/testIamPermissions

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 StatusOr contains the error details.

TestIamPermissions(google::cloud::cpp::compute::reservations::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/testIamPermissions

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/update

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateReservation(google::cloud::cpp::compute::reservations::v1::UpdateReservationRequest const &, Options)

Update share settings of the reservation.

https://cloud.google.com/compute/docs/reference/rest/v1/reservations/update

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.reservations.v1.UpdateReservationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.