Class PipelineServiceClient (2.5.3)

Version 2.5.3

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class PipelineServiceClient implements 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 AI 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.

Inheritance

java.lang.Object > PipelineServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

PipelineServiceClient(PipelineServiceSettings settings)

protected PipelineServiceClient(PipelineServiceSettings settings)

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.

Parameter

Name	Description
settings	PipelineServiceSettings

PipelineServiceClient(PipelineServiceStub stub)

protected PipelineServiceClient(PipelineServiceStub stub)

Parameter

Name	Description
stub	PipelineServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

cancelPipelineJob(CancelPipelineJobRequest request)

public final void cancelPipelineJob(CancelPipelineJobRequest request)

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.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   CancelPipelineJobRequest request =
       CancelPipelineJobRequest.newBuilder()
           .setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
           .build();
   pipelineServiceClient.cancelPipelineJob(request);
 }
 

Parameter

Name	Description
request	CancelPipelineJobRequest The request object containing all of the parameters for the API call.

cancelPipelineJob(PipelineJobName name)

public final void cancelPipelineJob(PipelineJobName name)

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.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   PipelineJobName name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]");
   pipelineServiceClient.cancelPipelineJob(name);
 }
 

Parameter

Name	Description
name	PipelineJobName Required. The name of the PipelineJob to cancel. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

cancelPipelineJob(String name)

public final void cancelPipelineJob(String name)

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.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString();
   pipelineServiceClient.cancelPipelineJob(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the PipelineJob to cancel. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

cancelPipelineJobCallable()

public final UnaryCallable<CancelPipelineJobRequest,Empty> cancelPipelineJobCallable()

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.

Sample code:

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

Returns

Type	Description
UnaryCallable<CancelPipelineJobRequest,Empty>

cancelTrainingPipeline(CancelTrainingPipelineRequest request)

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

Sample code:

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

Parameter

Name	Description
request	CancelTrainingPipelineRequest The request object containing all of the parameters for the API call.

cancelTrainingPipeline(TrainingPipelineName name)

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

Sample code:

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

Parameter

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

cancelTrainingPipeline(String name)

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

Sample code:

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

Parameter

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

cancelTrainingPipelineCallable()

public final UnaryCallable<CancelTrainingPipelineRequest,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 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.

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();
 }
 

Returns

Type	Description
UnaryCallable<CancelTrainingPipelineRequest,Empty>

close()

public final void close()

create()

public static final PipelineServiceClient create()

Constructs an instance of PipelineServiceClient with default settings.

Returns

Type	Description
PipelineServiceClient

Exceptions

Type	Description
IOException

create(PipelineServiceSettings settings)

public static final PipelineServiceClient create(PipelineServiceSettings settings)

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.

Parameter

Name	Description
settings	PipelineServiceSettings

Returns

Type	Description
PipelineServiceClient

Exceptions

Type	Description
IOException

create(PipelineServiceStub stub)

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

Parameter

Name	Description
stub	PipelineServiceStub

Returns

Type	Description
PipelineServiceClient

createPipelineJob(CreatePipelineJobRequest request)

public final PipelineJob createPipelineJob(CreatePipelineJobRequest request)

Creates a PipelineJob. A PipelineJob will run immediately when created.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   CreatePipelineJobRequest request =
       CreatePipelineJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPipelineJob(PipelineJob.newBuilder().build())
           .setPipelineJobId("pipelineJobId-1711315914")
           .build();
   PipelineJob response = pipelineServiceClient.createPipelineJob(request);
 }
 

Parameter

Name	Description
request	CreatePipelineJobRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
PipelineJob

createPipelineJob(LocationName parent, PipelineJob pipelineJob, String pipelineJobId)

public final PipelineJob createPipelineJob(LocationName parent, PipelineJob pipelineJob, String pipelineJobId)

Creates a PipelineJob. A PipelineJob will run immediately when created.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PipelineJob pipelineJob = PipelineJob.newBuilder().build();
   String pipelineJobId = "pipelineJobId-1711315914";
   PipelineJob response =
       pipelineServiceClient.createPipelineJob(parent, pipelineJob, pipelineJobId);
 }
 

Parameters

Name	Description
parent	LocationName Required. The resource name of the Location to create the PipelineJob in. Format: projects/{project}/locations/{location}
pipelineJob	PipelineJob Required. The PipelineJob to create.
pipelineJobId	String The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are /a-z-/.

Returns

Type	Description
PipelineJob

createPipelineJob(String parent, PipelineJob pipelineJob, String pipelineJobId)

public final PipelineJob createPipelineJob(String parent, PipelineJob pipelineJob, String pipelineJobId)

Creates a PipelineJob. A PipelineJob will run immediately when created.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   PipelineJob pipelineJob = PipelineJob.newBuilder().build();
   String pipelineJobId = "pipelineJobId-1711315914";
   PipelineJob response =
       pipelineServiceClient.createPipelineJob(parent, pipelineJob, pipelineJobId);
 }
 

Parameters

Name	Description
parent	String Required. The resource name of the Location to create the PipelineJob in. Format: projects/{project}/locations/{location}
pipelineJob	PipelineJob Required. The PipelineJob to create.
pipelineJobId	String The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are /a-z-/.

Returns

Type	Description
PipelineJob

createPipelineJobCallable()

public final UnaryCallable<CreatePipelineJobRequest,PipelineJob> createPipelineJobCallable()

Creates a PipelineJob. A PipelineJob will run immediately when created.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   CreatePipelineJobRequest request =
       CreatePipelineJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPipelineJob(PipelineJob.newBuilder().build())
           .setPipelineJobId("pipelineJobId-1711315914")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreatePipelineJobRequest,PipelineJob>

createTrainingPipeline(CreateTrainingPipelineRequest request)

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);
 }
 

Parameter

Name	Description
request	CreateTrainingPipelineRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TrainingPipeline

createTrainingPipeline(LocationName parent, TrainingPipeline trainingPipeline)

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

Name	Description
parent	LocationName Required. The resource name of the Location to create the TrainingPipeline in. Format: projects/{project}/locations/{location}
trainingPipeline	TrainingPipeline Required. The TrainingPipeline to create.

Returns

Type	Description
TrainingPipeline

createTrainingPipeline(String parent, TrainingPipeline trainingPipeline)

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

Name	Description
parent	String Required. The resource name of the Location to create the TrainingPipeline in. Format: projects/{project}/locations/{location}
trainingPipeline	TrainingPipeline Required. The TrainingPipeline to create.

Returns

Type	Description
TrainingPipeline

createTrainingPipelineCallable()

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

Returns

Type	Description
UnaryCallable<CreateTrainingPipelineRequest,TrainingPipeline>

deletePipelineJobAsync(DeletePipelineJobRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deletePipelineJobAsync(DeletePipelineJobRequest request)

Deletes a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   DeletePipelineJobRequest request =
       DeletePipelineJobRequest.newBuilder()
           .setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
           .build();
   pipelineServiceClient.deletePipelineJobAsync(request).get();
 }
 

Parameter

Name	Description
request	DeletePipelineJobRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deletePipelineJobAsync(PipelineJobName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deletePipelineJobAsync(PipelineJobName name)

Deletes a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   PipelineJobName name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]");
   pipelineServiceClient.deletePipelineJobAsync(name).get();
 }
 

Parameter

Name	Description
name	PipelineJobName Required. The name of the PipelineJob resource to be deleted. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deletePipelineJobAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deletePipelineJobAsync(String name)

Deletes a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString();
   pipelineServiceClient.deletePipelineJobAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the PipelineJob resource to be deleted. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deletePipelineJobCallable()

public final UnaryCallable<DeletePipelineJobRequest,Operation> deletePipelineJobCallable()

Deletes a PipelineJob.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeletePipelineJobRequest,Operation>

deletePipelineJobOperationCallable()

public final OperationCallable<DeletePipelineJobRequest,Empty,DeleteOperationMetadata> deletePipelineJobOperationCallable()

Deletes a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   DeletePipelineJobRequest request =
       DeletePipelineJobRequest.newBuilder()
           .setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeletePipelineJobRequest,Empty,DeleteOperationMetadata>

deleteTrainingPipelineAsync(DeleteTrainingPipelineRequest request)

public final OperationFuture<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();
 }
 

Parameter

Name	Description
request	DeleteTrainingPipelineRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTrainingPipelineAsync(TrainingPipelineName name)

public final OperationFuture<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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTrainingPipelineAsync(String name)

public final OperationFuture<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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTrainingPipelineCallable()

public final UnaryCallable<DeleteTrainingPipelineRequest,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();
 }
 

Returns

Type	Description
UnaryCallable<DeleteTrainingPipelineRequest,Operation>

deleteTrainingPipelineOperationCallable()

public final OperationCallable<DeleteTrainingPipelineRequest,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

Returns

Type	Description
OperationCallable<DeleteTrainingPipelineRequest,Empty,DeleteOperationMetadata>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns

Type	Description
OperationsClient

getPipelineJob(GetPipelineJobRequest request)

public final PipelineJob getPipelineJob(GetPipelineJobRequest request)

Gets a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   GetPipelineJobRequest request =
       GetPipelineJobRequest.newBuilder()
           .setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
           .build();
   PipelineJob response = pipelineServiceClient.getPipelineJob(request);
 }
 

Parameter

Name	Description
request	GetPipelineJobRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
PipelineJob

getPipelineJob(PipelineJobName name)

public final PipelineJob getPipelineJob(PipelineJobName name)

Gets a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   PipelineJobName name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]");
   PipelineJob response = pipelineServiceClient.getPipelineJob(name);
 }
 

Parameter

Name	Description
name	PipelineJobName Required. The name of the PipelineJob resource. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Returns

Type	Description
PipelineJob

getPipelineJob(String name)

public final PipelineJob getPipelineJob(String name)

Gets a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String name = PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString();
   PipelineJob response = pipelineServiceClient.getPipelineJob(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the PipelineJob resource. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

Returns

Type	Description
PipelineJob

getPipelineJobCallable()

public final UnaryCallable<GetPipelineJobRequest,PipelineJob> getPipelineJobCallable()

Gets a PipelineJob.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   GetPipelineJobRequest request =
       GetPipelineJobRequest.newBuilder()
           .setName(PipelineJobName.of("[PROJECT]", "[LOCATION]", "[PIPELINE_JOB]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetPipelineJobRequest,PipelineJob>

getSettings()

public final PipelineServiceSettings getSettings()

Returns

Type	Description
PipelineServiceSettings

getStub()

public PipelineServiceStub getStub()

Returns

Type	Description
PipelineServiceStub

getTrainingPipeline(GetTrainingPipelineRequest request)

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);
 }
 

Parameter

Name	Description
request	GetTrainingPipelineRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TrainingPipeline

getTrainingPipeline(TrainingPipelineName name)

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);
 }
 

Parameter

Name	Description
name	TrainingPipelineName Required. The name of the TrainingPipeline resource. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Returns

Type	Description
TrainingPipeline

getTrainingPipeline(String name)

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);
 }
 

Parameter

Name	Description
name	String Required. The name of the TrainingPipeline resource. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Returns

Type	Description
TrainingPipeline

getTrainingPipelineCallable()

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

Returns

Type	Description
UnaryCallable<GetTrainingPipelineRequest,TrainingPipeline>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listPipelineJobs(ListPipelineJobsRequest request)

public final PipelineServiceClient.ListPipelineJobsPagedResponse listPipelineJobs(ListPipelineJobsRequest request)

Lists PipelineJobs in a Location.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   ListPipelineJobsRequest request =
       ListPipelineJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (PipelineJob element : pipelineServiceClient.listPipelineJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListPipelineJobsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
PipelineServiceClient.ListPipelineJobsPagedResponse

listPipelineJobs(LocationName parent)

public final PipelineServiceClient.ListPipelineJobsPagedResponse listPipelineJobs(LocationName parent)

Lists PipelineJobs in a Location.

Sample code:

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

Parameter

Name	Description
parent	LocationName Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}

Returns

Type	Description
PipelineServiceClient.ListPipelineJobsPagedResponse

listPipelineJobs(String parent)

public final PipelineServiceClient.ListPipelineJobsPagedResponse listPipelineJobs(String parent)

Lists PipelineJobs in a Location.

Sample code:

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

Parameter

Name	Description
parent	String Required. The resource name of the Location to list the PipelineJobs from. Format: projects/{project}/locations/{location}

Returns

Type	Description
PipelineServiceClient.ListPipelineJobsPagedResponse

listPipelineJobsCallable()

public final UnaryCallable<ListPipelineJobsRequest,ListPipelineJobsResponse> listPipelineJobsCallable()

Lists PipelineJobs in a Location.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListPipelineJobsRequest,ListPipelineJobsResponse>

listPipelineJobsPagedCallable()

public final UnaryCallable<ListPipelineJobsRequest,PipelineServiceClient.ListPipelineJobsPagedResponse> listPipelineJobsPagedCallable()

Lists PipelineJobs in a Location.

Sample code:

 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   ListPipelineJobsRequest request =
       ListPipelineJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPipelineJobsRequest,ListPipelineJobsPagedResponse>

listTrainingPipelines(ListTrainingPipelinesRequest request)

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);
   }
 }
 

Parameter

Name	Description
request	ListTrainingPipelinesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
PipelineServiceClient.ListTrainingPipelinesPagedResponse

listTrainingPipelines(LocationName parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
PipelineServiceClient.ListTrainingPipelinesPagedResponse

listTrainingPipelines(String parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
PipelineServiceClient.ListTrainingPipelinesPagedResponse

listTrainingPipelinesCallable()

public final 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse>

listTrainingPipelinesPagedCallable()

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

Returns

Type	Description
UnaryCallable<ListTrainingPipelinesRequest,ListTrainingPipelinesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()