Class protos.google.cloud.batch.v1.BatchService (1.5.0)

Represents a BatchService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.batch.v1.BatchService

Package

@google-cloud/batch

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new BatchService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): BatchService;

Creates new BatchService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
BatchService

RPC service. Useful where requests and/or responses are streamed.

createJob(request, callback)

public createJob(request: google.cloud.batch.v1.ICreateJobRequest, callback: google.cloud.batch.v1.BatchService.CreateJobCallback): void;

Calls CreateJob.

Parameters
NameDescription
request ICreateJobRequest

CreateJobRequest message or plain object

callback CreateJobCallback

Node-style callback called with the error, if any, and Job

Returns
TypeDescription
void

createJob(request)

public createJob(request: google.cloud.batch.v1.ICreateJobRequest): Promise<google.cloud.batch.v1.Job>;

Calls CreateJob.

Parameter
NameDescription
request ICreateJobRequest

CreateJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.batch.v1.Job>

Promise

deleteJob(request, callback)

public deleteJob(request: google.cloud.batch.v1.IDeleteJobRequest, callback: google.cloud.batch.v1.BatchService.DeleteJobCallback): void;

Calls DeleteJob.

Parameters
NameDescription
request IDeleteJobRequest

DeleteJobRequest message or plain object

callback DeleteJobCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteJob(request)

public deleteJob(request: google.cloud.batch.v1.IDeleteJobRequest): Promise<google.longrunning.Operation>;

Calls DeleteJob.

Parameter
NameDescription
request IDeleteJobRequest

DeleteJobRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

getJob(request, callback)

public getJob(request: google.cloud.batch.v1.IGetJobRequest, callback: google.cloud.batch.v1.BatchService.GetJobCallback): void;

Calls GetJob.

Parameters
NameDescription
request IGetJobRequest

GetJobRequest message or plain object

callback GetJobCallback

Node-style callback called with the error, if any, and Job

Returns
TypeDescription
void

getJob(request)

public getJob(request: google.cloud.batch.v1.IGetJobRequest): Promise<google.cloud.batch.v1.Job>;

Calls GetJob.

Parameter
NameDescription
request IGetJobRequest

GetJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.batch.v1.Job>

Promise

getTask(request, callback)

public getTask(request: google.cloud.batch.v1.IGetTaskRequest, callback: google.cloud.batch.v1.BatchService.GetTaskCallback): void;

Calls GetTask.

Parameters
NameDescription
request IGetTaskRequest

GetTaskRequest message or plain object

callback GetTaskCallback

Node-style callback called with the error, if any, and Task

Returns
TypeDescription
void

getTask(request)

public getTask(request: google.cloud.batch.v1.IGetTaskRequest): Promise<google.cloud.batch.v1.Task>;

Calls GetTask.

Parameter
NameDescription
request IGetTaskRequest

GetTaskRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.batch.v1.Task>

Promise

listJobs(request, callback)

public listJobs(request: google.cloud.batch.v1.IListJobsRequest, callback: google.cloud.batch.v1.BatchService.ListJobsCallback): void;

Calls ListJobs.

Parameters
NameDescription
request IListJobsRequest

ListJobsRequest message or plain object

callback ListJobsCallback

Node-style callback called with the error, if any, and ListJobsResponse

Returns
TypeDescription
void

listJobs(request)

public listJobs(request: google.cloud.batch.v1.IListJobsRequest): Promise<google.cloud.batch.v1.ListJobsResponse>;

Calls ListJobs.

Parameter
NameDescription
request IListJobsRequest

ListJobsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.batch.v1.ListJobsResponse>

Promise

listTasks(request, callback)

public listTasks(request: google.cloud.batch.v1.IListTasksRequest, callback: google.cloud.batch.v1.BatchService.ListTasksCallback): void;

Calls ListTasks.

Parameters
NameDescription
request IListTasksRequest

ListTasksRequest message or plain object

callback ListTasksCallback

Node-style callback called with the error, if any, and ListTasksResponse

Returns
TypeDescription
void

listTasks(request)

public listTasks(request: google.cloud.batch.v1.IListTasksRequest): Promise<google.cloud.batch.v1.ListTasksResponse>;

Calls ListTasks.

Parameter
NameDescription
request IListTasksRequest

ListTasksRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.batch.v1.ListTasksResponse>

Promise