Cloud Storage v2 API - Class StorageControl.StorageControlBase (1.5.0)

[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

CreateAnywhereCache(CreateAnywhereCacheRequest, ServerCallContext)

public virtual Task<Operation> CreateAnywhereCache(CreateAnywhereCacheRequest request, ServerCallContext context)

Creates an Anywhere Cache instance.

Parameters
Name	Description
`request`	`CreateAnywhereCacheRequest` 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).

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.

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.

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).

DisableAnywhereCache(DisableAnywhereCacheRequest, ServerCallContext)

public virtual Task<AnywhereCache> DisableAnywhereCache(DisableAnywhereCacheRequest request, ServerCallContext context)

Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

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

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

GetAnywhereCache(GetAnywhereCacheRequest, ServerCallContext)

public virtual Task<AnywhereCache> GetAnywhereCache(GetAnywhereCacheRequest request, ServerCallContext context)

Gets an Anywhere Cache instance.

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

Returns
Type	Description
`TaskAnywhereCache`	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.

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).

GetFolderIntelligenceConfig(GetFolderIntelligenceConfigRequest, ServerCallContext)

public virtual Task<IntelligenceConfig> GetFolderIntelligenceConfig(GetFolderIntelligenceConfigRequest request, ServerCallContext context)

Returns the Folder scoped singleton IntelligenceConfig resource.

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

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

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

Gets the IAM policy for a specified bucket. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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

Returns
Type	Description
`TaskPolicy`	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).

GetOrganizationIntelligenceConfig(GetOrganizationIntelligenceConfigRequest, ServerCallContext)

public virtual Task<IntelligenceConfig> GetOrganizationIntelligenceConfig(GetOrganizationIntelligenceConfigRequest request, ServerCallContext context)

Returns the Organization scoped singleton IntelligenceConfig resource.

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

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

GetProjectIntelligenceConfig(GetProjectIntelligenceConfigRequest, ServerCallContext)

public virtual Task<IntelligenceConfig> GetProjectIntelligenceConfig(GetProjectIntelligenceConfigRequest request, ServerCallContext context)

Returns the Project scoped singleton IntelligenceConfig resource.

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

Returns
Type	Description
`TaskIntelligenceConfig`	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).

ListAnywhereCaches(ListAnywhereCachesRequest, ServerCallContext)

public virtual Task<ListAnywhereCachesResponse> ListAnywhereCaches(ListAnywhereCachesRequest request, ServerCallContext context)

Lists Anywhere Cache instances for a given bucket.

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

Returns
Type	Description
`TaskListAnywhereCachesResponse`	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.

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).

PauseAnywhereCache(PauseAnywhereCacheRequest, ServerCallContext)

public virtual Task<AnywhereCache> PauseAnywhereCache(PauseAnywhereCacheRequest request, ServerCallContext context)

Pauses an Anywhere Cache instance.

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

Returns
Type	Description
`TaskAnywhereCache`	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.

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).

ResumeAnywhereCache(ResumeAnywhereCacheRequest, ServerCallContext)

public virtual Task<AnywhereCache> ResumeAnywhereCache(ResumeAnywhereCacheRequest request, ServerCallContext context)

Resumes a disabled or paused Anywhere Cache instance.

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

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

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Updates an IAM policy for the specified bucket. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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

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

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, projects/_/buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

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

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

UpdateAnywhereCache(UpdateAnywhereCacheRequest, ServerCallContext)

public virtual Task<Operation> UpdateAnywhereCache(UpdateAnywhereCacheRequest request, ServerCallContext context)

Updates an Anywhere Cache instance. Mutable fields include ttl and admission_policy.

Parameters
Name	Description
`request`	`UpdateAnywhereCacheRequest` 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).

UpdateFolderIntelligenceConfig(UpdateFolderIntelligenceConfigRequest, ServerCallContext)

public virtual Task<IntelligenceConfig> UpdateFolderIntelligenceConfig(UpdateFolderIntelligenceConfigRequest request, ServerCallContext context)

Updates the Folder scoped singleton IntelligenceConfig resource.

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

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

UpdateOrganizationIntelligenceConfig(UpdateOrganizationIntelligenceConfigRequest, ServerCallContext)

public virtual Task<IntelligenceConfig> UpdateOrganizationIntelligenceConfig(UpdateOrganizationIntelligenceConfigRequest request, ServerCallContext context)

Updates the Organization scoped singleton IntelligenceConfig resource.

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

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

UpdateProjectIntelligenceConfig(UpdateProjectIntelligenceConfigRequest, ServerCallContext)

public virtual Task<IntelligenceConfig> UpdateProjectIntelligenceConfig(UpdateProjectIntelligenceConfigRequest request, ServerCallContext context)

Updates the Project scoped singleton IntelligenceConfig resource.

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

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

Cloud Storage v2 API - Class StorageControl.StorageControlBase (1.5.0) Stay organized with collections Save and categorize content based on your preferences.