Class RegionCommitmentsClient (2.20.0)

Version 2.20.0

• 2.25.0-rc (latest)
• 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 regionCommitments resource.

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

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

RegionCommitmentsClient(RegionCommitmentsClient const &)

Copy and move support

Parameter
Name	Description
	RegionCommitmentsClient const &

RegionCommitmentsClient(RegionCommitmentsClient &&)

Copy and move support

Parameter
Name	Description
	RegionCommitmentsClient &&

RegionCommitmentsClient(std::shared_ptr< RegionCommitmentsConnection >, Options)

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

Operators

operator=(RegionCommitmentsClient const &)

Copy and move support

Parameter
Name	Description
	RegionCommitmentsClient const &

Returns
Type	Description
RegionCommitmentsClient &

operator=(RegionCommitmentsClient &&)

Copy and move support

Parameter
Name	Description
	RegionCommitmentsClient &&

Returns
Type	Description
RegionCommitmentsClient &

Functions

AggregatedListRegionCommitments(std::string const &, Options)

Retrieves an aggregated list of commitments by region.

https://cloud.google.com/compute/docs/reference/rest/v1/regionCommitments/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::CommitmentsScopedList > >	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.CommitmentsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

AggregatedListRegionCommitments(google::cloud::cpp::compute::region_commitments::v1::AggregatedListRegionCommitmentsRequest, Options)

Retrieves an aggregated list of commitments by region.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::region_commitments::v1::AggregatedListRegionCommitmentsRequest 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.region_commitments.v1.AggregatedListRegionCommitmentsRequest. 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::CommitmentsScopedList > >	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.CommitmentsScopedList, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Returns the specified commitment resource.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
commitment	std::string const & Name of the commitment to return.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetCommitment(google::cloud::cpp::compute::region_commitments::v1::GetCommitmentRequest const &, Options)

Returns the specified commitment resource.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::region_commitments::v1::GetCommitmentRequest 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.region_commitments.v1.GetCommitmentRequest. 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::Commitment >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Commitment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertCommitment(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Commitment const &, Options)

Creates a commitment in the specified project using the data included in the request.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
commitment_resource	google::cloud::cpp::compute::v1::Commitment const & The Commitment 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.

InsertCommitment(google::cloud::cpp::compute::region_commitments::v1::InsertCommitmentRequest const &, Options)

Creates a commitment in the specified project using the data included in the request.

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

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

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

Retrieves a list of commitments contained within the specified region.

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

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region 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::Commitment >	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.Commitment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRegionCommitments(google::cloud::cpp::compute::region_commitments::v1::ListRegionCommitmentsRequest, Options)

Retrieves a list of commitments contained within the specified region.

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

Parameters
Name	Description
request	google::cloud::cpp::compute::region_commitments::v1::ListRegionCommitmentsRequest 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.region_commitments.v1.ListRegionCommitmentsRequest. 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::Commitment >	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.Commitment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateCommitment(std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::Commitment const &, Options)

Updates the specified commitment with the data included in the request.

Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. https://cloud.google.com/compute/docs/reference/rest/v1/regionCommitments/update

Parameters
Name	Description
project	std::string const & Project ID for this request.
region	std::string const & Name of the region for this request.
commitment	std::string const & Name of the commitment for which auto renew is being updated.
update_mask	std::string const & update_mask indicates fields to be updated as part of this request.
commitment_resource	google::cloud::cpp::compute::v1::Commitment const & The Commitment 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.

UpdateCommitment(google::cloud::cpp::compute::region_commitments::v1::UpdateCommitmentRequest const &, Options)

Updates the specified commitment with the data included in the request.

Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. https://cloud.google.com/compute/docs/reference/rest/v1/regionCommitments/update

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