com.google.cloud.aiplatform.v1

Class PipelineServiceClient

java.lang.Object

com.google.cloud.aiplatform.v1.PipelineServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class PipelineServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: 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 Pipelines).

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
   TrainingPipeline response =
       pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
 }
 

Note: close() needs to be called on the PipelineServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of PipelineServiceSettings to create(). For example:

To customize credentials:

 PipelineServiceSettings pipelineServiceSettings =
     PipelineServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PipelineServiceClient pipelineServiceClient =
     PipelineServiceClient.create(pipelineServiceSettings);
 

To customize the endpoint:

 PipelineServiceSettings pipelineServiceSettings =
     PipelineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PipelineServiceClient pipelineServiceClient =
     PipelineServiceClient.create(pipelineServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipelineServiceClient.ListTrainingPipelinesFixedSizeCollection
static class	PipelineServiceClient.ListTrainingPipelinesPage
static class	PipelineServiceClient.ListTrainingPipelinesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PipelineServiceClient(PipelineServiceSettings settings) Constructs an instance of PipelineServiceClient, using the given settings.
protected	PipelineServiceClient(PipelineServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	cancelTrainingPipeline(CancelTrainingPipelineRequest request) Cancels a TrainingPipeline.
void	cancelTrainingPipeline(String name) Cancels a TrainingPipeline.
void	cancelTrainingPipeline(TrainingPipelineName name) Cancels a TrainingPipeline.
com.google.api.gax.rpc.UnaryCallable<CancelTrainingPipelineRequest,com.google.protobuf.Empty>	cancelTrainingPipelineCallable() Cancels a TrainingPipeline.
void	close()
static PipelineServiceClient	create() Constructs an instance of PipelineServiceClient with default settings.
static PipelineServiceClient	create(PipelineServiceSettings settings) Constructs an instance of PipelineServiceClient, using the given settings.
static PipelineServiceClient	create(PipelineServiceStub stub) Constructs an instance of PipelineServiceClient, using the given stub for making calls.
TrainingPipeline	createTrainingPipeline(CreateTrainingPipelineRequest request) Creates a TrainingPipeline.
TrainingPipeline	createTrainingPipeline(LocationName parent, TrainingPipeline trainingPipeline) Creates a TrainingPipeline.
TrainingPipeline	createTrainingPipeline(String parent, TrainingPipeline trainingPipeline) Creates a TrainingPipeline.
com.google.api.gax.rpc.UnaryCallable<CreateTrainingPipelineRequest,TrainingPipeline>	createTrainingPipelineCallable() Creates a TrainingPipeline.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request) Deletes a TrainingPipeline.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteTrainingPipelineAsync(String name) Deletes a TrainingPipeline.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteTrainingPipelineAsync(TrainingPipelineName name) Deletes a TrainingPipeline.
com.google.api.gax.rpc.UnaryCallable<DeleteTrainingPipelineRequest,com.google.longrunning.Operation>	deleteTrainingPipelineCallable() Deletes a TrainingPipeline.
com.google.api.gax.rpc.OperationCallable<DeleteTrainingPipelineRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteTrainingPipelineOperationCallable() Deletes a TrainingPipeline.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
PipelineServiceSettings	getSettings()
PipelineServiceStub	getStub()
TrainingPipeline	getTrainingPipeline(GetTrainingPipelineRequest request) Gets a TrainingPipeline.
TrainingPipeline	getTrainingPipeline(String name) Gets a TrainingPipeline.
TrainingPipeline	getTrainingPipeline(TrainingPipelineName name) Gets a TrainingPipeline.
com.google.api.gax.rpc.UnaryCallable<GetTrainingPipelineRequest,TrainingPipeline>	getTrainingPipelineCallable() Gets a TrainingPipeline.
boolean	isShutdown()
boolean	isTerminated()
PipelineServiceClient.ListTrainingPipelinesPagedResponse	listTrainingPipelines(ListTrainingPipelinesRequest request) Lists TrainingPipelines in a Location.
PipelineServiceClient.ListTrainingPipelinesPagedResponse	listTrainingPipelines(LocationName parent) Lists TrainingPipelines in a Location.
PipelineServiceClient.ListTrainingPipelinesPagedResponse	listTrainingPipelines(String parent) Lists TrainingPipelines in a Location.
com.google.api.gax.rpc.UnaryCallable<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse>	listTrainingPipelinesCallable() Lists TrainingPipelines in a Location.
com.google.api.gax.rpc.UnaryCallable<ListTrainingPipelinesRequest,PipelineServiceClient.ListTrainingPipelinesPagedResponse>	listTrainingPipelinesPagedCallable() Lists TrainingPipelines in a Location.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PipelineServiceClient

protected PipelineServiceClient(PipelineServiceSettings settings)
                         throws IOException

Constructs an instance of PipelineServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

PipelineServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected PipelineServiceClient(PipelineServiceStub stub)

Method Detail

create

public static final PipelineServiceClient create()
                                          throws IOException

Constructs an instance of PipelineServiceClient with default settings.

Throws:

IOException

create

public static final PipelineServiceClient create(PipelineServiceSettings settings)
                                          throws IOException

Constructs an instance of PipelineServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final PipelineServiceClient create(PipelineServiceStub stub)

Constructs an instance of PipelineServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PipelineServiceSettings).

getSettings

public final PipelineServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public PipelineServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createTrainingPipeline

public final TrainingPipeline createTrainingPipeline(LocationName parent,
                                                     TrainingPipeline trainingPipeline)

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
   TrainingPipeline response =
       pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
 }
 

Parameters:

parent - Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`

trainingPipeline - Required. The TrainingPipeline to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTrainingPipeline

public final TrainingPipeline createTrainingPipeline(String parent,
                                                     TrainingPipeline trainingPipeline)

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
   TrainingPipeline response =
       pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
 }
 

Parameters:

parent - Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`

trainingPipeline - Required. The TrainingPipeline to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTrainingPipeline

public final TrainingPipeline createTrainingPipeline(CreateTrainingPipelineRequest request)

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   CreateTrainingPipelineRequest request =
       CreateTrainingPipelineRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTrainingPipeline(TrainingPipeline.newBuilder().build())
           .build();
   TrainingPipeline response = pipelineServiceClient.createTrainingPipeline(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTrainingPipelineCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTrainingPipelineRequest,TrainingPipeline> createTrainingPipelineCallable()

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   CreateTrainingPipelineRequest request =
       CreateTrainingPipelineRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTrainingPipeline(TrainingPipeline.newBuilder().build())
           .build();
   ApiFuture<TrainingPipeline> future =
       pipelineServiceClient.createTrainingPipelineCallable().futureCall(request);
   // Do something.
   TrainingPipeline response = future.get();
 }
 

getTrainingPipeline

public final TrainingPipeline getTrainingPipeline(TrainingPipelineName name)

Gets a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   TrainingPipelineName name =
       TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
   TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(name);
 }
 

Parameters:

name - Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTrainingPipeline

public final TrainingPipeline getTrainingPipeline(String name)

Gets a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String name =
       TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
   TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(name);
 }
 

Parameters:

name - Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTrainingPipeline

public final TrainingPipeline getTrainingPipeline(GetTrainingPipelineRequest request)

Gets a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   GetTrainingPipelineRequest request =
       GetTrainingPipelineRequest.newBuilder()
           .setName(
               TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
                   .toString())
           .build();
   TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTrainingPipelineCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTrainingPipelineRequest,TrainingPipeline> getTrainingPipelineCallable()

Gets a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   GetTrainingPipelineRequest request =
       GetTrainingPipelineRequest.newBuilder()
           .setName(
               TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
                   .toString())
           .build();
   ApiFuture<TrainingPipeline> future =
       pipelineServiceClient.getTrainingPipelineCallable().futureCall(request);
   // Do something.
   TrainingPipeline response = future.get();
 }
 

listTrainingPipelines

public final PipelineServiceClient.ListTrainingPipelinesPagedResponse listTrainingPipelines(LocationName parent)

Lists TrainingPipelines in a Location.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (TrainingPipeline element :
       pipelineServiceClient.listTrainingPipelines(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTrainingPipelines

public final PipelineServiceClient.ListTrainingPipelinesPagedResponse listTrainingPipelines(String parent)

Lists TrainingPipelines in a Location.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (TrainingPipeline element :
       pipelineServiceClient.listTrainingPipelines(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTrainingPipelines

public final PipelineServiceClient.ListTrainingPipelinesPagedResponse listTrainingPipelines(ListTrainingPipelinesRequest request)

Lists TrainingPipelines in a Location.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   ListTrainingPipelinesRequest request =
       ListTrainingPipelinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (TrainingPipeline element :
       pipelineServiceClient.listTrainingPipelines(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTrainingPipelinesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTrainingPipelinesRequest,PipelineServiceClient.ListTrainingPipelinesPagedResponse> listTrainingPipelinesPagedCallable()

Lists TrainingPipelines in a Location.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   ListTrainingPipelinesRequest request =
       ListTrainingPipelinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<TrainingPipeline> future =
       pipelineServiceClient.listTrainingPipelinesPagedCallable().futureCall(request);
   // Do something.
   for (TrainingPipeline element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTrainingPipelinesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse> listTrainingPipelinesCallable()

Lists TrainingPipelines in a Location.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   ListTrainingPipelinesRequest request =
       ListTrainingPipelinesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListTrainingPipelinesResponse response =
         pipelineServiceClient.listTrainingPipelinesCallable().call(request);
     for (TrainingPipeline element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteTrainingPipelineAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteTrainingPipelineAsync(TrainingPipelineName name)

Deletes a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   TrainingPipelineName name =
       TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
   pipelineServiceClient.deleteTrainingPipelineAsync(name).get();
 }
 

Parameters:

name - Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTrainingPipelineAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteTrainingPipelineAsync(String name)

Deletes a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String name =
       TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
   pipelineServiceClient.deleteTrainingPipelineAsync(name).get();
 }
 

Parameters:

name - Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTrainingPipelineAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request)

Deletes a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   DeleteTrainingPipelineRequest request =
       DeleteTrainingPipelineRequest.newBuilder()
           .setName(
               TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
                   .toString())
           .build();
   pipelineServiceClient.deleteTrainingPipelineAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTrainingPipelineOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteTrainingPipelineRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteTrainingPipelineOperationCallable()

Deletes a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   DeleteTrainingPipelineRequest request =
       DeleteTrainingPipelineRequest.newBuilder()
           .setName(
               TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       pipelineServiceClient.deleteTrainingPipelineOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

deleteTrainingPipelineCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTrainingPipelineRequest,com.google.longrunning.Operation> deleteTrainingPipelineCallable()

Deletes a TrainingPipeline.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   DeleteTrainingPipelineRequest request =
       DeleteTrainingPipelineRequest.newBuilder()
           .setName(
               TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       pipelineServiceClient.deleteTrainingPipelineCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

cancelTrainingPipeline

public final void cancelTrainingPipeline(TrainingPipelineName name)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to `CANCELLED`.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   TrainingPipelineName name =
       TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
   pipelineServiceClient.cancelTrainingPipeline(name);
 }
 

Parameters:

name - Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

cancelTrainingPipeline

public final void cancelTrainingPipeline(String name)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to `CANCELLED`.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String name =
       TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
   pipelineServiceClient.cancelTrainingPipeline(name);
 }
 

Parameters:

name - Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

cancelTrainingPipeline

public final void cancelTrainingPipeline(CancelTrainingPipelineRequest request)

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to `CANCELLED`.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   CancelTrainingPipelineRequest request =
       CancelTrainingPipelineRequest.newBuilder()
           .setName(
               TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
                   .toString())
           .build();
   pipelineServiceClient.cancelTrainingPipeline(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

cancelTrainingPipelineCallable

public final com.google.api.gax.rpc.UnaryCallable<CancelTrainingPipelineRequest,com.google.protobuf.Empty> cancelTrainingPipelineCallable()

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][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to `CANCELLED`.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   CancelTrainingPipelineRequest request =
       CancelTrainingPipelineRequest.newBuilder()
           .setName(
               TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       pipelineServiceClient.cancelTrainingPipelineCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException