Batch v1alpha API - Class BatchServiceClientImpl (1.0.0-alpha32) 

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

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

CancelJobOperationsClient

public override OperationsClient CancelJobOperationsClient { get; }

The long-running operations client for CancelJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteJobOperationsClient

public override OperationsClient DeleteJobOperationsClient { get; }

The long-running operations client for DeleteJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteResourceAllowanceOperationsClient

public override OperationsClient DeleteResourceAllowanceOperationsClient { get; }

The long-running operations client for DeleteResourceAllowance.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override BatchService.BatchServiceClient GrpcClient { get; }

The underlying gRPC BatchService client

Property Value
Type Description
BatchServiceBatchServiceClient
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 Operation<CancelJobResponse, OperationMetadata> CancelJob(CancelJobRequest request, CallSettings callSettings = null)

Cancel a 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
OperationCancelJobResponseOperationMetadata

The RPC response.
Overrides

CancelJobAsync(CancelJobRequest, CallSettings)

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

Cancel a 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
TaskOperationCancelJobResponseOperationMetadata

A Task containing the RPC response.
Overrides

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

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

CreateResourceAllowance(CreateResourceAllowanceRequest, CallSettings)

public override ResourceAllowance CreateResourceAllowance(CreateResourceAllowanceRequest request, CallSettings callSettings = null)

Create a Resource Allowance.

Parameters
Name Description
request CreateResourceAllowanceRequest

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
ResourceAllowance

The RPC response.
Overrides

CreateResourceAllowanceAsync(CreateResourceAllowanceRequest, CallSettings)

public override Task<ResourceAllowance> CreateResourceAllowanceAsync(CreateResourceAllowanceRequest request, CallSettings callSettings = null)

Create a Resource Allowance.

Parameters
Name Description
request CreateResourceAllowanceRequest

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
TaskResourceAllowance

A Task containing the RPC response.
Overrides

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

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

DeleteResourceAllowance(DeleteResourceAllowanceRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteResourceAllowance(DeleteResourceAllowanceRequest request, CallSettings callSettings = null)

Delete a ResourceAllowance.

Parameters
Name Description
request DeleteResourceAllowanceRequest

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

DeleteResourceAllowanceAsync(DeleteResourceAllowanceRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteResourceAllowanceAsync(DeleteResourceAllowanceRequest request, CallSettings callSettings = null)

Delete a ResourceAllowance.

Parameters
Name Description
request DeleteResourceAllowanceRequest

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

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

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

GetResourceAllowance(GetResourceAllowanceRequest, CallSettings)

public override ResourceAllowance GetResourceAllowance(GetResourceAllowanceRequest request, CallSettings callSettings = null)

Get a ResourceAllowance specified by its resource name.

Parameters
Name Description
request GetResourceAllowanceRequest

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
ResourceAllowance

The RPC response.
Overrides

GetResourceAllowanceAsync(GetResourceAllowanceRequest, CallSettings)

public override Task<ResourceAllowance> GetResourceAllowanceAsync(GetResourceAllowanceRequest request, CallSettings callSettings = null)

Get a ResourceAllowance specified by its resource name.

Parameters
Name Description
request GetResourceAllowanceRequest

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
TaskResourceAllowance

A Task containing the RPC response.
Overrides

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

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

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

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

ListResourceAllowances(ListResourceAllowancesRequest, CallSettings)

public override PagedEnumerable<ListResourceAllowancesResponse, ResourceAllowance> ListResourceAllowances(ListResourceAllowancesRequest request, CallSettings callSettings = null)

List all ResourceAllowances for a project within a region.

Parameters
Name Description
request ListResourceAllowancesRequest

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
PagedEnumerableListResourceAllowancesResponseResourceAllowance

A pageable sequence of ResourceAllowance resources.
Overrides

ListResourceAllowancesAsync(ListResourceAllowancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListResourceAllowancesResponse, ResourceAllowance> ListResourceAllowancesAsync(ListResourceAllowancesRequest request, CallSettings callSettings = null)

List all ResourceAllowances for a project within a region.

Parameters
Name Description
request ListResourceAllowancesRequest

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
PagedAsyncEnumerableListResourceAllowancesResponseResourceAllowance

A pageable asynchronous sequence of ResourceAllowance resources.
Overrides

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

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

UpdateJob(UpdateJobRequest, CallSettings)

public override Job UpdateJob(UpdateJobRequest request, CallSettings callSettings = null)

Update a Job.

Parameters
Name Description
request UpdateJobRequest

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

UpdateJobAsync(UpdateJobRequest, CallSettings)

public override Task<Job> UpdateJobAsync(UpdateJobRequest request, CallSettings callSettings = null)

Update a Job.

Parameters
Name Description
request UpdateJobRequest

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

UpdateResourceAllowance(UpdateResourceAllowanceRequest, CallSettings)

public override ResourceAllowance UpdateResourceAllowance(UpdateResourceAllowanceRequest request, CallSettings callSettings = null)

Update a Resource Allowance.

Parameters
Name Description
request UpdateResourceAllowanceRequest

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
ResourceAllowance

The RPC response.
Overrides

UpdateResourceAllowanceAsync(UpdateResourceAllowanceRequest, CallSettings)

public override Task<ResourceAllowance> UpdateResourceAllowanceAsync(UpdateResourceAllowanceRequest request, CallSettings callSettings = null)

Update a Resource Allowance.

Parameters
Name Description
request UpdateResourceAllowanceRequest

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
TaskResourceAllowance

A Task containing the RPC response.
Overrides