Class WorkflowsServiceV2BetaClient
- java.lang.Object
-
- com.google.cloud.lifesciences.v2beta.WorkflowsServiceV2BetaClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class WorkflowsServiceV2BetaClient extends Object implements com.google.api.gax.core.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()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); Location response = workflowsServiceV2BetaClient.getLocation(request); }
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WorkflowsServiceV2BetaClient.ListLocationsFixedSizeCollection
static class
WorkflowsServiceV2BetaClient.ListLocationsPage
static class
WorkflowsServiceV2BetaClient.ListLocationsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaStub stub)
protected
WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaSettings settings)
Constructs an instance of WorkflowsServiceV2BetaClient, using the given settings.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static WorkflowsServiceV2BetaClient
create()
Constructs an instance of WorkflowsServiceV2BetaClient with default settings.static WorkflowsServiceV2BetaClient
create(WorkflowsServiceV2BetaStub stub)
Constructs an instance of WorkflowsServiceV2BetaClient, using the given stub for making calls.static WorkflowsServiceV2BetaClient
create(WorkflowsServiceV2BetaSettings settings)
Constructs an instance of WorkflowsServiceV2BetaClient, using the given settings.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.cloud.location.Location
getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationCallable()
Gets information about a location.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.WorkflowsServiceV2BetaSettings
getSettings()
WorkflowsServiceV2BetaStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
WorkflowsServiceV2BetaClient.ListLocationsPagedResponse
listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>
listLocationsCallable()
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,WorkflowsServiceV2BetaClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.com.google.api.gax.longrunning.OperationFuture<RunPipelineResponse,Metadata>
runPipelineAsync(RunPipelineRequest request)
Runs a pipeline.com.google.api.gax.rpc.UnaryCallable<RunPipelineRequest,com.google.longrunning.Operation>
runPipelineCallable()
Runs a pipeline.com.google.api.gax.rpc.OperationCallable<RunPipelineRequest,RunPipelineResponse,Metadata>
runPipelineOperationCallable()
Runs a pipeline.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
WorkflowsServiceV2BetaClient
protected WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaSettings settings) throws IOException
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.- Throws:
IOException
-
WorkflowsServiceV2BetaClient
protected WorkflowsServiceV2BetaClient(WorkflowsServiceV2BetaStub stub)
-
-
Method Detail
-
create
public static final WorkflowsServiceV2BetaClient create() throws IOException
Constructs an instance of WorkflowsServiceV2BetaClient with default settings.- Throws:
IOException
-
create
public static final WorkflowsServiceV2BetaClient create(WorkflowsServiceV2BetaSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final WorkflowsServiceV2BetaSettings getSettings()
-
getStub
public WorkflowsServiceV2BetaStub 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.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
runPipelineAsync
public final com.google.api.gax.longrunning.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][google.cloud.lifesciences.v2beta.Metadata] object describing the status of the pipeline execution. The [response][google.longrunning.Operation.response] field will contain a [google.cloud.lifesciences.v2beta.RunPipelineResponse][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](https://cloud.google.com/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(); }
- 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
-
runPipelineOperationCallable
public final com.google.api.gax.rpc.OperationCallable<RunPipelineRequest,RunPipelineResponse,Metadata> runPipelineOperationCallable()
Runs a pipeline. The returned Operation's [metadata] [google.longrunning.Operation.metadata] field will contain a [google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata] object describing the status of the pipeline execution. The [response][google.longrunning.Operation.response] field will contain a [google.cloud.lifesciences.v2beta.RunPipelineResponse][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](https://cloud.google.com/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(); OperationFuture<RunPipelineResponse, Metadata> future = workflowsServiceV2BetaClient.runPipelineOperationCallable().futureCall(request); // Do something. RunPipelineResponse response = future.get(); }
-
runPipelineCallable
public final com.google.api.gax.rpc.UnaryCallable<RunPipelineRequest,com.google.longrunning.Operation> runPipelineCallable()
Runs a pipeline. The returned Operation's [metadata] [google.longrunning.Operation.metadata] field will contain a [google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata] object describing the status of the pipeline execution. The [response][google.longrunning.Operation.response] field will contain a [google.cloud.lifesciences.v2beta.RunPipelineResponse][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](https://cloud.google.com/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(); ApiFuture<Operation> future = workflowsServiceV2BetaClient.runPipelineCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listLocations
public final WorkflowsServiceV2BetaClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.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()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : workflowsServiceV2BetaClient.listLocations(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
-
listLocationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,WorkflowsServiceV2BetaClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.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()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = workflowsServiceV2BetaClient.listLocationsPagedCallable().futureCall(request); // Do something. for (Location element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listLocationsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.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()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = workflowsServiceV2BetaClient.listLocationsCallable().call(request); for (Location element : response.getLocationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getLocation
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.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()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); Location response = workflowsServiceV2BetaClient.getLocation(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
-
getLocationCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()
Gets information about a location.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()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); ApiFuture<Location> future = workflowsServiceV2BetaClient.getLocationCallable().futureCall(request); // Do something. Location response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-