Class FutureReservationsClient (2.30.0-rc)

Service for the futureReservations resource.

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

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

FutureReservationsClient(FutureReservationsClient const &)

Copy and move support

Parameter
Name Description
FutureReservationsClient const &

FutureReservationsClient(FutureReservationsClient &&)

Copy and move support

Parameter
Name Description
FutureReservationsClient &&

FutureReservationsClient(std::shared_ptr< FutureReservationsConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< FutureReservationsConnection >
opts Options

Operators

operator=(FutureReservationsClient const &)

Copy and move support

Parameter
Name Description
FutureReservationsClient const &
Returns
Type Description
FutureReservationsClient &

operator=(FutureReservationsClient &&)

Copy and move support

Parameter
Name Description
FutureReservationsClient &&
Returns
Type Description
FutureReservationsClient &

Functions

AggregatedListFutureReservations(std::string const &, Options)

Retrieves an aggregated list of future reservations.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/futureReservations/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::FutureReservationsScopedList > >

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.FutureReservationsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

AggregatedListFutureReservations(google::cloud::cpp::compute::future_reservations::v1::AggregatedListFutureReservationsRequest, Options)

Retrieves an aggregated list of future reservations.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. https://cloud.google.com/compute/docs/reference/rest/v1/futureReservations/aggregatedList

Parameters
Name Description
request google::cloud::cpp::compute::future_reservations::v1::AggregatedListFutureReservationsRequest

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.future_reservations.v1.AggregatedListFutureReservationsRequest. 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::FutureReservationsScopedList > >

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.FutureReservationsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Cancel the specified future reservation.

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

Name of the zone for this request. Name should conform to RFC1035.

future_reservation std::string const &

Name of the future reservation to retrieve. Name should conform to RFC1035.

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.

Cancel(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)

Cancel the specified future 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 &
future_reservation std::string const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

Cancel(google::cloud::cpp::compute::future_reservations::v1::CancelRequest const &, Options)

Cancel the specified future reservation.

Parameters
Name Description
request google::cloud::cpp::compute::future_reservations::v1::CancelRequest 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.future_reservations.v1.CancelRequest. 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.

Cancel(NoAwaitTag, google::cloud::cpp::compute::future_reservations::v1::CancelRequest const &, Options)

Cancel the specified future 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::future_reservations::v1::CancelRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

Cancel(google::cloud::cpp::compute::v1::Operation const &, Options)

Cancel the specified future 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 > >

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

Deletes the specified future reservation.

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

Name of the zone for this request. Name should conform to RFC1035.

future_reservation std::string const &

Name of the future reservation to retrieve. Name should conform to RFC1035.

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.

DeleteFutureReservation(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)

Deletes the specified future 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 &
future_reservation std::string const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

DeleteFutureReservation(google::cloud::cpp::compute::future_reservations::v1::DeleteFutureReservationRequest const &, Options)

Deletes the specified future reservation.

Parameters
Name Description
request google::cloud::cpp::compute::future_reservations::v1::DeleteFutureReservationRequest 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.future_reservations.v1.DeleteFutureReservationRequest. 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.

DeleteFutureReservation(NoAwaitTag, google::cloud::cpp::compute::future_reservations::v1::DeleteFutureReservationRequest const &, Options)

Deletes the specified future 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::future_reservations::v1::DeleteFutureReservationRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

DeleteFutureReservation(google::cloud::cpp::compute::v1::Operation const &, Options)

Deletes the specified future 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 > >

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

Retrieves information about the specified future reservation.

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

Name of the zone for this request. Name should conform to RFC1035.

future_reservation std::string const &

Name of the future reservation to retrieve. Name should conform to RFC1035.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::FutureReservation >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.FutureReservation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFutureReservation(google::cloud::cpp::compute::future_reservations::v1::GetFutureReservationRequest const &, Options)

Retrieves information about the specified future reservation.

Parameters
Name Description
request google::cloud::cpp::compute::future_reservations::v1::GetFutureReservationRequest 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.future_reservations.v1.GetFutureReservationRequest. 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::FutureReservation >

the result of the RPC. The response message type (google.cloud.cpp.compute.v1.FutureReservation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertFutureReservation(std::string const &, std::string const &, google::cloud::cpp::compute::v1::FutureReservation const &, Options)

Creates a new Future Reservation.

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

Name of the zone for this request. Name should conform to RFC1035.

future_reservation_resource google::cloud::cpp::compute::v1::FutureReservation const &

The FutureReservation 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.

InsertFutureReservation(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::FutureReservation const &, Options)

Creates a new Future 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 &
future_reservation_resource google::cloud::cpp::compute::v1::FutureReservation const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

InsertFutureReservation(google::cloud::cpp::compute::future_reservations::v1::InsertFutureReservationRequest const &, Options)

Creates a new Future Reservation.

Parameters
Name Description
request google::cloud::cpp::compute::future_reservations::v1::InsertFutureReservationRequest 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.future_reservations.v1.InsertFutureReservationRequest. 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.

InsertFutureReservation(NoAwaitTag, google::cloud::cpp::compute::future_reservations::v1::InsertFutureReservationRequest const &, Options)

Creates a new Future 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::future_reservations::v1::InsertFutureReservationRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

InsertFutureReservation(google::cloud::cpp::compute::v1::Operation const &, Options)

Creates a new Future 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 > >

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

A list of all the future 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. Name should conform to RFC1035.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::cpp::compute::v1::FutureReservation >

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.FutureReservation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFutureReservations(google::cloud::cpp::compute::future_reservations::v1::ListFutureReservationsRequest, Options)

A list of all the future reservations that have been configured for the specified project in specified zone.

Parameters
Name Description
request google::cloud::cpp::compute::future_reservations::v1::ListFutureReservationsRequest

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.future_reservations.v1.ListFutureReservationsRequest. 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::FutureReservation >

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.FutureReservation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateFutureReservation(std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::FutureReservation const &, Options)

Updates the specified future reservation.

Parameters
Name Description
project std::string const &

Project ID for this request.

zone std::string const &

Name of the zone for this request. Name should conform to RFC1035.

future_reservation std::string const &

Name of the reservation to update. Name should conform to RFC1035.

update_mask std::string const &

update_mask indicates fields to be updated as part of this request.

future_reservation_resource google::cloud::cpp::compute::v1::FutureReservation const &

The FutureReservation 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.

UpdateFutureReservation(NoAwaitTag, std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::FutureReservation const &, Options)

Updates the specified future 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 &
future_reservation std::string const &
update_mask std::string const &
future_reservation_resource google::cloud::cpp::compute::v1::FutureReservation const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

UpdateFutureReservation(google::cloud::cpp::compute::future_reservations::v1::UpdateFutureReservationRequest const &, Options)

Updates the specified future reservation.

Parameters
Name Description
request google::cloud::cpp::compute::future_reservations::v1::UpdateFutureReservationRequest 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.future_reservations.v1.UpdateFutureReservationRequest. 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.

UpdateFutureReservation(NoAwaitTag, google::cloud::cpp::compute::future_reservations::v1::UpdateFutureReservationRequest const &, Options)

Updates the specified future 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::future_reservations::v1::UpdateFutureReservationRequest const &
opts Options
Returns
Type Description
StatusOr< google::cloud::cpp::compute::v1::Operation >

UpdateFutureReservation(google::cloud::cpp::compute::v1::Operation const &, Options)

Updates the specified future 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 > >