Cloud Storage v2 API - Class StorageControlClientImpl (1.0.0-beta04)

public sealed class StorageControlClientImpl : StorageControlClient

Reference documentation and code samples for the Cloud Storage v2 API class StorageControlClientImpl.

StorageControl client wrapper implementation, for convenient use.

Inheritance

object > StorageControlClient > StorageControlClientImpl

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Remarks

StorageControl service includes selected control plane operations.

Constructors

StorageControlClientImpl(StorageControlClient, StorageControlSettings, ILogger)

public StorageControlClientImpl(StorageControl.StorageControlClient grpcClient, StorageControlSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient StorageControlStorageControlClient

The underlying gRPC client.
settings StorageControlSettings

The base StorageControlSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override StorageControl.StorageControlClient GrpcClient { get; }

The underlying gRPC StorageControl client

Property Value
Type Description
StorageControlStorageControlClient
Overrides

RenameFolderOperationsClient

public override OperationsClient RenameFolderOperationsClient { get; }

The long-running operations client for RenameFolder.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateFolder(CreateFolderRequest, CallSettings)

public override Folder CreateFolder(CreateFolderRequest request, CallSettings callSettings = null)

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request CreateFolderRequest

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
Folder

The RPC response.
Overrides

CreateFolderAsync(CreateFolderRequest, CallSettings)

public override Task<Folder> CreateFolderAsync(CreateFolderRequest request, CallSettings callSettings = null)

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request CreateFolderRequest

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
TaskFolder

A Task containing the RPC response.
Overrides

CreateManagedFolder(CreateManagedFolderRequest, CallSettings)

public override ManagedFolder CreateManagedFolder(CreateManagedFolderRequest request, CallSettings callSettings = null)

Creates a new managed folder.

Parameters
Name Description
request CreateManagedFolderRequest

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
ManagedFolder

The RPC response.
Overrides

CreateManagedFolderAsync(CreateManagedFolderRequest, CallSettings)

public override Task<ManagedFolder> CreateManagedFolderAsync(CreateManagedFolderRequest request, CallSettings callSettings = null)

Creates a new managed folder.

Parameters
Name Description
request CreateManagedFolderRequest

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
TaskManagedFolder

A Task containing the RPC response.
Overrides

DeleteFolder(DeleteFolderRequest, CallSettings)

public override void DeleteFolder(DeleteFolderRequest request, CallSettings callSettings = null)

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request DeleteFolderRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteFolderAsync(DeleteFolderRequest, CallSettings)

public override Task DeleteFolderAsync(DeleteFolderRequest request, CallSettings callSettings = null)

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request DeleteFolderRequest

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
Task

A Task containing the RPC response.
Overrides

DeleteManagedFolder(DeleteManagedFolderRequest, CallSettings)

public override void DeleteManagedFolder(DeleteManagedFolderRequest request, CallSettings callSettings = null)

Permanently deletes an empty managed folder.

Parameters
Name Description
request DeleteManagedFolderRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteManagedFolderAsync(DeleteManagedFolderRequest, CallSettings)

public override Task DeleteManagedFolderAsync(DeleteManagedFolderRequest request, CallSettings callSettings = null)

Permanently deletes an empty managed folder.

Parameters
Name Description
request DeleteManagedFolderRequest

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
Task

A Task containing the RPC response.
Overrides

GetFolder(GetFolderRequest, CallSettings)

public override Folder GetFolder(GetFolderRequest request, CallSettings callSettings = null)

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request GetFolderRequest

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
Folder

The RPC response.
Overrides

GetFolderAsync(GetFolderRequest, CallSettings)

public override Task<Folder> GetFolderAsync(GetFolderRequest request, CallSettings callSettings = null)

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request GetFolderRequest

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
TaskFolder

A Task containing the RPC response.
Overrides

GetManagedFolder(GetManagedFolderRequest, CallSettings)

public override ManagedFolder GetManagedFolder(GetManagedFolderRequest request, CallSettings callSettings = null)

Returns metadata for the specified managed folder.

Parameters
Name Description
request GetManagedFolderRequest

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
ManagedFolder

The RPC response.
Overrides

GetManagedFolderAsync(GetManagedFolderRequest, CallSettings)

public override Task<ManagedFolder> GetManagedFolderAsync(GetManagedFolderRequest request, CallSettings callSettings = null)

Returns metadata for the specified managed folder.

Parameters
Name Description
request GetManagedFolderRequest

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
TaskManagedFolder

A Task containing the RPC response.
Overrides

GetStorageLayout(GetStorageLayoutRequest, CallSettings)

public override StorageLayout GetStorageLayout(GetStorageLayoutRequest request, CallSettings callSettings = null)

Returns the storage layout configuration for a given bucket.

Parameters
Name Description
request GetStorageLayoutRequest

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
StorageLayout

The RPC response.
Overrides

GetStorageLayoutAsync(GetStorageLayoutRequest, CallSettings)

public override Task<StorageLayout> GetStorageLayoutAsync(GetStorageLayoutRequest request, CallSettings callSettings = null)

Returns the storage layout configuration for a given bucket.

Parameters
Name Description
request GetStorageLayoutRequest

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
TaskStorageLayout

A Task containing the RPC response.
Overrides

ListFolders(ListFoldersRequest, CallSettings)

public override PagedEnumerable<ListFoldersResponse, Folder> ListFolders(ListFoldersRequest request, CallSettings callSettings = null)

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request ListFoldersRequest

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
PagedEnumerableListFoldersResponseFolder

A pageable sequence of Folder resources.
Overrides

ListFoldersAsync(ListFoldersRequest, CallSettings)

public override PagedAsyncEnumerable<ListFoldersResponse, Folder> ListFoldersAsync(ListFoldersRequest request, CallSettings callSettings = null)

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request ListFoldersRequest

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
PagedAsyncEnumerableListFoldersResponseFolder

A pageable asynchronous sequence of Folder resources.
Overrides

ListManagedFolders(ListManagedFoldersRequest, CallSettings)

public override PagedEnumerable<ListManagedFoldersResponse, ManagedFolder> ListManagedFolders(ListManagedFoldersRequest request, CallSettings callSettings = null)

Retrieves a list of managed folders for a given bucket.

Parameters
Name Description
request ListManagedFoldersRequest

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
PagedEnumerableListManagedFoldersResponseManagedFolder

A pageable sequence of ManagedFolder resources.
Overrides

ListManagedFoldersAsync(ListManagedFoldersRequest, CallSettings)

public override PagedAsyncEnumerable<ListManagedFoldersResponse, ManagedFolder> ListManagedFoldersAsync(ListManagedFoldersRequest request, CallSettings callSettings = null)

Retrieves a list of managed folders for a given bucket.

Parameters
Name Description
request ListManagedFoldersRequest

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
PagedAsyncEnumerableListManagedFoldersResponseManagedFolder

A pageable asynchronous sequence of ManagedFolder resources.
Overrides

RenameFolder(RenameFolderRequest, CallSettings)

public override Operation<Folder, RenameFolderMetadata> RenameFolder(RenameFolderRequest request, CallSettings callSettings = null)

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request RenameFolderRequest

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
OperationFolderRenameFolderMetadata

The RPC response.
Overrides

RenameFolderAsync(RenameFolderRequest, CallSettings)

public override Task<Operation<Folder, RenameFolderMetadata>> RenameFolderAsync(RenameFolderRequest request, CallSettings callSettings = null)

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes. Hierarchical namespace buckets are in allowlist preview.

Parameters
Name Description
request RenameFolderRequest

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
TaskOperationFolderRenameFolderMetadata

A Task containing the RPC response.
Overrides