public sealed class StorageBatchOperationsClientImpl : StorageBatchOperationsClientReference documentation and code samples for the Storage Batch Operations v1 API class StorageBatchOperationsClientImpl.
StorageBatchOperations client wrapper implementation, for convenient use.
Namespace
Google.Cloud.StorageBatchOperations.V1Assembly
Google.Cloud.StorageBatchOperations.V1.dll
Remarks
Storage Batch Operations offers a managed experience to perform batch operations on millions of Cloud Storage objects in a serverless fashion. With this service, you can automate and simplify large scale API operations performed on Cloud Storage objects.
Constructors
StorageBatchOperationsClientImpl(StorageBatchOperationsClient, StorageBatchOperationsSettings, ILogger)
public StorageBatchOperationsClientImpl(StorageBatchOperations.StorageBatchOperationsClient grpcClient, StorageBatchOperationsSettings settings, ILogger logger)Constructs a client wrapper for the StorageBatchOperations service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
StorageBatchOperationsStorageBatchOperationsClientThe underlying gRPC client. |
settings |
StorageBatchOperationsSettingsThe base StorageBatchOperationsSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
CreateJobOperationsClient
public override OperationsClient CreateJobOperationsClient { get; }The long-running operations client for CreateJob.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override StorageBatchOperations.StorageBatchOperationsClient GrpcClient { get; }The underlying gRPC StorageBatchOperations client
| Property Value | |
|---|---|
| Type | Description |
StorageBatchOperationsStorageBatchOperationsClient |
|
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
Methods
CancelJob(CancelJobRequest, CallSettings)
public override CancelJobResponse CancelJob(CancelJobRequest request, CallSettings callSettings = null)Cancels a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
CancelJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CancelJobResponse |
The RPC response. |
CancelJobAsync(CancelJobRequest, CallSettings)
public override Task<CancelJobResponse> CancelJobAsync(CancelJobRequest request, CallSettings callSettings = null)Cancels a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
CancelJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCancelJobResponse |
A Task containing the RPC response. |
CreateJob(CreateJobRequest, CallSettings)
public override Operation<Job, OperationMetadata> CreateJob(CreateJobRequest request, CallSettings callSettings = null)Creates a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationJobOperationMetadata |
The RPC response. |
CreateJobAsync(CreateJobRequest, CallSettings)
public override Task<Operation<Job, OperationMetadata>> CreateJobAsync(CreateJobRequest request, CallSettings callSettings = null)Creates a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationJobOperationMetadata |
A Task containing the RPC response. |
DeleteJob(DeleteJobRequest, CallSettings)
public override void DeleteJob(DeleteJobRequest request, CallSettings callSettings = null)Deletes a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
DeleteJobAsync(DeleteJobRequest, CallSettings)
public override Task DeleteJobAsync(DeleteJobRequest request, CallSettings callSettings = null)Deletes a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task |
A Task containing the RPC response. |
GetJob(GetJobRequest, CallSettings)
public override Job GetJob(GetJobRequest request, CallSettings callSettings = null)Gets a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
GetJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Job |
The RPC response. |
GetJobAsync(GetJobRequest, CallSettings)
public override Task<Job> GetJobAsync(GetJobRequest request, CallSettings callSettings = null)Gets a batch job.
| Parameters | |
|---|---|
| Name | Description |
request |
GetJobRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskJob |
A Task containing the RPC response. |
ListJobs(ListJobsRequest, CallSettings)
public override PagedEnumerable<ListJobsResponse, Job> ListJobs(ListJobsRequest request, CallSettings callSettings = null)Lists Jobs in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListJobsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListJobsResponseJob |
A pageable sequence of Job resources. |
ListJobsAsync(ListJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListJobsResponse, Job> ListJobsAsync(ListJobsRequest request, CallSettings callSettings = null)Lists Jobs in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListJobsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListJobsResponseJob |
A pageable asynchronous sequence of Job resources. |