Class WorkflowsServiceV2BetaClient (0.8.0)

public class WorkflowsServiceV2BetaClient implements BackgroundResource

Service Description: A service for running workflows, such as pipelines consisting of Docker containers.

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 (WorkflowsServiceV2BetaClient workflowsServiceV2BetaClient =
     WorkflowsServiceV2BetaClient.create()) {
   RunPipelineRequest request =
       RunPipelineRequest.newBuilder()
           .setParent("parent-995424086")
           .setPipeline(Pipeline.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setPubSubTopic("pubSubTopic320524524")
           .build();
   RunPipelineResponse response = workflowsServiceV2BetaClient.runPipelineAsync(request).get();
 }

Note: close() needs to be called on the WorkflowsServiceV2BetaClient 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:

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.
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.
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 WorkflowsServiceV2BetaSettings 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
 WorkflowsServiceV2BetaSettings workflowsServiceV2BetaSettings =
     WorkflowsServiceV2BetaSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WorkflowsServiceV2BetaClient workflowsServiceV2BetaClient =
     WorkflowsServiceV2BetaClient.create(workflowsServiceV2BetaSettings);

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
 WorkflowsServiceV2BetaSettings workflowsServiceV2BetaSettings =
     WorkflowsServiceV2BetaSettings.newBuilder().setEndpoint(myEndpoint).build();
 WorkflowsServiceV2BetaClient workflowsServiceV2BetaClient =
     WorkflowsServiceV2BetaClient.create(workflowsServiceV2BetaSettings);

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
 WorkflowsServiceV2BetaSettings workflowsServiceV2BetaSettings =
     WorkflowsServiceV2BetaSettings.newHttpJsonBuilder().build();
 WorkflowsServiceV2BetaClient workflowsServiceV2BetaClient =
     WorkflowsServiceV2BetaClient.create(workflowsServiceV2BetaSettings);

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

Inheritance

java.lang.Object > WorkflowsServiceV2BetaClient

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)

Static Methods

create()

public static final WorkflowsServiceV2BetaClient create()

Constructs an instance of WorkflowsServiceV2BetaClient with default settings.

Returns

Type	Description
WorkflowsServiceV2BetaClient

Exceptions

Type	Description
IOException

create(WorkflowsServiceV2BetaSettings settings)

public static final WorkflowsServiceV2BetaClient create(WorkflowsServiceV2BetaSettings settings)

Constructs an instance of WorkflowsServiceV2BetaClient, 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	`WorkflowsServiceV2BetaSettings`

Returns

Type	Description
WorkflowsServiceV2BetaClient

Exceptions

Type	Description
IOException

create(WorkflowsServiceV2BetaStub stub)

public static final WorkflowsServiceV2BetaClient create(WorkflowsServiceV2BetaStub stub)

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

Parameter

Name	Description
stub	`WorkflowsServiceV2BetaStub`

Returns

Type	Description
WorkflowsServiceV2BetaClient

Constructors

WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaSettings settings)

protected WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaSettings settings)

Constructs an instance of WorkflowsServiceV2BetaClient, 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	`WorkflowsServiceV2BetaSettings`

WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaStub stub)

protected WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaStub stub)

Parameter

Name	Description
stub	`WorkflowsServiceV2BetaStub`

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

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 WorkflowsServiceV2BetaSettings getSettings()

Returns

Type	Description
WorkflowsServiceV2BetaSettings

getStub()

public WorkflowsServiceV2BetaStub getStub()

Returns

Type	Description
WorkflowsServiceV2BetaStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

runPipelineAsync(RunPipelineRequest request)

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

Runs a pipeline. The returned Operation's [metadata] [google.longrunning.Operation.metadata] field will contain a google.cloud.lifesciences.v2beta.Metadata object describing the status of the pipeline execution. The response field will contain a google.cloud.lifesciences.v2beta.RunPipelineResponse object if the pipeline completes successfully.

**Note:** Before you can use this method, the *Life Sciences Service Agent* must have access to your project. This is done automatically when the Cloud Life Sciences API is first enabled, but if you delete this permission you must disable and re-enable the API to grant the Life Sciences Service Agent the required permissions. Authorization requires the following Google IAM permission:

lifesciences.workflows.run

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 (WorkflowsServiceV2BetaClient workflowsServiceV2BetaClient =
     WorkflowsServiceV2BetaClient.create()) {
   RunPipelineRequest request =
       RunPipelineRequest.newBuilder()
           .setParent("parent-995424086")
           .setPipeline(Pipeline.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setPubSubTopic("pubSubTopic320524524")
           .build();
   RunPipelineResponse response = workflowsServiceV2BetaClient.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,Metadata>

runPipelineCallable()

public final UnaryCallable<RunPipelineRequest,Operation> runPipelineCallable()

lifesciences.workflows.run

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 (WorkflowsServiceV2BetaClient workflowsServiceV2BetaClient =
     WorkflowsServiceV2BetaClient.create()) {
   RunPipelineRequest request =
       RunPipelineRequest.newBuilder()
           .setParent("parent-995424086")
           .setPipeline(Pipeline.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setPubSubTopic("pubSubTopic320524524")
           .build();
   ApiFuture<Operation> future =
       workflowsServiceV2BetaClient.runPipelineCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<RunPipelineRequest,Operation>

runPipelineOperationCallable()

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

lifesciences.workflows.run

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 (WorkflowsServiceV2BetaClient workflowsServiceV2BetaClient =
     WorkflowsServiceV2BetaClient.create()) {
   RunPipelineRequest request =
       RunPipelineRequest.newBuilder()
           .setParent("parent-995424086")
           .setPipeline(Pipeline.newBuilder().build())
           .putAllLabels(new HashMap<String, String>())
           .setPubSubTopic("pubSubTopic320524524")
           .build();
   OperationFuture<RunPipelineResponse, Metadata> future =
       workflowsServiceV2BetaClient.runPipelineOperationCallable().futureCall(request);
   // Do something.
   RunPipelineResponse response = future.get();
 }

Returns

Type	Description
OperationCallable<RunPipelineRequest,RunPipelineResponse,Metadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()