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

Represents a BatchService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.batch.v1alpha.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

cancelJob(request, callback)

public cancelJob(request: google.cloud.batch.v1alpha.ICancelJobRequest, callback: google.cloud.batch.v1alpha.BatchService.CancelJobCallback): void;

Calls CancelJob.

Parameters
Name Description
request ICancelJobRequest

CancelJobRequest message or plain object
callback CancelJobCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

cancelJob(request)

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

Calls CancelJob.

Parameter
Name Description
request ICancelJobRequest

CancelJobRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

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

createResourceAllowance(request, callback)

public createResourceAllowance(request: google.cloud.batch.v1alpha.ICreateResourceAllowanceRequest, callback: google.cloud.batch.v1alpha.BatchService.CreateResourceAllowanceCallback): void;

Calls CreateResourceAllowance.

Parameters
Name Description
request ICreateResourceAllowanceRequest

CreateResourceAllowanceRequest message or plain object
callback CreateResourceAllowanceCallback

Node-style callback called with the error, if any, and ResourceAllowance
Returns
Type Description
void

createResourceAllowance(request)

public createResourceAllowance(request: google.cloud.batch.v1alpha.ICreateResourceAllowanceRequest): Promise<google.cloud.batch.v1alpha.ResourceAllowance>;

Calls CreateResourceAllowance.

Parameter
Name Description
request ICreateResourceAllowanceRequest

CreateResourceAllowanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.batch.v1alpha.ResourceAllowance>

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

deleteResourceAllowance(request, callback)

public deleteResourceAllowance(request: google.cloud.batch.v1alpha.IDeleteResourceAllowanceRequest, callback: google.cloud.batch.v1alpha.BatchService.DeleteResourceAllowanceCallback): void;

Calls DeleteResourceAllowance.

Parameters
Name Description
request IDeleteResourceAllowanceRequest

DeleteResourceAllowanceRequest message or plain object
callback DeleteResourceAllowanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteResourceAllowance(request)

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

Calls DeleteResourceAllowance.

Parameter
Name Description
request IDeleteResourceAllowanceRequest

DeleteResourceAllowanceRequest 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 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.v1alpha.IGetJobRequest): Promise<google.cloud.batch.v1alpha.Job>;

Calls GetJob.

Parameter
Name Description
request IGetJobRequest

GetJobRequest message or plain object
Returns
Type Description
Promise<google.cloud.batch.v1alpha.Job>

Promise

getResourceAllowance(request, callback)

public getResourceAllowance(request: google.cloud.batch.v1alpha.IGetResourceAllowanceRequest, callback: google.cloud.batch.v1alpha.BatchService.GetResourceAllowanceCallback): void;

Calls GetResourceAllowance.

Parameters
Name Description
request IGetResourceAllowanceRequest

GetResourceAllowanceRequest message or plain object
callback GetResourceAllowanceCallback

Node-style callback called with the error, if any, and ResourceAllowance
Returns
Type Description
void

getResourceAllowance(request)

public getResourceAllowance(request: google.cloud.batch.v1alpha.IGetResourceAllowanceRequest): Promise<google.cloud.batch.v1alpha.ResourceAllowance>;

Calls GetResourceAllowance.

Parameter
Name Description
request IGetResourceAllowanceRequest

GetResourceAllowanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.batch.v1alpha.ResourceAllowance>

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 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.v1alpha.IGetTaskRequest): Promise<google.cloud.batch.v1alpha.Task>;

Calls GetTask.

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

listResourceAllowances(request, callback)

public listResourceAllowances(request: google.cloud.batch.v1alpha.IListResourceAllowancesRequest, callback: google.cloud.batch.v1alpha.BatchService.ListResourceAllowancesCallback): void;

Calls ListResourceAllowances.

Parameters
Name Description
request IListResourceAllowancesRequest

ListResourceAllowancesRequest message or plain object
callback ListResourceAllowancesCallback

Node-style callback called with the error, if any, and ListResourceAllowancesResponse
Returns
Type Description
void

listResourceAllowances(request)

public listResourceAllowances(request: google.cloud.batch.v1alpha.IListResourceAllowancesRequest): Promise<google.cloud.batch.v1alpha.ListResourceAllowancesResponse>;

Calls ListResourceAllowances.

Parameter
Name Description
request IListResourceAllowancesRequest

ListResourceAllowancesRequest message or plain object
Returns
Type Description
Promise<google.cloud.batch.v1alpha.ListResourceAllowancesResponse>

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 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.v1alpha.IListTasksRequest): Promise<google.cloud.batch.v1alpha.ListTasksResponse>;

Calls ListTasks.

Parameter
Name Description
request IListTasksRequest

ListTasksRequest message or plain object
Returns
Type Description
Promise<google.cloud.batch.v1alpha.ListTasksResponse>

Promise

updateJob(request, callback)

public updateJob(request: google.cloud.batch.v1alpha.IUpdateJobRequest, callback: google.cloud.batch.v1alpha.BatchService.UpdateJobCallback): void;

Calls UpdateJob.

Parameters
Name Description
request IUpdateJobRequest

UpdateJobRequest message or plain object
callback UpdateJobCallback

Node-style callback called with the error, if any, and Job
Returns
Type Description
void

updateJob(request)

public updateJob(request: google.cloud.batch.v1alpha.IUpdateJobRequest): Promise<google.cloud.batch.v1alpha.Job>;

Calls UpdateJob.

Parameter
Name Description
request IUpdateJobRequest

UpdateJobRequest message or plain object
Returns
Type Description
Promise<google.cloud.batch.v1alpha.Job>

Promise

updateResourceAllowance(request, callback)

public updateResourceAllowance(request: google.cloud.batch.v1alpha.IUpdateResourceAllowanceRequest, callback: google.cloud.batch.v1alpha.BatchService.UpdateResourceAllowanceCallback): void;

Calls UpdateResourceAllowance.

Parameters
Name Description
request IUpdateResourceAllowanceRequest

UpdateResourceAllowanceRequest message or plain object
callback UpdateResourceAllowanceCallback

Node-style callback called with the error, if any, and ResourceAllowance
Returns
Type Description
void

updateResourceAllowance(request)

public updateResourceAllowance(request: google.cloud.batch.v1alpha.IUpdateResourceAllowanceRequest): Promise<google.cloud.batch.v1alpha.ResourceAllowance>;

Calls UpdateResourceAllowance.

Parameter
Name Description
request IUpdateResourceAllowanceRequest

UpdateResourceAllowanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.batch.v1alpha.ResourceAllowance>

Promise