Batch v1alpha API - Class BatchService.BatchServiceBase (1.0.0-alpha30)

[BindServiceMethod(typeof(BatchService), "BindService")]
public abstract class BatchService.BatchServiceBase

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

Base class for server-side implementations of BatchService

Inheritance

object > BatchService.BatchServiceBase

Namespace

Google.Cloud.Batch.V1Alpha

Assembly

Google.Cloud.Batch.V1Alpha.dll

Methods

CancelJob(CancelJobRequest, ServerCallContext)

public virtual Task<Operation> CancelJob(CancelJobRequest request, ServerCallContext context)

Cancel a Job.

Parameters
Name Description
request CancelJobRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateJob(CreateJobRequest, ServerCallContext)

public virtual Task<Job> CreateJob(CreateJobRequest request, ServerCallContext context)

Create a Job.

Parameters
Name Description
request CreateJobRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskJob

The response to send back to the client (wrapped by a task).

CreateResourceAllowance(CreateResourceAllowanceRequest, ServerCallContext)

public virtual Task<ResourceAllowance> CreateResourceAllowance(CreateResourceAllowanceRequest request, ServerCallContext context)

Create a Resource Allowance.

Parameters
Name Description
request CreateResourceAllowanceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskResourceAllowance

The response to send back to the client (wrapped by a task).

DeleteJob(DeleteJobRequest, ServerCallContext)

public virtual Task<Operation> DeleteJob(DeleteJobRequest request, ServerCallContext context)

Delete a Job.

Parameters
Name Description
request DeleteJobRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteResourceAllowance(DeleteResourceAllowanceRequest, ServerCallContext)

public virtual Task<Operation> DeleteResourceAllowance(DeleteResourceAllowanceRequest request, ServerCallContext context)

Delete a ResourceAllowance.

Parameters
Name Description
request DeleteResourceAllowanceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GetJob(GetJobRequest, ServerCallContext)

public virtual Task<Job> GetJob(GetJobRequest request, ServerCallContext context)

Get a Job specified by its resource name.

Parameters
Name Description
request GetJobRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskJob

The response to send back to the client (wrapped by a task).

GetResourceAllowance(GetResourceAllowanceRequest, ServerCallContext)

public virtual Task<ResourceAllowance> GetResourceAllowance(GetResourceAllowanceRequest request, ServerCallContext context)

Get a ResourceAllowance specified by its resource name.

Parameters
Name Description
request GetResourceAllowanceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskResourceAllowance

The response to send back to the client (wrapped by a task).

GetTask(GetTaskRequest, ServerCallContext)

public virtual Task<Task> GetTask(GetTaskRequest request, ServerCallContext context)

Return a single Task.

Parameters
Name Description
request GetTaskRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskTask

The response to send back to the client (wrapped by a task).

ListJobs(ListJobsRequest, ServerCallContext)

public virtual Task<ListJobsResponse> ListJobs(ListJobsRequest request, ServerCallContext context)

List all Jobs for a project within a region.

Parameters
Name Description
request ListJobsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListJobsResponse

The response to send back to the client (wrapped by a task).

ListResourceAllowances(ListResourceAllowancesRequest, ServerCallContext)

public virtual Task<ListResourceAllowancesResponse> ListResourceAllowances(ListResourceAllowancesRequest request, ServerCallContext context)

List all ResourceAllowances for a project within a region.

Parameters
Name Description
request ListResourceAllowancesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListResourceAllowancesResponse

The response to send back to the client (wrapped by a task).

ListTasks(ListTasksRequest, ServerCallContext)

public virtual Task<ListTasksResponse> ListTasks(ListTasksRequest request, ServerCallContext context)

List Tasks associated with a job.

Parameters
Name Description
request ListTasksRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListTasksResponse

The response to send back to the client (wrapped by a task).

UpdateJob(UpdateJobRequest, ServerCallContext)

public virtual Task<Job> UpdateJob(UpdateJobRequest request, ServerCallContext context)

Update a Job.

Parameters
Name Description
request UpdateJobRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskJob

The response to send back to the client (wrapped by a task).

UpdateResourceAllowance(UpdateResourceAllowanceRequest, ServerCallContext)

public virtual Task<ResourceAllowance> UpdateResourceAllowance(UpdateResourceAllowanceRequest request, ServerCallContext context)

Update a Resource Allowance.

Parameters
Name Description
request UpdateResourceAllowanceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskResourceAllowance

The response to send back to the client (wrapped by a task).