Storage Batch Operations v1 API - Class StorageBatchOperations.StorageBatchOperationsClient (1.0.0-beta01)

public class StorageBatchOperations.StorageBatchOperationsClient : ClientBase<StorageBatchOperations.StorageBatchOperationsClient>

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

Client for StorageBatchOperations

Inheritance

object > ClientBase > ClientBase StorageBatchOperations StorageBatchOperationsClient > StorageBatchOperations.StorageBatchOperationsClient

Inherited Members

ClientBase<StorageBatchOperations.StorageBatchOperationsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.StorageBatchOperations.V1

Assembly

Google.Cloud.StorageBatchOperations.V1.dll

Constructors

StorageBatchOperationsClient()

protected StorageBatchOperationsClient()

Protected parameterless constructor to allow creation of test doubles.

StorageBatchOperationsClient(CallInvoker)

public StorageBatchOperationsClient(CallInvoker callInvoker)

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

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

StorageBatchOperationsClient(ChannelBase)

public StorageBatchOperationsClient(ChannelBase channel)

Creates a new client for StorageBatchOperations

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

StorageBatchOperationsClient(ClientBaseConfiguration)

protected StorageBatchOperationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CancelJob(CancelJobRequest, CallOptions)

public virtual CancelJobResponse CancelJob(CancelJobRequest request, CallOptions options)

Cancels a batch job.

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

Returns
Type	Description
`CancelJobResponse`	The response received from the server.

CancelJob(CancelJobRequest, Metadata, DateTime?, CancellationToken)

public virtual CancelJobResponse CancelJob(CancelJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a batch job.

Parameters
Name	Description
`request`	`CancelJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`CancelJobResponse`	The response received from the server.

CancelJobAsync(CancelJobRequest, CallOptions)

public virtual AsyncUnaryCall<CancelJobResponse> CancelJobAsync(CancelJobRequest request, CallOptions options)

Cancels a batch job.

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

Returns
Type	Description
`AsyncUnaryCallCancelJobResponse`	The call object.

CancelJobAsync(CancelJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CancelJobResponse> CancelJobAsync(CancelJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a batch job.

Parameters
Name	Description
`request`	`CancelJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallCancelJobResponse`	The call object.

CreateJob(CreateJobRequest, CallOptions)

public virtual Operation CreateJob(CreateJobRequest request, CallOptions options)

Creates a batch job.

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

Returns
Type	Description
`Operation`	The response received from the server.

CreateJob(CreateJobRequest, Metadata, DateTime?, CancellationToken)

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

Creates a batch job.

Parameters
Name	Description
`request`	`CreateJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

CreateJobAsync(CreateJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateJobAsync(CreateJobRequest request, CallOptions options)

Creates a batch job.

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateJobAsync(CreateJobRequest, Metadata, DateTime?, CancellationToken)

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

Creates a batch job.

Parameters
Name	Description
`request`	`CreateJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
`LocationsLocationsClient`	A new Locations.LocationsClient for the same target as this client.

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.

DeleteJob(DeleteJobRequest, CallOptions)

public virtual Empty DeleteJob(DeleteJobRequest request, CallOptions options)

Deletes a batch job.

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

Returns
Type	Description
`Empty`	The response received from the server.

DeleteJob(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a batch job.

Parameters
Name	Description
`request`	`DeleteJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

DeleteJobAsync(DeleteJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteJobAsync(DeleteJobRequest request, CallOptions options)

Deletes a batch job.

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

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteJobAsync(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a batch job.

Parameters
Name	Description
`request`	`DeleteJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

GetJob(GetJobRequest, CallOptions)

public virtual Job GetJob(GetJobRequest request, CallOptions options)

Gets a batch job.

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

Returns
Type	Description
`Job`	The response received from the server.

GetJob(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job GetJob(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a batch job.

Parameters
Name	Description
`request`	`GetJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`Job`	The response received from the server.

GetJobAsync(GetJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, CallOptions options)

Gets a batch job.

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

Returns
Type	Description
`AsyncUnaryCallJob`	The call object.

GetJobAsync(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a batch job.

Parameters
Name	Description
`request`	`GetJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallJob`	The call object.

ListJobs(ListJobsRequest, CallOptions)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, CallOptions options)

Lists Jobs in a given project and location.

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

Returns
Type	Description
`ListJobsResponse`	The response received from the server.

ListJobs(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Jobs in a given project and location.

Parameters
Name	Description
`request`	`ListJobsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`ListJobsResponse`	The response received from the server.

ListJobsAsync(ListJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, CallOptions options)

Lists Jobs in a given project and location.

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

Returns
Type	Description
`AsyncUnaryCallListJobsResponse`	The call object.

ListJobsAsync(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Jobs in a given project and location.

Parameters
Name	Description
`request`	`ListJobsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallListJobsResponse`	The call object.

NewInstance(ClientBaseConfiguration)

protected override StorageBatchOperations.StorageBatchOperationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`StorageBatchOperationsStorageBatchOperationsClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.StorageBatchOperations.V1.StorageBatchOperations.StorageBatchOperationsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Storage Batch Operations v1 API - Class StorageBatchOperations.StorageBatchOperationsClient (1.0.0-beta01) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Inherited Members

Namespace

Assembly

Constructors

StorageBatchOperationsClient()

StorageBatchOperationsClient(CallInvoker)

StorageBatchOperationsClient(ChannelBase)

StorageBatchOperationsClient(ClientBaseConfiguration)

Methods

CancelJob(CancelJobRequest, CallOptions)

CancelJob(CancelJobRequest, Metadata, DateTime?, CancellationToken)

CancelJobAsync(CancelJobRequest, CallOptions)

CancelJobAsync(CancelJobRequest, Metadata, DateTime?, CancellationToken)

CreateJob(CreateJobRequest, CallOptions)

CreateJob(CreateJobRequest, Metadata, DateTime?, CancellationToken)

CreateJobAsync(CreateJobRequest, CallOptions)

CreateJobAsync(CreateJobRequest, Metadata, DateTime?, CancellationToken)

CreateLocationsClient()

CreateOperationsClient()

DeleteJob(DeleteJobRequest, CallOptions)

DeleteJob(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

DeleteJobAsync(DeleteJobRequest, CallOptions)

DeleteJobAsync(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

GetJob(GetJobRequest, CallOptions)

GetJob(GetJobRequest, Metadata, DateTime?, CancellationToken)

GetJobAsync(GetJobRequest, CallOptions)

GetJobAsync(GetJobRequest, Metadata, DateTime?, CancellationToken)

ListJobs(ListJobsRequest, CallOptions)

ListJobs(ListJobsRequest, Metadata, DateTime?, CancellationToken)

ListJobsAsync(ListJobsRequest, CallOptions)

ListJobsAsync(ListJobsRequest, Metadata, DateTime?, CancellationToken)

NewInstance(ClientBaseConfiguration)

Storage Batch Operations v1 API - Class StorageBatchOperations.StorageBatchOperationsClient (1.0.0-beta01)