Cloud Storage v2 API - Class StorageControl.StorageControlBase (1.0.0-beta03)

[BindServiceMethod(typeof(StorageControl), "BindService")]
public abstract class StorageControl.StorageControlBase

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

Base class for server-side implementations of StorageControl

Inheritance

object > StorageControl.StorageControlBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Methods

CreateFolder(CreateFolderRequest, ServerCallContext)

public virtual Task<Folder> CreateFolder(CreateFolderRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskFolder`	The response to send back to the client (wrapped by a task).

CreateManagedFolder(CreateManagedFolderRequest, ServerCallContext)

public virtual Task<ManagedFolder> CreateManagedFolder(CreateManagedFolderRequest request, ServerCallContext context)

Creates a new managed folder.

Parameters
Name	Description
`request`	`CreateManagedFolderRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskManagedFolder`	The response to send back to the client (wrapped by a task).

DeleteFolder(DeleteFolderRequest, ServerCallContext)

public virtual Task<Empty> DeleteFolder(DeleteFolderRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteManagedFolder(DeleteManagedFolderRequest, ServerCallContext)

public virtual Task<Empty> DeleteManagedFolder(DeleteManagedFolderRequest request, ServerCallContext context)

Permanently deletes an empty managed folder.

Parameters
Name	Description
`request`	`DeleteManagedFolderRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

GetFolder(GetFolderRequest, ServerCallContext)

public virtual Task<Folder> GetFolder(GetFolderRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskFolder`	The response to send back to the client (wrapped by a task).

GetManagedFolder(GetManagedFolderRequest, ServerCallContext)

public virtual Task<ManagedFolder> GetManagedFolder(GetManagedFolderRequest request, ServerCallContext context)

Returns metadata for the specified managed folder.

Parameters
Name	Description
`request`	`GetManagedFolderRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskManagedFolder`	The response to send back to the client (wrapped by a task).

GetStorageLayout(GetStorageLayoutRequest, ServerCallContext)

public virtual Task<StorageLayout> GetStorageLayout(GetStorageLayoutRequest request, ServerCallContext context)

Returns the storage layout configuration for a given bucket.

Parameters
Name	Description
`request`	`GetStorageLayoutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskStorageLayout`	The response to send back to the client (wrapped by a task).

ListFolders(ListFoldersRequest, ServerCallContext)

public virtual Task<ListFoldersResponse> ListFolders(ListFoldersRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListFoldersResponse`	The response to send back to the client (wrapped by a task).

ListManagedFolders(ListManagedFoldersRequest, ServerCallContext)

public virtual Task<ListManagedFoldersResponse> ListManagedFolders(ListManagedFoldersRequest request, ServerCallContext context)

Retrieves a list of managed folders for a given bucket.

Parameters
Name	Description
`request`	`ListManagedFoldersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListManagedFoldersResponse`	The response to send back to the client (wrapped by a task).

RenameFolder(RenameFolderRequest, ServerCallContext)

public virtual Task<Operation> RenameFolder(RenameFolderRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).