Storage Batch Operations v1 API - Class StorageBatchOperationsClientImpl (1.0.0-beta01) 

public sealed class StorageBatchOperationsClientImpl : StorageBatchOperationsClient

Reference documentation and code samples for the Storage Batch Operations v1 API class StorageBatchOperationsClientImpl.

StorageBatchOperations client wrapper implementation, for convenient use.

Inheritance

object > StorageBatchOperationsClient > StorageBatchOperationsClientImpl

Namespace

Google.Cloud.StorageBatchOperations.V1

Assembly

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 StorageBatchOperationsStorageBatchOperationsClient

The underlying gRPC client.
settings StorageBatchOperationsSettings

The base StorageBatchOperationsSettings used within this client.
logger ILogger

Optional 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
Overrides

GrpcClient

public override StorageBatchOperations.StorageBatchOperationsClient GrpcClient { get; }

The underlying gRPC StorageBatchOperations client

Property Value
Type Description
StorageBatchOperationsStorageBatchOperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CancelJob(CancelJobRequest, CallSettings)

public override CancelJobResponse CancelJob(CancelJobRequest request, CallSettings callSettings = null)

Cancels a batch job.

Parameters
Name Description
request CancelJobRequest

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
CancelJobResponse

The RPC response.
Overrides

CancelJobAsync(CancelJobRequest, CallSettings)

public override Task<CancelJobResponse> CancelJobAsync(CancelJobRequest request, CallSettings callSettings = null)

Cancels a batch job.

Parameters
Name Description
request CancelJobRequest

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
TaskCancelJobResponse

A Task containing the RPC response.
Overrides

CreateJob(CreateJobRequest, CallSettings)

public override Operation<Job, OperationMetadata> CreateJob(CreateJobRequest request, CallSettings callSettings = null)

Creates a batch job.

Parameters
Name Description
request CreateJobRequest

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
OperationJobOperationMetadata

The RPC response.
Overrides

CreateJobAsync(CreateJobRequest, CallSettings)

public override Task<Operation<Job, OperationMetadata>> CreateJobAsync(CreateJobRequest request, CallSettings callSettings = null)

Creates a batch job.

Parameters
Name Description
request CreateJobRequest

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
TaskOperationJobOperationMetadata

A Task containing the RPC response.
Overrides

DeleteJob(DeleteJobRequest, CallSettings)

public override void DeleteJob(DeleteJobRequest request, CallSettings callSettings = null)

Deletes a batch job.

Parameters
Name Description
request DeleteJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteJobAsync(DeleteJobRequest, CallSettings)

public override Task DeleteJobAsync(DeleteJobRequest request, CallSettings callSettings = null)

Deletes a batch job.

Parameters
Name Description
request DeleteJobRequest

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

GetJob(GetJobRequest, CallSettings)

public override Job GetJob(GetJobRequest request, CallSettings callSettings = null)

Gets a batch job.

Parameters
Name Description
request GetJobRequest

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
Job

The RPC response.
Overrides

GetJobAsync(GetJobRequest, CallSettings)

public override Task<Job> GetJobAsync(GetJobRequest request, CallSettings callSettings = null)

Gets a batch job.

Parameters
Name Description
request GetJobRequest

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
TaskJob

A Task containing the RPC response.
Overrides

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 ListJobsRequest

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
PagedEnumerableListJobsResponseJob

A pageable sequence of Job resources.
Overrides

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 ListJobsRequest

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
PagedAsyncEnumerableListJobsResponseJob

A pageable asynchronous sequence of Job resources.
Overrides