Class protos.google.cloud.aiplatform.v1.JobService (1.7.2)

Represents a JobService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1.JobService

Package

@google-cloud/aiplatform!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new JobService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

cancelBatchPredictionJob(request, callback)

public cancelBatchPredictionJob(request: google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest, callback: google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJobCallback): void;

Calls CancelBatchPredictionJob.

Parameters
NameDescription
request ICancelBatchPredictionJobRequest

CancelBatchPredictionJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJobCallback

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

Returns
TypeDescription
void

cancelBatchPredictionJob(request)

public cancelBatchPredictionJob(request: google.cloud.aiplatform.v1.ICancelBatchPredictionJobRequest): Promise<google.protobuf.Empty>;

Calls CancelBatchPredictionJob.

Parameter
NameDescription
request ICancelBatchPredictionJobRequest

CancelBatchPredictionJobRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

cancelCustomJob(request, callback)

public cancelCustomJob(request: google.cloud.aiplatform.v1.ICancelCustomJobRequest, callback: google.cloud.aiplatform.v1.JobService.CancelCustomJobCallback): void;

Calls CancelCustomJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.ICancelCustomJobRequest

CancelCustomJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CancelCustomJobCallback

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

Returns
TypeDescription
void

cancelCustomJob(request)

public cancelCustomJob(request: google.cloud.aiplatform.v1.ICancelCustomJobRequest): Promise<google.protobuf.Empty>;

Calls CancelCustomJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.ICancelCustomJobRequest

CancelCustomJobRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

cancelDataLabelingJob(request, callback)

public cancelDataLabelingJob(request: google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest, callback: google.cloud.aiplatform.v1.JobService.CancelDataLabelingJobCallback): void;

Calls CancelDataLabelingJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest

CancelDataLabelingJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CancelDataLabelingJobCallback

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

Returns
TypeDescription
void

cancelDataLabelingJob(request)

public cancelDataLabelingJob(request: google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest): Promise<google.protobuf.Empty>;

Calls CancelDataLabelingJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.ICancelDataLabelingJobRequest

CancelDataLabelingJobRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

cancelHyperparameterTuningJob(request, callback)

public cancelHyperparameterTuningJob(request: google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest, callback: google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJobCallback): void;

Calls CancelHyperparameterTuningJob.

Parameters
NameDescription
request ICancelHyperparameterTuningJobRequest

CancelHyperparameterTuningJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJobCallback

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

Returns
TypeDescription
void

cancelHyperparameterTuningJob(request)

public cancelHyperparameterTuningJob(request: google.cloud.aiplatform.v1.ICancelHyperparameterTuningJobRequest): Promise<google.protobuf.Empty>;

Calls CancelHyperparameterTuningJob.

Parameter
NameDescription
request ICancelHyperparameterTuningJobRequest

CancelHyperparameterTuningJobRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new JobService 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
JobService

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

createBatchPredictionJob(request, callback)

public createBatchPredictionJob(request: google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest, callback: google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJobCallback): void;

Calls CreateBatchPredictionJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest

CreateBatchPredictionJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJobCallback

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

Returns
TypeDescription
void

createBatchPredictionJob(request)

public createBatchPredictionJob(request: google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest): Promise<google.cloud.aiplatform.v1.BatchPredictionJob>;

Calls CreateBatchPredictionJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.ICreateBatchPredictionJobRequest

CreateBatchPredictionJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.BatchPredictionJob>

Promise

createCustomJob(request, callback)

public createCustomJob(request: google.cloud.aiplatform.v1.ICreateCustomJobRequest, callback: google.cloud.aiplatform.v1.JobService.CreateCustomJobCallback): void;

Calls CreateCustomJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.ICreateCustomJobRequest

CreateCustomJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CreateCustomJobCallback

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

Returns
TypeDescription
void

createCustomJob(request)

public createCustomJob(request: google.cloud.aiplatform.v1.ICreateCustomJobRequest): Promise<google.cloud.aiplatform.v1.CustomJob>;

Calls CreateCustomJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.ICreateCustomJobRequest

CreateCustomJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.CustomJob>

Promise

createDataLabelingJob(request, callback)

public createDataLabelingJob(request: google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest, callback: google.cloud.aiplatform.v1.JobService.CreateDataLabelingJobCallback): void;

Calls CreateDataLabelingJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest

CreateDataLabelingJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CreateDataLabelingJobCallback

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

Returns
TypeDescription
void

createDataLabelingJob(request)

public createDataLabelingJob(request: google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest): Promise<google.cloud.aiplatform.v1.DataLabelingJob>;

Calls CreateDataLabelingJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.ICreateDataLabelingJobRequest

CreateDataLabelingJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.DataLabelingJob>

Promise

createHyperparameterTuningJob(request, callback)

public createHyperparameterTuningJob(request: google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest, callback: google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJobCallback): void;

Calls CreateHyperparameterTuningJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest

CreateHyperparameterTuningJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJobCallback

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

Returns
TypeDescription
void

createHyperparameterTuningJob(request)

public createHyperparameterTuningJob(request: google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest): Promise<google.cloud.aiplatform.v1.HyperparameterTuningJob>;

Calls CreateHyperparameterTuningJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.ICreateHyperparameterTuningJobRequest

CreateHyperparameterTuningJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.HyperparameterTuningJob>

Promise

deleteBatchPredictionJob(request, callback)

public deleteBatchPredictionJob(request: google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest, callback: google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJobCallback): void;

Calls DeleteBatchPredictionJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest

DeleteBatchPredictionJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJobCallback

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

Returns
TypeDescription
void

deleteBatchPredictionJob(request)

public deleteBatchPredictionJob(request: google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest): Promise<google.longrunning.Operation>;

Calls DeleteBatchPredictionJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IDeleteBatchPredictionJobRequest

DeleteBatchPredictionJobRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteCustomJob(request, callback)

public deleteCustomJob(request: google.cloud.aiplatform.v1.IDeleteCustomJobRequest, callback: google.cloud.aiplatform.v1.JobService.DeleteCustomJobCallback): void;

Calls DeleteCustomJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IDeleteCustomJobRequest

DeleteCustomJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.DeleteCustomJobCallback

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

Returns
TypeDescription
void

deleteCustomJob(request)

public deleteCustomJob(request: google.cloud.aiplatform.v1.IDeleteCustomJobRequest): Promise<google.longrunning.Operation>;

Calls DeleteCustomJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IDeleteCustomJobRequest

DeleteCustomJobRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteDataLabelingJob(request, callback)

public deleteDataLabelingJob(request: google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest, callback: google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJobCallback): void;

Calls DeleteDataLabelingJob.

Parameters
NameDescription
request IDeleteDataLabelingJobRequest

DeleteDataLabelingJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJobCallback

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

Returns
TypeDescription
void

deleteDataLabelingJob(request)

public deleteDataLabelingJob(request: google.cloud.aiplatform.v1.IDeleteDataLabelingJobRequest): Promise<google.longrunning.Operation>;

Calls DeleteDataLabelingJob.

Parameter
NameDescription
request IDeleteDataLabelingJobRequest

DeleteDataLabelingJobRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteHyperparameterTuningJob(request, callback)

public deleteHyperparameterTuningJob(request: google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest, callback: google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJobCallback): void;

Calls DeleteHyperparameterTuningJob.

Parameters
NameDescription
request IDeleteHyperparameterTuningJobRequest

DeleteHyperparameterTuningJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJobCallback

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

Returns
TypeDescription
void

deleteHyperparameterTuningJob(request)

public deleteHyperparameterTuningJob(request: google.cloud.aiplatform.v1.IDeleteHyperparameterTuningJobRequest): Promise<google.longrunning.Operation>;

Calls DeleteHyperparameterTuningJob.

Parameter
NameDescription
request IDeleteHyperparameterTuningJobRequest

DeleteHyperparameterTuningJobRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

getBatchPredictionJob(request, callback)

public getBatchPredictionJob(request: google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest, callback: google.cloud.aiplatform.v1.JobService.GetBatchPredictionJobCallback): void;

Calls GetBatchPredictionJob.

Parameters
NameDescription
request IGetBatchPredictionJobRequest

GetBatchPredictionJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.GetBatchPredictionJobCallback

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

Returns
TypeDescription
void

getBatchPredictionJob(request)

public getBatchPredictionJob(request: google.cloud.aiplatform.v1.IGetBatchPredictionJobRequest): Promise<google.cloud.aiplatform.v1.BatchPredictionJob>;

Calls GetBatchPredictionJob.

Parameter
NameDescription
request IGetBatchPredictionJobRequest

GetBatchPredictionJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.BatchPredictionJob>

Promise

getCustomJob(request, callback)

public getCustomJob(request: google.cloud.aiplatform.v1.IGetCustomJobRequest, callback: google.cloud.aiplatform.v1.JobService.GetCustomJobCallback): void;

Calls GetCustomJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IGetCustomJobRequest

GetCustomJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.GetCustomJobCallback

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

Returns
TypeDescription
void

getCustomJob(request)

public getCustomJob(request: google.cloud.aiplatform.v1.IGetCustomJobRequest): Promise<google.cloud.aiplatform.v1.CustomJob>;

Calls GetCustomJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IGetCustomJobRequest

GetCustomJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.CustomJob>

Promise

getDataLabelingJob(request, callback)

public getDataLabelingJob(request: google.cloud.aiplatform.v1.IGetDataLabelingJobRequest, callback: google.cloud.aiplatform.v1.JobService.GetDataLabelingJobCallback): void;

Calls GetDataLabelingJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IGetDataLabelingJobRequest

GetDataLabelingJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.GetDataLabelingJobCallback

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

Returns
TypeDescription
void

getDataLabelingJob(request)

public getDataLabelingJob(request: google.cloud.aiplatform.v1.IGetDataLabelingJobRequest): Promise<google.cloud.aiplatform.v1.DataLabelingJob>;

Calls GetDataLabelingJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IGetDataLabelingJobRequest

GetDataLabelingJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.DataLabelingJob>

Promise

getHyperparameterTuningJob(request, callback)

public getHyperparameterTuningJob(request: google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest, callback: google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJobCallback): void;

Calls GetHyperparameterTuningJob.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest

GetHyperparameterTuningJobRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJobCallback

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

Returns
TypeDescription
void

getHyperparameterTuningJob(request)

public getHyperparameterTuningJob(request: google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest): Promise<google.cloud.aiplatform.v1.HyperparameterTuningJob>;

Calls GetHyperparameterTuningJob.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IGetHyperparameterTuningJobRequest

GetHyperparameterTuningJobRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.HyperparameterTuningJob>

Promise

listBatchPredictionJobs(request, callback)

public listBatchPredictionJobs(request: google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest, callback: google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobsCallback): void;

Calls ListBatchPredictionJobs.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest

ListBatchPredictionJobsRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobsCallback

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

Returns
TypeDescription
void

listBatchPredictionJobs(request)

public listBatchPredictionJobs(request: google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest): Promise<google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse>;

Calls ListBatchPredictionJobs.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IListBatchPredictionJobsRequest

ListBatchPredictionJobsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse>

Promise

listCustomJobs(request, callback)

public listCustomJobs(request: google.cloud.aiplatform.v1.IListCustomJobsRequest, callback: google.cloud.aiplatform.v1.JobService.ListCustomJobsCallback): void;

Calls ListCustomJobs.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IListCustomJobsRequest

ListCustomJobsRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.ListCustomJobsCallback

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

Returns
TypeDescription
void

listCustomJobs(request)

public listCustomJobs(request: google.cloud.aiplatform.v1.IListCustomJobsRequest): Promise<google.cloud.aiplatform.v1.ListCustomJobsResponse>;

Calls ListCustomJobs.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IListCustomJobsRequest

ListCustomJobsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListCustomJobsResponse>

Promise

listDataLabelingJobs(request, callback)

public listDataLabelingJobs(request: google.cloud.aiplatform.v1.IListDataLabelingJobsRequest, callback: google.cloud.aiplatform.v1.JobService.ListDataLabelingJobsCallback): void;

Calls ListDataLabelingJobs.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IListDataLabelingJobsRequest

ListDataLabelingJobsRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.ListDataLabelingJobsCallback

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

Returns
TypeDescription
void

listDataLabelingJobs(request)

public listDataLabelingJobs(request: google.cloud.aiplatform.v1.IListDataLabelingJobsRequest): Promise<google.cloud.aiplatform.v1.ListDataLabelingJobsResponse>;

Calls ListDataLabelingJobs.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IListDataLabelingJobsRequest

ListDataLabelingJobsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListDataLabelingJobsResponse>

Promise

listHyperparameterTuningJobs(request, callback)

public listHyperparameterTuningJobs(request: google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest, callback: google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobsCallback): void;

Calls ListHyperparameterTuningJobs.

Parameters
NameDescription
request google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest

ListHyperparameterTuningJobsRequest message or plain object

callback google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobsCallback

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

Returns
TypeDescription
void

listHyperparameterTuningJobs(request)

public listHyperparameterTuningJobs(request: google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest): Promise<google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse>;

Calls ListHyperparameterTuningJobs.

Parameter
NameDescription
request google.cloud.aiplatform.v1.IListHyperparameterTuningJobsRequest

ListHyperparameterTuningJobsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse>

Promise