Class PipelineServiceClient (0.28.0)

Version 0.28.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

GitHub Repository

Product Reference

Service Description: This service lets you manage 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:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   LocationName name = LocationName.of("[PROJECT]", "[LOCATION]");
   RunPipelineResponse response = pipelineServiceClient.runPipelineAsync(name).get();
 }
 

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:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PipelineServiceSettings pipelineServiceSettings =
     PipelineServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PipelineServiceClient pipelineServiceClient =
     PipelineServiceClient.create(pipelineServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PipelineServiceSettings pipelineServiceSettings =
     PipelineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PipelineServiceClient pipelineServiceClient =
     PipelineServiceClient.create(pipelineServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PipelineServiceSettings pipelineServiceSettings =
     PipelineServiceSettings.newHttpJsonBuilder().build();
 PipelineServiceClient pipelineServiceClient =
     PipelineServiceClient.create(pipelineServiceSettings);
 

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

Inheritance

java.lang.Object > PipelineServiceClient

Static Methods

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

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

close()

public final void close()

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

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

getSettings()

public final PipelineServiceSettings getSettings()

Returns
Type	Description
PipelineServiceSettings

getStub()

public PipelineServiceStub getStub()

Returns
Type	Description
PipelineServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

runPipelineAsync(LocationName name)

public final OperationFuture<RunPipelineResponse,RunPipelineMetadata> runPipelineAsync(LocationName name)

Run a predefined pipeline.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   LocationName name = LocationName.of("[PROJECT]", "[LOCATION]");
   RunPipelineResponse response = pipelineServiceClient.runPipelineAsync(name).get();
 }
 

Parameter
Name	Description
name	LocationName Required. The resource name which owns the resources of the pipeline. Format: projects/{project_number}/locations/{location}.

Returns
Type	Description
OperationFuture<RunPipelineResponse,RunPipelineMetadata>

runPipelineAsync(RunPipelineRequest request)

public final OperationFuture<RunPipelineResponse,RunPipelineMetadata> runPipelineAsync(RunPipelineRequest request)

Run a predefined pipeline.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   RunPipelineRequest request =
       RunPipelineRequest.newBuilder()
           .setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   RunPipelineResponse response = pipelineServiceClient.runPipelineAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<RunPipelineResponse,RunPipelineMetadata>

runPipelineAsync(String name)

public final OperationFuture<RunPipelineResponse,RunPipelineMetadata> runPipelineAsync(String name)

Run a predefined pipeline.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   String name = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   RunPipelineResponse response = pipelineServiceClient.runPipelineAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. The resource name which owns the resources of the pipeline. Format: projects/{project_number}/locations/{location}.

Returns
Type	Description
OperationFuture<RunPipelineResponse,RunPipelineMetadata>

runPipelineCallable()

public final UnaryCallable<RunPipelineRequest,Operation> runPipelineCallable()

Run a predefined pipeline.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   RunPipelineRequest request =
       RunPipelineRequest.newBuilder()
           .setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   ApiFuture<Operation> future = pipelineServiceClient.runPipelineCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<RunPipelineRequest,Operation>

runPipelineOperationCallable()

public final OperationCallable<RunPipelineRequest,RunPipelineResponse,RunPipelineMetadata> runPipelineOperationCallable()

Run a predefined pipeline.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
   RunPipelineRequest request =
       RunPipelineRequest.newBuilder()
           .setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRequestMetadata(RequestMetadata.newBuilder().build())
           .build();
   OperationFuture<RunPipelineResponse, RunPipelineMetadata> future =
       pipelineServiceClient.runPipelineOperationCallable().futureCall(request);
   // Do something.
   RunPipelineResponse response = future.get();
 }
 

Returns
Type	Description
OperationCallable<RunPipelineRequest,RunPipelineResponse,RunPipelineMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()