PipelineService class final

A service for creating and managing Vertex AI's pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex AI Pipelines).

Constructors

PipelineService({required Client client})
Creates a PipelineService using client for transport.
PipelineService.fromApiKey([String? apiKey])
Creates a PipelineService that does authentication through an API key.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchCancelPipelineJobs(BatchCancelPipelineJobsRequest request) → Future<Operation<BatchCancelPipelineJobsResponse, BatchCancelPipelineJobsOperationMetadata>>
Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.
batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request) → Future<Operation<BatchDeletePipelineJobsResponse, DeleteOperationMetadata>>
Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.
cancelOperation(CancelOperationRequest request) → Future<void>
Provides the Operations service functionality in this service.
cancelPipelineJob(CancelPipelineJobRequest request) → Future<void>
Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and PipelineJob.state is set to CANCELLED.
cancelTrainingPipeline(CancelTrainingPipelineRequest request) → Future<void>
Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TrainingPipeline.state is set to CANCELLED.
close() → void
Closes the client and cleans up any resources associated with it.
createPipelineJob(CreatePipelineJobRequest request) → Future<PipelineJob>
Creates a PipelineJob. A PipelineJob will run immediately when created.
createTrainingPipeline(CreateTrainingPipelineRequest request) → Future<TrainingPipeline>
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
deleteOperation(DeleteOperationRequest request) → Future<void>
Provides the Operations service functionality in this service.
deletePipelineJob(DeletePipelineJobRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a PipelineJob.
deleteTrainingPipeline(DeleteTrainingPipelineRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a TrainingPipeline.
getIamPolicy(GetIamPolicyRequest request) → Future<Policy>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
getLocation(GetLocationRequest request) → Future<Location>
Gets information about a location.
getOperation<T extends ProtoMessage, S extends ProtoMessage>(Operation<T, S> request) → Future<Operation<T, S>>
Provides the Operations service functionality in this service.
getPipelineJob(GetPipelineJobRequest request) → Future<PipelineJob>
Gets a PipelineJob.
getTrainingPipeline(GetTrainingPipelineRequest request) → Future<TrainingPipeline>
Gets a TrainingPipeline.
listLocations(ListLocationsRequest request) → Future<ListLocationsResponse>
Lists information about the supported locations for this service.
listOperations(ListOperationsRequest request) → Future<ListOperationsResponse>
Provides the Operations service functionality in this service.
listPipelineJobs(ListPipelineJobsRequest request) → Future<ListPipelineJobsResponse>
Lists PipelineJobs in a Location.
listTrainingPipelines(ListTrainingPipelinesRequest request) → Future<ListTrainingPipelinesResponse>
Lists TrainingPipelines in a Location.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setIamPolicy(SetIamPolicyRequest request) → Future<Policy>
Sets the access control policy on the specified resource. Replaces any existing policy.
testIamPermissions(TestIamPermissionsRequest request) → Future<TestIamPermissionsResponse>
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
toString() → String
A string representation of this object.
inherited
waitOperation(WaitOperationRequest request) → Future<Operation<ProtoMessage, ProtoMessage>>
Provides the Operations service functionality in this service.

Operators

operator ==(Object other) → bool
The equality operator.
inherited