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

Version 1.0.0-beta01

• 1.1.0 (latest)
• 1.0.1

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

Inherited Members

StorageControlClient.DefaultEndpoint

StorageControlClient.DefaultScopes

StorageControlClient.ServiceMetadata

StorageControlClient.CreateAsync(CancellationToken)

StorageControlClient.Create()

StorageControlClient.ShutdownDefaultChannelsAsync()

StorageControlClient.CreateFolderAsync(CreateFolderRequest, CancellationToken)

StorageControlClient.CreateFolder(string, Folder, string, CallSettings)

StorageControlClient.CreateFolderAsync(string, Folder, string, CallSettings)

StorageControlClient.CreateFolderAsync(string, Folder, string, CancellationToken)

StorageControlClient.CreateFolder(BucketName, Folder, string, CallSettings)

StorageControlClient.CreateFolderAsync(BucketName, Folder, string, CallSettings)

StorageControlClient.CreateFolderAsync(BucketName, Folder, string, CancellationToken)

StorageControlClient.DeleteFolderAsync(DeleteFolderRequest, CancellationToken)

StorageControlClient.DeleteFolder(string, CallSettings)

StorageControlClient.DeleteFolderAsync(string, CallSettings)

StorageControlClient.DeleteFolderAsync(string, CancellationToken)

StorageControlClient.DeleteFolder(FolderName, CallSettings)

StorageControlClient.DeleteFolderAsync(FolderName, CallSettings)

StorageControlClient.DeleteFolderAsync(FolderName, CancellationToken)

StorageControlClient.GetFolderAsync(GetFolderRequest, CancellationToken)

StorageControlClient.GetFolder(string, CallSettings)

StorageControlClient.GetFolderAsync(string, CallSettings)

StorageControlClient.GetFolderAsync(string, CancellationToken)

StorageControlClient.GetFolder(FolderName, CallSettings)

StorageControlClient.GetFolderAsync(FolderName, CallSettings)

StorageControlClient.GetFolderAsync(FolderName, CancellationToken)

StorageControlClient.ListFolders(string, string, int?, CallSettings)

StorageControlClient.ListFoldersAsync(string, string, int?, CallSettings)

StorageControlClient.ListFolders(BucketName, string, int?, CallSettings)

StorageControlClient.ListFoldersAsync(BucketName, string, int?, CallSettings)

StorageControlClient.RenameFolderAsync(RenameFolderRequest, CancellationToken)

StorageControlClient.PollOnceRenameFolder(string, CallSettings)

StorageControlClient.PollOnceRenameFolderAsync(string, CallSettings)

StorageControlClient.RenameFolder(string, string, CallSettings)

StorageControlClient.RenameFolderAsync(string, string, CallSettings)

StorageControlClient.RenameFolderAsync(string, string, CancellationToken)

StorageControlClient.RenameFolder(FolderName, string, CallSettings)

StorageControlClient.RenameFolderAsync(FolderName, string, CallSettings)

StorageControlClient.RenameFolderAsync(FolderName, string, CancellationToken)

StorageControlClient.GetStorageLayoutAsync(GetStorageLayoutRequest, CancellationToken)

StorageControlClient.GetStorageLayout(string, CallSettings)

StorageControlClient.GetStorageLayoutAsync(string, CallSettings)

StorageControlClient.GetStorageLayoutAsync(string, CancellationToken)

StorageControlClient.GetStorageLayout(StorageLayoutName, CallSettings)

StorageControlClient.GetStorageLayoutAsync(StorageLayoutName, CallSettings)

StorageControlClient.GetStorageLayoutAsync(StorageLayoutName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

StorageControlClient.GrpcClient

RenameFolderOperationsClient

public override OperationsClient RenameFolderOperationsClient { get; }

The long-running operations client for RenameFolder.

Property Value
Type	Description
OperationsClient

Overrides

StorageControlClient.RenameFolderOperationsClient

Methods

CreateFolder(CreateFolderRequest, CallSettings)

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

Creates a new folder.

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

StorageControlClient.CreateFolder(CreateFolderRequest, CallSettings)

CreateFolderAsync(CreateFolderRequest, CallSettings)

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

Creates a new folder.

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

StorageControlClient.CreateFolderAsync(CreateFolderRequest, CallSettings)

DeleteFolder(DeleteFolderRequest, CallSettings)

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

Permanently deletes an empty folder.

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

StorageControlClient.DeleteFolder(DeleteFolderRequest, CallSettings)

DeleteFolderAsync(DeleteFolderRequest, CallSettings)

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

Permanently deletes an empty folder.

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

StorageControlClient.DeleteFolderAsync(DeleteFolderRequest, CallSettings)

GetFolder(GetFolderRequest, CallSettings)

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

Returns metadata for the specified folder.

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

StorageControlClient.GetFolder(GetFolderRequest, CallSettings)

GetFolderAsync(GetFolderRequest, CallSettings)

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

Returns metadata for the specified folder.

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

StorageControlClient.GetFolderAsync(GetFolderRequest, CallSettings)

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

StorageControlClient.GetStorageLayout(GetStorageLayoutRequest, CallSettings)

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

StorageControlClient.GetStorageLayoutAsync(GetStorageLayoutRequest, CallSettings)

ListFolders(ListFoldersRequest, CallSettings)

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

Retrieves a list of folders for a given bucket.

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

StorageControlClient.ListFolders(ListFoldersRequest, CallSettings)

ListFoldersAsync(ListFoldersRequest, CallSettings)

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

Retrieves a list of folders for a given bucket.

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

StorageControlClient.ListFoldersAsync(ListFoldersRequest, CallSettings)

RenameFolder(RenameFolderRequest, CallSettings)

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

Renames a source folder to a destination folder. During a rename, the source and destination folders are locked until the long running operation completes.

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

StorageControlClient.RenameFolder(RenameFolderRequest, CallSettings)

RenameFolderAsync(RenameFolderRequest, CallSettings)

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

Renames a source folder to a destination folder. During a rename, the source and destination folders are locked until the long running operation completes.

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

StorageControlClient.RenameFolderAsync(RenameFolderRequest, CallSettings)