Batch v1 API - Class BatchService.BatchServiceClient (2.12.0)
Stay organized with collections
Save and categorize content based on your preferences.
public class BatchService.BatchServiceClient : ClientBase<BatchService.BatchServiceClient>Reference documentation and code samples for the Batch v1 API class BatchService.BatchServiceClient.
Client for BatchService
Inheritance
object > ClientBase > ClientBase BatchService BatchServiceClient > BatchService.BatchServiceClientInherited Members
Namespace
Google.Cloud.Batch.V1Assembly
Google.Cloud.Batch.V1.dll
Constructors
BatchServiceClient()
protected BatchServiceClient()Protected parameterless constructor to allow creation of test doubles.
BatchServiceClient(CallInvoker)
public BatchServiceClient(CallInvoker callInvoker)Creates a new client for BatchService that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
BatchServiceClient(ChannelBase)
public BatchServiceClient(ChannelBase channel)Creates a new client for BatchService
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
BatchServiceClient(ClientBaseConfiguration)
protected BatchServiceClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBase ClientBaseConfiguration The client configuration. |
Methods
CreateJob(CreateJobRequest, CallOptions)
public virtual Job CreateJob(CreateJobRequest request, CallOptions options)Create a Job.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateJobRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
Job |
The response received from the server. |
CreateJob(CreateJobRequest, Metadata, DateTime?, CancellationToken)
public virtual Job CreateJob(CreateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Create a 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.DateTimeAn 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. |
CreateJobAsync(CreateJobRequest, CallOptions)
public virtual AsyncUnaryCall<Job> CreateJobAsync(CreateJobRequest request, CallOptions options)Create a Job.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateJobRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall Job |
The call object. |
CreateJobAsync(CreateJobRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Job> CreateJobAsync(CreateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Create a 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.DateTimeAn 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 |
AsyncUnaryCall Job |
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 |
Locations LocationsClient |
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 |
Operations OperationsClient |
A new Operations client for the same target as this client. |
DeleteJob(DeleteJobRequest, CallOptions)
public virtual Operation DeleteJob(DeleteJobRequest request, CallOptions options)Delete a Job.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteJobRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteJob(DeleteJobRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteJob(DeleteJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Delete a 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.DateTimeAn 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. |
DeleteJobAsync(DeleteJobRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteJobAsync(DeleteJobRequest request, CallOptions options)Delete a Job.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteJobRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall Operation |
The call object. |
DeleteJobAsync(DeleteJobRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteJobAsync(DeleteJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Delete a 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.DateTimeAn 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 |
AsyncUnaryCall Operation |
The call object. |
GetJob(GetJobRequest, CallOptions)
public virtual Job GetJob(GetJobRequest request, CallOptions options)Get a Job specified by its resource name.
| 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)Get a Job specified by its resource name.
| 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.DateTimeAn 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)Get a Job specified by its resource name.
| Parameters | |
|---|---|
| Name | Description |
request |
GetJobRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall Job |
The call object. |
GetJobAsync(GetJobRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Get a Job specified by its resource name.
| 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.DateTimeAn 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 |
AsyncUnaryCall Job |
The call object. |
GetTask(GetTaskRequest, CallOptions)
public virtual Task GetTask(GetTaskRequest request, CallOptions options)Return a single Task.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTaskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
Task |
The response received from the server. |
GetTask(GetTaskRequest, Metadata, DateTime?, CancellationToken)
public virtual Task GetTask(GetTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Return a single Task.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTaskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn 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 |
Task |
The response received from the server. |
GetTaskAsync(GetTaskRequest, CallOptions)
public virtual AsyncUnaryCall<Task> GetTaskAsync(GetTaskRequest request, CallOptions options)Return a single Task.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTaskRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall Task |
The call object. |
GetTaskAsync(GetTaskRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Task> GetTaskAsync(GetTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Return a single Task.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTaskRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn 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 |
AsyncUnaryCall Task |
The call object. |
ListJobs(ListJobsRequest, CallOptions)
public virtual ListJobsResponse ListJobs(ListJobsRequest request, CallOptions options)List all Jobs for a project within a region.
| 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)List all Jobs for a project within a region.
| 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.DateTimeAn 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)List all Jobs for a project within a region.
| Parameters | |
|---|---|
| Name | Description |
request |
ListJobsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall ListJobsResponse |
The call object. |
ListJobsAsync(ListJobsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)List all Jobs for a project within a region.
| 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.DateTimeAn 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 |
AsyncUnaryCall ListJobsResponse |
The call object. |
ListTasks(ListTasksRequest, CallOptions)
public virtual ListTasksResponse ListTasks(ListTasksRequest request, CallOptions options)List Tasks associated with a job.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTasksRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListTasksResponse |
The response received from the server. |
ListTasks(ListTasksRequest, Metadata, DateTime?, CancellationToken)
public virtual ListTasksResponse ListTasks(ListTasksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)List Tasks associated with a job.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTasksRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn 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 |
ListTasksResponse |
The response received from the server. |
ListTasksAsync(ListTasksRequest, CallOptions)
public virtual AsyncUnaryCall<ListTasksResponse> ListTasksAsync(ListTasksRequest request, CallOptions options)List Tasks associated with a job.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTasksRequest The request to send to the server. |
options |
CallOptions The options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall ListTasksResponse |
The call object. |
ListTasksAsync(ListTasksRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListTasksResponse> ListTasksAsync(ListTasksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)List Tasks associated with a job.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTasksRequest The request to send to the server. |
headers |
Metadata The initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn 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 |
AsyncUnaryCall ListTasksResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override BatchService.BatchServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBase ClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
BatchService BatchServiceClient |
|