Service for the storagePools resource.
https://cloud.google.com/compute/docs/reference/rest/v1/storagePools
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
StoragePoolsClient(StoragePoolsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
StoragePoolsClient const &
|
StoragePoolsClient(StoragePoolsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
StoragePoolsClient &&
|
StoragePoolsClient(std::shared_ptr< StoragePoolsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< StoragePoolsConnection >
|
opts |
Options
|
Operators
operator=(StoragePoolsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
StoragePoolsClient const &
|
Returns | |
---|---|
Type | Description |
StoragePoolsClient & |
operator=(StoragePoolsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
StoragePoolsClient &&
|
Returns | |
---|---|
Type | Description |
StoragePoolsClient & |
Functions
AggregatedListStoragePools(std::string const &, Options)
Retrieves an aggregated list of storage pools.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/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::StoragePoolsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListStoragePools(google::cloud::cpp::compute::storage_pools::v1::AggregatedListStoragePoolsRequest, Options)
Retrieves an aggregated list of storage pools.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::AggregatedListStoragePoolsRequest
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::StoragePoolsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteStoragePool(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified storage pool.
Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/delete
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
storage_pool |
std::string const &
Name of the storage pool 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 |
DeleteStoragePool(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified storage pool.
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 &
|
storage_pool |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteStoragePool(google::cloud::cpp::compute::storage_pools::v1::DeleteStoragePoolRequest const &, Options)
Deletes the specified storage pool.
Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/delete
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::DeleteStoragePoolRequest 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 |
DeleteStoragePool(NoAwaitTag, google::cloud::cpp::compute::storage_pools::v1::DeleteStoragePoolRequest const &, Options)
Deletes the specified storage pool.
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::storage_pools::v1::DeleteStoragePoolRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteStoragePool(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified storage pool.
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 > > |
GetStoragePool(std::string const &, std::string const &, std::string const &, Options)
Returns a specified storage pool.
Gets a list of available storage pools by making a list() request. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/get
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
storage_pool |
std::string const &
Name of the storage pool 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::StoragePool > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.StoragePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetStoragePool(google::cloud::cpp::compute::storage_pools::v1::GetStoragePoolRequest const &, Options)
Returns a specified storage pool.
Gets a list of available storage pools by making a list() request. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/get
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::GetStoragePoolRequest 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::StoragePool > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.StoragePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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/storagePools/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 |
GetIamPolicy(google::cloud::cpp::compute::storage_pools::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/storagePools/getIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::GetIamPolicyRequest 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::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 |
InsertStoragePool(std::string const &, std::string const &, google::cloud::cpp::compute::v1::StoragePool const &, Options)
Creates a storage pool in the specified project using the data in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
storage_pool_resource |
google::cloud::cpp::compute::v1::StoragePool const &
The StoragePool 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 |
InsertStoragePool(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::StoragePool const &, Options)
Creates a storage pool in the specified project using the data 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 &
|
zone |
std::string const &
|
storage_pool_resource |
google::cloud::cpp::compute::v1::StoragePool const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertStoragePool(google::cloud::cpp::compute::storage_pools::v1::InsertStoragePoolRequest const &, Options)
Creates a storage pool in the specified project using the data in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::InsertStoragePoolRequest 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 |
InsertStoragePool(NoAwaitTag, google::cloud::cpp::compute::storage_pools::v1::InsertStoragePoolRequest const &, Options)
Creates a storage pool in the specified project using the data 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::storage_pools::v1::InsertStoragePoolRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertStoragePool(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a storage pool in the specified project using the data 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 > > |
ListStoragePools(std::string const &, std::string const &, Options)
Retrieves a list of storage pools contained within the specified zone.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The 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::StoragePool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListStoragePools(google::cloud::cpp::compute::storage_pools::v1::ListStoragePoolsRequest, Options)
Retrieves a list of storage pools contained within the specified zone.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::ListStoragePoolsRequest
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::StoragePool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDisks(std::string const &, std::string const &, std::string const &, Options)
Lists the disks in a specified storage pool.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
storage_pool |
std::string const &
Name of the storage pool to list disks of. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cpp::compute::v1::StoragePoolDisk > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDisks(google::cloud::cpp::compute::storage_pools::v1::ListDisksRequest, Options)
Lists the disks in a specified storage pool.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::ListDisksRequest
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::StoragePoolDisk > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
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/storagePools/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 |
SetIamPolicy(google::cloud::cpp::compute::storage_pools::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/storagePools/setIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::SetIamPolicyRequest 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::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 |
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.
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 |
TestIamPermissions(google::cloud::cpp::compute::storage_pools::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::TestIamPermissionsRequest 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::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 |
UpdateStoragePool(std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::StoragePool const &, Options)
Updates the specified storagePool with the data included in the request.
The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/update
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
zone |
std::string const &
The name of the zone for this request. |
storage_pool |
std::string const &
The storagePool name for this request. |
update_mask |
std::string const &
update_mask indicates fields to be updated as part of this request. |
storage_pool_resource |
google::cloud::cpp::compute::v1::StoragePool const &
The StoragePool 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 |
UpdateStoragePool(NoAwaitTag, std::string const &, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::StoragePool const &, Options)
Updates the specified storagePool 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 &
|
zone |
std::string const &
|
storage_pool |
std::string const &
|
update_mask |
std::string const &
|
storage_pool_resource |
google::cloud::cpp::compute::v1::StoragePool const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateStoragePool(google::cloud::cpp::compute::storage_pools::v1::UpdateStoragePoolRequest const &, Options)
Updates the specified storagePool with the data included in the request.
The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput. https://cloud.google.com/compute/docs/reference/rest/v1/storagePools/update
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::storage_pools::v1::UpdateStoragePoolRequest 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 |
UpdateStoragePool(NoAwaitTag, google::cloud::cpp::compute::storage_pools::v1::UpdateStoragePoolRequest const &, Options)
Updates the specified storagePool 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::storage_pools::v1::UpdateStoragePoolRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
UpdateStoragePool(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified storagePool 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 > > |