Class protos.google.cloud.aiplatform.v1beta1.PipelineService (3.15.0)

Represents a PipelineService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1beta1.PipelineService

Package

@google-cloud/aiplatform

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new PipelineService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchCancelPipelineJobs(request, callback)

public batchCancelPipelineJobs(request: google.cloud.aiplatform.v1beta1.IBatchCancelPipelineJobsRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.BatchCancelPipelineJobsCallback): void;

Calls BatchCancelPipelineJobs.

Parameters
Name Description
request IBatchCancelPipelineJobsRequest

BatchCancelPipelineJobsRequest message or plain object
callback BatchCancelPipelineJobsCallback

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

batchCancelPipelineJobs(request)

public batchCancelPipelineJobs(request: google.cloud.aiplatform.v1beta1.IBatchCancelPipelineJobsRequest): Promise<google.longrunning.Operation>;

Calls BatchCancelPipelineJobs.

Parameter
Name Description
request IBatchCancelPipelineJobsRequest

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

Promise

batchDeletePipelineJobs(request, callback)

public batchDeletePipelineJobs(request: google.cloud.aiplatform.v1beta1.IBatchDeletePipelineJobsRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.BatchDeletePipelineJobsCallback): void;

Calls BatchDeletePipelineJobs.

Parameters
Name Description
request IBatchDeletePipelineJobsRequest

BatchDeletePipelineJobsRequest message or plain object
callback BatchDeletePipelineJobsCallback

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

batchDeletePipelineJobs(request)

public batchDeletePipelineJobs(request: google.cloud.aiplatform.v1beta1.IBatchDeletePipelineJobsRequest): Promise<google.longrunning.Operation>;

Calls BatchDeletePipelineJobs.

Parameter
Name Description
request IBatchDeletePipelineJobsRequest

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

Promise

cancelPipelineJob(request, callback)

public cancelPipelineJob(request: google.cloud.aiplatform.v1beta1.ICancelPipelineJobRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJobCallback): void;

Calls CancelPipelineJob.

Parameters
Name Description
request ICancelPipelineJobRequest

CancelPipelineJobRequest message or plain object
callback CancelPipelineJobCallback

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

cancelPipelineJob(request)

public cancelPipelineJob(request: google.cloud.aiplatform.v1beta1.ICancelPipelineJobRequest): Promise<google.protobuf.Empty>;

Calls CancelPipelineJob.

Parameter
Name Description
request ICancelPipelineJobRequest

CancelPipelineJobRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

cancelTrainingPipeline(request, callback)

public cancelTrainingPipeline(request: google.cloud.aiplatform.v1beta1.ICancelTrainingPipelineRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipelineCallback): void;

Calls CancelTrainingPipeline.

Parameters
Name Description
request ICancelTrainingPipelineRequest

CancelTrainingPipelineRequest message or plain object
callback CancelTrainingPipelineCallback

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

cancelTrainingPipeline(request)

public cancelTrainingPipeline(request: google.cloud.aiplatform.v1beta1.ICancelTrainingPipelineRequest): Promise<google.protobuf.Empty>;

Calls CancelTrainingPipeline.

Parameter
Name Description
request ICancelTrainingPipelineRequest

CancelTrainingPipelineRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

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

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

createPipelineJob(request, callback)

public createPipelineJob(request: google.cloud.aiplatform.v1beta1.ICreatePipelineJobRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJobCallback): void;

Calls CreatePipelineJob.

Parameters
Name Description
request ICreatePipelineJobRequest

CreatePipelineJobRequest message or plain object
callback CreatePipelineJobCallback

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

createPipelineJob(request)

public createPipelineJob(request: google.cloud.aiplatform.v1beta1.ICreatePipelineJobRequest): Promise<google.cloud.aiplatform.v1beta1.PipelineJob>;

Calls CreatePipelineJob.

Parameter
Name Description
request ICreatePipelineJobRequest

CreatePipelineJobRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1beta1.PipelineJob>

Promise

createTrainingPipeline(request, callback)

public createTrainingPipeline(request: google.cloud.aiplatform.v1beta1.ICreateTrainingPipelineRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipelineCallback): void;

Calls CreateTrainingPipeline.

Parameters
Name Description
request ICreateTrainingPipelineRequest

CreateTrainingPipelineRequest message or plain object
callback CreateTrainingPipelineCallback

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

createTrainingPipeline(request)

public createTrainingPipeline(request: google.cloud.aiplatform.v1beta1.ICreateTrainingPipelineRequest): Promise<google.cloud.aiplatform.v1beta1.TrainingPipeline>;

Calls CreateTrainingPipeline.

Parameter
Name Description
request ICreateTrainingPipelineRequest

CreateTrainingPipelineRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1beta1.TrainingPipeline>

Promise

deletePipelineJob(request, callback)

public deletePipelineJob(request: google.cloud.aiplatform.v1beta1.IDeletePipelineJobRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJobCallback): void;

Calls DeletePipelineJob.

Parameters
Name Description
request IDeletePipelineJobRequest

DeletePipelineJobRequest message or plain object
callback DeletePipelineJobCallback

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

deletePipelineJob(request)

public deletePipelineJob(request: google.cloud.aiplatform.v1beta1.IDeletePipelineJobRequest): Promise<google.longrunning.Operation>;

Calls DeletePipelineJob.

Parameter
Name Description
request IDeletePipelineJobRequest

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

Promise

deleteTrainingPipeline(request, callback)

public deleteTrainingPipeline(request: google.cloud.aiplatform.v1beta1.IDeleteTrainingPipelineRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipelineCallback): void;

Calls DeleteTrainingPipeline.

Parameters
Name Description
request IDeleteTrainingPipelineRequest

DeleteTrainingPipelineRequest message or plain object
callback DeleteTrainingPipelineCallback

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

deleteTrainingPipeline(request)

public deleteTrainingPipeline(request: google.cloud.aiplatform.v1beta1.IDeleteTrainingPipelineRequest): Promise<google.longrunning.Operation>;

Calls DeleteTrainingPipeline.

Parameter
Name Description
request IDeleteTrainingPipelineRequest

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

Promise

getPipelineJob(request, callback)

public getPipelineJob(request: google.cloud.aiplatform.v1beta1.IGetPipelineJobRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJobCallback): void;

Calls GetPipelineJob.

Parameters
Name Description
request IGetPipelineJobRequest

GetPipelineJobRequest message or plain object
callback GetPipelineJobCallback

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

getPipelineJob(request)

public getPipelineJob(request: google.cloud.aiplatform.v1beta1.IGetPipelineJobRequest): Promise<google.cloud.aiplatform.v1beta1.PipelineJob>;

Calls GetPipelineJob.

Parameter
Name Description
request IGetPipelineJobRequest

GetPipelineJobRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1beta1.PipelineJob>

Promise

getTrainingPipeline(request, callback)

public getTrainingPipeline(request: google.cloud.aiplatform.v1beta1.IGetTrainingPipelineRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipelineCallback): void;

Calls GetTrainingPipeline.

Parameters
Name Description
request IGetTrainingPipelineRequest

GetTrainingPipelineRequest message or plain object
callback GetTrainingPipelineCallback

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

getTrainingPipeline(request)

public getTrainingPipeline(request: google.cloud.aiplatform.v1beta1.IGetTrainingPipelineRequest): Promise<google.cloud.aiplatform.v1beta1.TrainingPipeline>;

Calls GetTrainingPipeline.

Parameter
Name Description
request IGetTrainingPipelineRequest

GetTrainingPipelineRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1beta1.TrainingPipeline>

Promise

listPipelineJobs(request, callback)

public listPipelineJobs(request: google.cloud.aiplatform.v1beta1.IListPipelineJobsRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobsCallback): void;

Calls ListPipelineJobs.

Parameters
Name Description
request IListPipelineJobsRequest

ListPipelineJobsRequest message or plain object
callback ListPipelineJobsCallback

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

listPipelineJobs(request)

public listPipelineJobs(request: google.cloud.aiplatform.v1beta1.IListPipelineJobsRequest): Promise<google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse>;

Calls ListPipelineJobs.

Parameter
Name Description
request IListPipelineJobsRequest

ListPipelineJobsRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse>

Promise

listTrainingPipelines(request, callback)

public listTrainingPipelines(request: google.cloud.aiplatform.v1beta1.IListTrainingPipelinesRequest, callback: google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelinesCallback): void;

Calls ListTrainingPipelines.

Parameters
Name Description
request IListTrainingPipelinesRequest

ListTrainingPipelinesRequest message or plain object
callback ListTrainingPipelinesCallback

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

listTrainingPipelines(request)

public listTrainingPipelines(request: google.cloud.aiplatform.v1beta1.IListTrainingPipelinesRequest): Promise<google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse>;

Calls ListTrainingPipelines.

Parameter
Name Description
request IListTrainingPipelinesRequest

ListTrainingPipelinesRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse>

Promise