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

Version 1.5.0

• 1.15.0 (latest)
• 1.12.0
• 1.11.0
• 1.8.0
• 1.7.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.1.0
• 0.7.1
• 0.6.1
• 0.5.0
• 0.3.2

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
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.v1.ICreateJobRequest, callback: google.cloud.batch.v1.BatchService.CreateJobCallback): void;

Calls CreateJob.

Parameters
Name	Description
request	ICreateJobRequest CreateJobRequest message or plain object
callback	CreateJobCallback Node-style callback called with the error, if any, and Job

Returns
Type	Description
void

createJob(request)

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

Calls CreateJob.

Parameter
Name	Description
request	ICreateJobRequest CreateJobRequest message or plain object

Returns
Type	Description
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
Name	Description
request	IDeleteJobRequest DeleteJobRequest message or plain object
callback	DeleteJobCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteJob(request)

public deleteJob(request: google.cloud.batch.v1.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.v1.IGetJobRequest, callback: google.cloud.batch.v1.BatchService.GetJobCallback): void;

Calls GetJob.

Parameters
Name	Description
request	IGetJobRequest GetJobRequest message or plain object
callback	GetJobCallback Node-style callback called with the error, if any, and Job

Returns
Type	Description
void

getJob(request)

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

Calls GetJob.

Parameter
Name	Description
request	IGetJobRequest GetJobRequest message or plain object

Returns
Type	Description
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
Name	Description
request	IGetTaskRequest GetTaskRequest message or plain object
callback	GetTaskCallback Node-style callback called with the error, if any, and Task

Returns
Type	Description
void

getTask(request)

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

Calls GetTask.

Parameter
Name	Description
request	IGetTaskRequest GetTaskRequest message or plain object

Returns
Type	Description
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
Name	Description
request	IListJobsRequest ListJobsRequest message or plain object
callback	ListJobsCallback Node-style callback called with the error, if any, and ListJobsResponse

Returns
Type	Description
void

listJobs(request)

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

Calls ListJobs.

Parameter
Name	Description
request	IListJobsRequest ListJobsRequest message or plain object

Returns
Type	Description
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
Name	Description
request	IListTasksRequest ListTasksRequest message or plain object
callback	ListTasksCallback Node-style callback called with the error, if any, and ListTasksResponse

Returns
Type	Description
void

listTasks(request)

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

Calls ListTasks.

Parameter
Name	Description
request	IListTasksRequest ListTasksRequest message or plain object

Returns
Type	Description
Promise<google.cloud.batch.v1.ListTasksResponse>	Promise