Class protos.google.cloud.batch.v1alpha.BatchService (0.3.2)

Represents a BatchService

Inheritance

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

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new BatchService service.

Parameters

Name	Description
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

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

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

createJob(request, callback)

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

Calls CreateJob.

Parameters

Name	Description
request	`ICreateJobRequest` CreateJobRequest message or plain object
callback	`google.cloud.batch.v1alpha.BatchService.CreateJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

createJob(request)

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

Calls CreateJob.

Parameter

Name	Description
request	`ICreateJobRequest` CreateJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.batch.v1alpha.Job>	Promise

deleteJob(request, callback)

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

Calls DeleteJob.

Parameters

Name	Description
request	`IDeleteJobRequest` DeleteJobRequest message or plain object
callback	`google.cloud.batch.v1alpha.BatchService.DeleteJobCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

deleteJob(request)

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

Calls DeleteJob.

Parameter

Name	Description
request	`IDeleteJobRequest` DeleteJobRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

getJob(request, callback)

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

Calls GetJob.

Parameters

Name	Description
request	`google.cloud.batch.v1alpha.IGetJobRequest` GetJobRequest message or plain object
callback	`google.cloud.batch.v1alpha.BatchService.GetJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

getJob(request)

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

Calls GetJob.

Parameter

Name	Description
request	`google.cloud.batch.v1alpha.IGetJobRequest` GetJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.batch.v1alpha.Job>	Promise

getTask(request, callback)

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

Calls GetTask.

Parameters

Name	Description
request	`google.cloud.batch.v1alpha.IGetTaskRequest` GetTaskRequest message or plain object
callback	`google.cloud.batch.v1alpha.BatchService.GetTaskCallback` Node-style callback called with the error, if any, and Task

Returns

Type	Description
void

getTask(request)

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

Calls GetTask.

Parameter

Name	Description
request	`google.cloud.batch.v1alpha.IGetTaskRequest` GetTaskRequest message or plain object

Returns

Type	Description
Promise<google.cloud.batch.v1alpha.Task>	Promise

listJobs(request, callback)

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

Calls ListJobs.

Parameters

Name	Description
request	`IListJobsRequest` ListJobsRequest message or plain object
callback	`google.cloud.batch.v1alpha.BatchService.ListJobsCallback` Node-style callback called with the error, if any, and ListJobsResponse

Returns

Type	Description
void

listJobs(request)

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

Calls ListJobs.

Parameter

Name	Description
request	`IListJobsRequest` ListJobsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.batch.v1alpha.ListJobsResponse>	Promise

listTasks(request, callback)

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

Calls ListTasks.

Parameters

Name	Description
request	`google.cloud.batch.v1alpha.IListTasksRequest` ListTasksRequest message or plain object
callback	`google.cloud.batch.v1alpha.BatchService.ListTasksCallback` Node-style callback called with the error, if any, and ListTasksResponse

Returns

Type	Description
void

listTasks(request)

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

Calls ListTasks.

Parameter

Name	Description
request	`google.cloud.batch.v1alpha.IListTasksRequest` ListTasksRequest message or plain object

Returns

Type	Description
Promise<google.cloud.batch.v1alpha.ListTasksResponse>	Promise