Compute Engine v1 API - Class StoragePoolsClientImpl (2.16.0)

public sealed class StoragePoolsClientImpl : StoragePoolsClient

Reference documentation and code samples for the Compute Engine v1 API class StoragePoolsClientImpl.

StoragePools client wrapper implementation, for convenient use.

Inheritance

object > StoragePoolsClient > StoragePoolsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The StoragePools API.

Constructors

StoragePoolsClientImpl(StoragePoolsClient, StoragePoolsSettings, ILogger)

public StoragePoolsClientImpl(StoragePools.StoragePoolsClient grpcClient, StoragePoolsSettings settings, ILogger logger)

Constructs a client wrapper for the StoragePools service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient StoragePoolsStoragePoolsClient

The underlying gRPC client.
settings StoragePoolsSettings

The base StoragePoolsSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override StoragePools.StoragePoolsClient GrpcClient { get; }

The underlying gRPC StoragePools client

Property Value
Type Description
StoragePoolsStoragePoolsClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type Description
OperationsClient
Overrides

Methods

AggregatedList(AggregatedListStoragePoolsRequest, CallSettings)

public override PagedEnumerable<StoragePoolAggregatedList, KeyValuePair<string, StoragePoolsScopedList>> AggregatedList(AggregatedListStoragePoolsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListStoragePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableStoragePoolAggregatedListKeyValuePairstringStoragePoolsScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.
Overrides

AggregatedListAsync(AggregatedListStoragePoolsRequest, CallSettings)

public override PagedAsyncEnumerable<StoragePoolAggregatedList, KeyValuePair<string, StoragePoolsScopedList>> AggregatedListAsync(AggregatedListStoragePoolsRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListStoragePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableStoragePoolAggregatedListKeyValuePairstringStoragePoolsScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.
Overrides

Delete(DeleteStoragePoolRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteStoragePoolRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DeleteStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeleteAsync(DeleteStoragePoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteStoragePoolRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DeleteStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Get(GetStoragePoolRequest, CallSettings)

public override StoragePool Get(GetStoragePoolRequest request, CallSettings callSettings = null)

Returns a specified storage pool. Gets a list of available storage pools by making a list() request.

Parameters
Name Description
request GetStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
StoragePool

The RPC response.
Overrides

GetAsync(GetStoragePoolRequest, CallSettings)

public override Task<StoragePool> GetAsync(GetStoragePoolRequest request, CallSettings callSettings = null)

Returns a specified storage pool. Gets a list of available storage pools by making a list() request.

Parameters
Name Description
request GetStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskStoragePool

A Task containing the RPC response.
Overrides

GetIamPolicy(GetIamPolicyStoragePoolRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyStoragePoolRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

GetIamPolicyAsync(GetIamPolicyStoragePoolRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyStoragePoolRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
Name Description
request GetIamPolicyStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

Insert(InsertStoragePoolRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertStoragePoolRequest request, CallSettings callSettings = null)

Creates a storage pool in the specified project using the data in the request.

Parameters
Name Description
request InsertStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

InsertAsync(InsertStoragePoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertStoragePoolRequest request, CallSettings callSettings = null)

Creates a storage pool in the specified project using the data in the request.

Parameters
Name Description
request InsertStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

List(ListStoragePoolsRequest, CallSettings)

public override PagedEnumerable<StoragePoolList, StoragePool> List(ListStoragePoolsRequest request, CallSettings callSettings = null)

Retrieves a list of storage pools contained within the specified zone.

Parameters
Name Description
request ListStoragePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableStoragePoolListStoragePool

A pageable sequence of StoragePool resources.
Overrides

ListAsync(ListStoragePoolsRequest, CallSettings)

public override PagedAsyncEnumerable<StoragePoolList, StoragePool> ListAsync(ListStoragePoolsRequest request, CallSettings callSettings = null)

Retrieves a list of storage pools contained within the specified zone.

Parameters
Name Description
request ListStoragePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableStoragePoolListStoragePool

A pageable asynchronous sequence of StoragePool resources.
Overrides

ListDisks(ListDisksStoragePoolsRequest, CallSettings)

public override PagedEnumerable<StoragePoolListDisks, StoragePoolDisk> ListDisks(ListDisksStoragePoolsRequest request, CallSettings callSettings = null)

Lists the disks in a specified storage pool.

Parameters
Name Description
request ListDisksStoragePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableStoragePoolListDisksStoragePoolDisk

A pageable sequence of StoragePoolDisk resources.
Overrides

ListDisksAsync(ListDisksStoragePoolsRequest, CallSettings)

public override PagedAsyncEnumerable<StoragePoolListDisks, StoragePoolDisk> ListDisksAsync(ListDisksStoragePoolsRequest request, CallSettings callSettings = null)

Lists the disks in a specified storage pool.

Parameters
Name Description
request ListDisksStoragePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableStoragePoolListDisksStoragePoolDisk

A pageable asynchronous sequence of StoragePoolDisk resources.
Overrides

SetIamPolicy(SetIamPolicyStoragePoolRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyStoragePoolRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

SetIamPolicyAsync(SetIamPolicyStoragePoolRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyStoragePoolRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
Name Description
request SetIamPolicyStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

TestIamPermissions(TestIamPermissionsStoragePoolRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsStoragePoolRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TestPermissionsResponse

The RPC response.
Overrides

TestIamPermissionsAsync(TestIamPermissionsStoragePoolRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsStoragePoolRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestPermissionsResponse

A Task containing the RPC response.
Overrides

Update(UpdateStoragePoolRequest, CallSettings)

public override Operation<Operation, Operation> Update(UpdateStoragePoolRequest request, CallSettings callSettings = null)

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: size_tb and provisioned_iops.

Parameters
Name Description
request UpdateStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

UpdateAsync(UpdateStoragePoolRequest, CallSettings)

public override Task<Operation<Operation, Operation>> UpdateAsync(UpdateStoragePoolRequest request, CallSettings callSettings = null)

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: size_tb and provisioned_iops.

Parameters
Name Description
request UpdateStoragePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides