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.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. 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 |
AggregatedListRegionCommitments(google::cloud::cpp::compute::region_commitments::v1::AggregatedListRegionCommitmentsRequest, Options)
Retrieves an aggregated list of commitments by region.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. 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 |
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 |
GetCommitment(std::string const &, std::string const &, std::string const &, Options)
Returns the specified commitment resource.
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 |
GetCommitment(google::cloud::cpp::compute::region_commitments::v1::GetCommitmentRequest const &, Options)
Returns the specified commitment resource.
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 |
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 |
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.
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 |
InsertCommitment(NoAwaitTag, 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.
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 &
|
region |
std::string const &
|
commitment_resource |
google::cloud::cpp::compute::v1::Commitment const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
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.
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 |
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 |
InsertCommitment(NoAwaitTag, google::cloud::cpp::compute::region_commitments::v1::InsertCommitmentRequest const &, Options)
Creates a commitment in the specified project using the data included in the request.
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::region_commitments::v1::InsertCommitmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertCommitment(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a commitment in the specified project using the data included in the request.
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 > > |
ListRegionCommitments(std::string const &, std::string const &, Options)
Retrieves a list of commitments contained within the specified region.
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 |
ListRegionCommitments(google::cloud::cpp::compute::region_commitments::v1::ListRegionCommitmentsRequest, Options)
Retrieves a list of commitments contained within the specified region.
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 |
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 |
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 |
UpdateCommitment(NoAwaitTag, 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.
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 &
|
region |
std::string const &
|
commitment |
std::string const &
|
update_mask |
std::string const &
|
commitment_resource |
google::cloud::cpp::compute::v1::Commitment const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
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 |
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 |
UpdateCommitment(NoAwaitTag, google::cloud::cpp::compute::region_commitments::v1::UpdateCommitmentRequest const &, Options)
Updates the specified commitment with the data included in the request.
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::region_commitments::v1::UpdateCommitmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateCommitment(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified commitment with the data included in the request.
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 > > |