Cloud Storage v2 API - Class StorageControl.StorageControlClient (1.0.0-beta02)

Version 1.0.0-beta02

• 1.1.0 (latest)
• 1.0.1

public class StorageControl.StorageControlClient : ClientBase<StorageControl.StorageControlClient>

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

Client for StorageControl

Inheritance

object > ClientBase > ClientBaseStorageControlStorageControlClient > StorageControl.StorageControlClient

Inherited Members

ClientBase<StorageControl.StorageControlClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

StorageControlClient()

protected StorageControlClient()

Protected parameterless constructor to allow creation of test doubles.

StorageControlClient(CallInvoker)

public StorageControlClient(CallInvoker callInvoker)

Creates a new client for StorageControl that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

StorageControlClient(ChannelBase)

public StorageControlClient(ChannelBase channel)

Creates a new client for StorageControl

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

StorageControlClient(ClientBaseConfiguration)

protected StorageControlClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateFolder(CreateFolderRequest, CallOptions)

public virtual Folder CreateFolder(CreateFolderRequest request, CallOptions options)

Creates a new folder.

Parameters
Name	Description
request	CreateFolderRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Folder	The response received from the server.

CreateFolder(CreateFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual Folder CreateFolder(CreateFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new folder.

Parameters
Name	Description
request	CreateFolderRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Folder	The response received from the server.

CreateFolderAsync(CreateFolderRequest, CallOptions)

public virtual AsyncUnaryCall<Folder> CreateFolderAsync(CreateFolderRequest request, CallOptions options)

Creates a new folder.

Parameters
Name	Description
request	CreateFolderRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFolder	The call object.

CreateFolderAsync(CreateFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Folder> CreateFolderAsync(CreateFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new folder.

Parameters
Name	Description
request	CreateFolderRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFolder	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteFolder(DeleteFolderRequest, CallOptions)

public virtual Empty DeleteFolder(DeleteFolderRequest request, CallOptions options)

Permanently deletes an empty folder.

Parameters
Name	Description
request	DeleteFolderRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteFolder(DeleteFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteFolder(DeleteFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Permanently deletes an empty folder.

Parameters
Name	Description
request	DeleteFolderRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteFolderAsync(DeleteFolderRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteFolderAsync(DeleteFolderRequest request, CallOptions options)

Permanently deletes an empty folder.

Parameters
Name	Description
request	DeleteFolderRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteFolderAsync(DeleteFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteFolderAsync(DeleteFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Permanently deletes an empty folder.

Parameters
Name	Description
request	DeleteFolderRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetFolder(GetFolderRequest, CallOptions)

public virtual Folder GetFolder(GetFolderRequest request, CallOptions options)

Returns metadata for the specified folder.

Parameters
Name	Description
request	GetFolderRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Folder	The response received from the server.

GetFolder(GetFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual Folder GetFolder(GetFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns metadata for the specified folder.

Parameters
Name	Description
request	GetFolderRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Folder	The response received from the server.

GetFolderAsync(GetFolderRequest, CallOptions)

public virtual AsyncUnaryCall<Folder> GetFolderAsync(GetFolderRequest request, CallOptions options)

Returns metadata for the specified folder.

Parameters
Name	Description
request	GetFolderRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFolder	The call object.

GetFolderAsync(GetFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Folder> GetFolderAsync(GetFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns metadata for the specified folder.

Parameters
Name	Description
request	GetFolderRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFolder	The call object.

GetStorageLayout(GetStorageLayoutRequest, CallOptions)

public virtual StorageLayout GetStorageLayout(GetStorageLayoutRequest request, CallOptions options)

Returns the storage layout configuration for a given bucket.

Parameters
Name	Description
request	GetStorageLayoutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
StorageLayout	The response received from the server.

GetStorageLayout(GetStorageLayoutRequest, Metadata, DateTime?, CancellationToken)

public virtual StorageLayout GetStorageLayout(GetStorageLayoutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the storage layout configuration for a given bucket.

Parameters
Name	Description
request	GetStorageLayoutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
StorageLayout	The response received from the server.

GetStorageLayoutAsync(GetStorageLayoutRequest, CallOptions)

public virtual AsyncUnaryCall<StorageLayout> GetStorageLayoutAsync(GetStorageLayoutRequest request, CallOptions options)

Returns the storage layout configuration for a given bucket.

Parameters
Name	Description
request	GetStorageLayoutRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallStorageLayout	The call object.

GetStorageLayoutAsync(GetStorageLayoutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StorageLayout> GetStorageLayoutAsync(GetStorageLayoutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the storage layout configuration for a given bucket.

Parameters
Name	Description
request	GetStorageLayoutRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallStorageLayout	The call object.

ListFolders(ListFoldersRequest, CallOptions)

public virtual ListFoldersResponse ListFolders(ListFoldersRequest request, CallOptions options)

Retrieves a list of folders for a given bucket.

Parameters
Name	Description
request	ListFoldersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListFoldersResponse	The response received from the server.

ListFolders(ListFoldersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFoldersResponse ListFolders(ListFoldersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of folders for a given bucket.

Parameters
Name	Description
request	ListFoldersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListFoldersResponse	The response received from the server.

ListFoldersAsync(ListFoldersRequest, CallOptions)

public virtual AsyncUnaryCall<ListFoldersResponse> ListFoldersAsync(ListFoldersRequest request, CallOptions options)

Retrieves a list of folders for a given bucket.

Parameters
Name	Description
request	ListFoldersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListFoldersResponse	The call object.

ListFoldersAsync(ListFoldersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFoldersResponse> ListFoldersAsync(ListFoldersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of folders for a given bucket.

Parameters
Name	Description
request	ListFoldersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListFoldersResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override StorageControl.StorageControlClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
StorageControlStorageControlClient

Overrides

ClientBase<StorageControl.StorageControlClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RenameFolder(RenameFolderRequest, CallOptions)

public virtual Operation RenameFolder(RenameFolderRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RenameFolder(RenameFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RenameFolder(RenameFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RenameFolderAsync(RenameFolderRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RenameFolderAsync(RenameFolderRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RenameFolderAsync(RenameFolderRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RenameFolderAsync(RenameFolderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.