Batch v1 API - Class BatchServiceClientImpl (2.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
public sealed class BatchServiceClientImpl : BatchServiceClientReference documentation and code samples for the Batch v1 API class BatchServiceClientImpl.
BatchService client wrapper implementation, for convenient use.
Inherited Members
Namespace
Google.Cloud.Batch.V1Assembly
Google.Cloud.Batch.V1.dll
Remarks
Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs.
Constructors
BatchServiceClientImpl(BatchServiceClient, BatchServiceSettings, ILogger)
public BatchServiceClientImpl(BatchService.BatchServiceClient grpcClient, BatchServiceSettings settings, ILogger logger)Constructs a client wrapper for the BatchService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
BatchService BatchServiceClient The underlying gRPC client. |
settings |
BatchServiceSettings The base BatchServiceSettings used within this client. |
logger |
ILogger Optional ILogger to use within this client. |
Properties
DeleteJobOperationsClient
public override OperationsClient DeleteJobOperationsClient { get; }The long-running operations client for DeleteJob.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override BatchService.BatchServiceClient GrpcClient { get; }The underlying gRPC BatchService client
| Property Value | |
|---|---|
| Type | Description |
BatchService BatchServiceClient |
|
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
Methods
CreateJob(CreateJobRequest, CallSettings)
public override Job CreateJob(CreateJobRequest request, CallSettings callSettings = null)Create a 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 |
Job |
The RPC response. |
CreateJobAsync(CreateJobRequest, CallSettings)
public override Task<Job> CreateJobAsync(CreateJobRequest request, CallSettings callSettings = null)Create a 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 |
Task Job |
A Task containing the RPC response. |
DeleteJob(DeleteJobRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteJob(DeleteJobRequest request, CallSettings callSettings = null)Delete a 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 |
Operation Empty OperationMetadata |
The RPC response. |
DeleteJobAsync(DeleteJobRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteJobAsync(DeleteJobRequest request, CallSettings callSettings = null)Delete a 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 Operation Empty OperationMetadata |
A Task containing the RPC response. |
GetJob(GetJobRequest, CallSettings)
public override Job GetJob(GetJobRequest request, CallSettings callSettings = null)Get a Job specified by its resource name.
| 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. |
GetJobAsync(GetJobRequest, CallSettings)
public override Task<Job> GetJobAsync(GetJobRequest request, CallSettings callSettings = null)Get a Job specified by its resource name.
| 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 |
Task Job |
A Task containing the RPC response. |
GetTask(GetTaskRequest, CallSettings)
public override Task GetTask(GetTaskRequest request, CallSettings callSettings = null)Return a single Task.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTaskRequest 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 |
The RPC response. |
GetTaskAsync(GetTaskRequest, CallSettings)
public override Task<Task> GetTaskAsync(GetTaskRequest request, CallSettings callSettings = null)Return a single Task.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTaskRequest 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 Task |
A Task containing the RPC response. |
ListJobs(ListJobsRequest, CallSettings)
public override PagedEnumerable<ListJobsResponse, Job> ListJobs(ListJobsRequest request, CallSettings callSettings = null)List all Jobs for a project within a region.
| 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 |
PagedEnumerable ListJobsResponse Job |
A pageable sequence of Job resources. |
ListJobsAsync(ListJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListJobsResponse, Job> ListJobsAsync(ListJobsRequest request, CallSettings callSettings = null)List all Jobs for a project within a region.
| 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 |
PagedAsyncEnumerable ListJobsResponse Job |
A pageable asynchronous sequence of Job resources. |
ListTasks(ListTasksRequest, CallSettings)
public override PagedEnumerable<ListTasksResponse, Task> ListTasks(ListTasksRequest request, CallSettings callSettings = null)List Tasks associated with a job.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTasksRequest 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 |
PagedEnumerable ListTasksResponse Task |
A pageable sequence of Task resources. |
ListTasksAsync(ListTasksRequest, CallSettings)
public override PagedAsyncEnumerable<ListTasksResponse, Task> ListTasksAsync(ListTasksRequest request, CallSettings callSettings = null)List Tasks associated with a job.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTasksRequest 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 |
PagedAsyncEnumerable ListTasksResponse Task |
A pageable asynchronous sequence of Task resources. |