Batch v1alpha API - Class BatchServiceClientImpl (1.0.0-alpha16)

public sealed class BatchServiceClientImpl : BatchServiceClient

Reference documentation and code samples for the Batch v1alpha API class BatchServiceClientImpl.

BatchService client wrapper implementation, for convenient use.

Inheritance

object > BatchServiceClient > BatchServiceClientImpl

Inherited Members

BatchServiceClient.DefaultEndpoint

BatchServiceClient.DefaultScopes

BatchServiceClient.ServiceMetadata

BatchServiceClient.CreateAsync(CancellationToken)

BatchServiceClient.Create()

BatchServiceClient.ShutdownDefaultChannelsAsync()

BatchServiceClient.CreateJobAsync(CreateJobRequest, CancellationToken)

BatchServiceClient.CreateJob(string, Job, string, CallSettings)

BatchServiceClient.CreateJobAsync(string, Job, string, CallSettings)

BatchServiceClient.CreateJobAsync(string, Job, string, CancellationToken)

BatchServiceClient.CreateJob(LocationName, Job, string, CallSettings)

BatchServiceClient.CreateJobAsync(LocationName, Job, string, CallSettings)

BatchServiceClient.CreateJobAsync(LocationName, Job, string, CancellationToken)

BatchServiceClient.GetJobAsync(GetJobRequest, CancellationToken)

BatchServiceClient.GetJob(string, CallSettings)

BatchServiceClient.GetJobAsync(string, CallSettings)

BatchServiceClient.GetJobAsync(string, CancellationToken)

BatchServiceClient.GetJob(JobName, CallSettings)

BatchServiceClient.GetJobAsync(JobName, CallSettings)

BatchServiceClient.GetJobAsync(JobName, CancellationToken)

BatchServiceClient.DeleteJobAsync(DeleteJobRequest, CancellationToken)

BatchServiceClient.PollOnceDeleteJob(string, CallSettings)

BatchServiceClient.PollOnceDeleteJobAsync(string, CallSettings)

BatchServiceClient.DeleteJob(string, CallSettings)

BatchServiceClient.DeleteJobAsync(string, CallSettings)

BatchServiceClient.DeleteJobAsync(string, CancellationToken)

BatchServiceClient.ListJobs(string, string, int?, CallSettings)

BatchServiceClient.ListJobsAsync(string, string, int?, CallSettings)

BatchServiceClient.GetTaskAsync(GetTaskRequest, CancellationToken)

BatchServiceClient.GetTask(string, CallSettings)

BatchServiceClient.GetTaskAsync(string, CallSettings)

BatchServiceClient.GetTaskAsync(string, CancellationToken)

BatchServiceClient.GetTask(TaskName, CallSettings)

BatchServiceClient.GetTaskAsync(TaskName, CallSettings)

BatchServiceClient.GetTaskAsync(TaskName, CancellationToken)

BatchServiceClient.ListTasks(string, string, int?, CallSettings)

BatchServiceClient.ListTasksAsync(string, string, int?, CallSettings)

BatchServiceClient.ListTasks(TaskGroupName, string, int?, CallSettings)

BatchServiceClient.ListTasksAsync(TaskGroupName, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Batch.V1Alpha

Assembly

Google.Cloud.Batch.V1Alpha.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`	`BatchServiceBatchServiceClient` 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`

Overrides

BatchServiceClient.DeleteJobOperationsClient

GrpcClient

public override BatchService.BatchServiceClient GrpcClient { get; }

The underlying gRPC BatchService client

Property Value
Type	Description
`BatchServiceBatchServiceClient`

Overrides

BatchServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

BatchServiceClient.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.

Overrides

BatchServiceClient.CreateJob(CreateJobRequest, CallSettings)

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
`TaskJob`	A Task containing the RPC response.

Overrides

BatchServiceClient.CreateJobAsync(CreateJobRequest, CallSettings)

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
`OperationEmptyOperationMetadata`	The RPC response.

Overrides

BatchServiceClient.DeleteJob(DeleteJobRequest, CallSettings)

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
`TaskOperationEmptyOperationMetadata`	A Task containing the RPC response.

Overrides

BatchServiceClient.DeleteJobAsync(DeleteJobRequest, CallSettings)

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.

Overrides

BatchServiceClient.GetJob(GetJobRequest, CallSettings)

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
`TaskJob`	A Task containing the RPC response.

Overrides

BatchServiceClient.GetJobAsync(GetJobRequest, CallSettings)

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.

Overrides

BatchServiceClient.GetTask(GetTaskRequest, CallSettings)

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
`TaskTask`	A Task containing the RPC response.

Overrides

BatchServiceClient.GetTaskAsync(GetTaskRequest, CallSettings)

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
`PagedEnumerableListJobsResponseJob`	A pageable sequence of Job resources.

Overrides

BatchServiceClient.ListJobs(ListJobsRequest, CallSettings)

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
`PagedAsyncEnumerableListJobsResponseJob`	A pageable asynchronous sequence of Job resources.

Overrides

BatchServiceClient.ListJobsAsync(ListJobsRequest, CallSettings)

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
`PagedEnumerableListTasksResponseTask`	A pageable sequence of Task resources.

Overrides

BatchServiceClient.ListTasks(ListTasksRequest, CallSettings)

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
`PagedAsyncEnumerableListTasksResponseTask`	A pageable asynchronous sequence of Task resources.

Overrides

BatchServiceClient.ListTasksAsync(ListTasksRequest, CallSettings)