Service for the zoneOperations resource.
https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations
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
ZoneOperationsClient(ZoneOperationsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ZoneOperationsClient const &
|
ZoneOperationsClient(ZoneOperationsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ZoneOperationsClient &&
|
ZoneOperationsClient(std::shared_ptr< ZoneOperationsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ZoneOperationsConnection >
|
opts |
Options
|
Operators
operator=(ZoneOperationsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ZoneOperationsClient const &
|
Returns | |
---|---|
Type | Description |
ZoneOperationsClient & |
operator=(ZoneOperationsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ZoneOperationsClient &&
|
Returns | |
---|---|
Type | Description |
ZoneOperationsClient & |
Functions
DeleteOperation(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified zone-specific Operations resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
operation |
std::string const &
Name of the Operations resource to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status | a |
DeleteOperation(google::cloud::cpp::compute::zone_operations::v1::DeleteOperationRequest const &, Options)
Deletes the specified zone-specific Operations resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::zone_operations::v1::DeleteOperationRequest 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 |
Status | a |
GetOperation(std::string const &, std::string const &, std::string const &, Options)
Retrieves the specified zone-specific Operations resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
operation |
std::string const &
Name of the Operations resource 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::Operation > | the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::cloud::cpp::compute::zone_operations::v1::GetOperationRequest const &, Options)
Retrieves the specified zone-specific Operations resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::zone_operations::v1::GetOperationRequest 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::Operation > | the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListZoneOperations(std::string const &, std::string const &, Options)
Retrieves a list of Operation resources contained within the specified zone.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::Operation > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListZoneOperations(google::cloud::cpp::compute::zone_operations::v1::ListZoneOperationsRequest, Options)
Retrieves a list of Operation resources contained within the specified zone.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::zone_operations::v1::ListZoneOperationsRequest
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::Operation > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
Wait(std::string const &, std::string const &, std::string const &, Options)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource.
This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
. https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations/wait
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
Name of the zone for this request. |
operation |
std::string const &
Name of the Operations resource 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::Operation > | the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
Wait(google::cloud::cpp::compute::zone_operations::v1::WaitRequest const &, Options)
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource.
This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
. https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations/wait
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::zone_operations::v1::WaitRequest 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::Operation > | the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |