A client to Cloud Life Sciences API
The interfaces provided are listed below, along with usage samples.
WorkflowsServiceV2BetaClient
Service Description: A service for running workflows, such as pipelines consisting of Docker containers.
Sample for WorkflowsServiceV2BetaClient:
// 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);
}
Classes
Accelerator
Carries information about an accelerator that can be attached to a VM.
Protobuf type google.cloud.lifesciences.v2beta.Accelerator
Accelerator.Builder
Carries information about an accelerator that can be attached to a VM.
Protobuf type google.cloud.lifesciences.v2beta.Accelerator
Action
Specifies a single action that runs a Docker container.
Protobuf type google.cloud.lifesciences.v2beta.Action
Action.Builder
Specifies a single action that runs a Docker container.
Protobuf type google.cloud.lifesciences.v2beta.Action
ContainerKilledEvent
An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.
Protobuf type google.cloud.lifesciences.v2beta.ContainerKilledEvent
ContainerKilledEvent.Builder
An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.
Protobuf type google.cloud.lifesciences.v2beta.ContainerKilledEvent
ContainerStartedEvent
An event generated when a container starts.
Protobuf type google.cloud.lifesciences.v2beta.ContainerStartedEvent
ContainerStartedEvent.Builder
An event generated when a container starts.
Protobuf type google.cloud.lifesciences.v2beta.ContainerStartedEvent
ContainerStoppedEvent
An event generated when a container exits.
Protobuf type google.cloud.lifesciences.v2beta.ContainerStoppedEvent
ContainerStoppedEvent.Builder
An event generated when a container exits.
Protobuf type google.cloud.lifesciences.v2beta.ContainerStoppedEvent
DelayedEvent
An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.
Protobuf type google.cloud.lifesciences.v2beta.DelayedEvent
DelayedEvent.Builder
An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.
Protobuf type google.cloud.lifesciences.v2beta.DelayedEvent
Disk
Carries information about a disk that can be attached to a VM.
See https://cloud.google.com/compute/docs/disks/performance for more
information about disk type, size, and performance considerations.
Specify either Volume or
Disk, but not both.
Protobuf type google.cloud.lifesciences.v2beta.Disk
Disk.Builder
Carries information about a disk that can be attached to a VM.
See https://cloud.google.com/compute/docs/disks/performance for more
information about disk type, size, and performance considerations.
Specify either Volume or
Disk, but not both.
Protobuf type google.cloud.lifesciences.v2beta.Disk
Event
Carries information about events that occur during pipeline execution.
Protobuf type google.cloud.lifesciences.v2beta.Event
Event.Builder
Carries information about events that occur during pipeline execution.
Protobuf type google.cloud.lifesciences.v2beta.Event
ExistingDisk
Configuration for an existing disk to be attached to the VM.
Protobuf type google.cloud.lifesciences.v2beta.ExistingDisk
ExistingDisk.Builder
Configuration for an existing disk to be attached to the VM.
Protobuf type google.cloud.lifesciences.v2beta.ExistingDisk
FailedEvent
An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.
Protobuf type google.cloud.lifesciences.v2beta.FailedEvent
FailedEvent.Builder
An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.
Protobuf type google.cloud.lifesciences.v2beta.FailedEvent
Metadata
Carries information about the pipeline execution that is returned in the long running operation's metadata field.
Protobuf type google.cloud.lifesciences.v2beta.Metadata
Metadata.Builder
Carries information about the pipeline execution that is returned in the long running operation's metadata field.
Protobuf type google.cloud.lifesciences.v2beta.Metadata
Mount
Carries information about a particular disk mount inside a container.
Protobuf type google.cloud.lifesciences.v2beta.Mount
Mount.Builder
Carries information about a particular disk mount inside a container.
Protobuf type google.cloud.lifesciences.v2beta.Mount
NFSMount
Configuration for an NFSMount to be attached to the VM.
Protobuf type google.cloud.lifesciences.v2beta.NFSMount
NFSMount.Builder
Configuration for an NFSMount to be attached to the VM.
Protobuf type google.cloud.lifesciences.v2beta.NFSMount
Network
VM networking options.
Protobuf type google.cloud.lifesciences.v2beta.Network
Network.Builder
VM networking options.
Protobuf type google.cloud.lifesciences.v2beta.Network
PersistentDisk
Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.
Protobuf type google.cloud.lifesciences.v2beta.PersistentDisk
PersistentDisk.Builder
Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.
Protobuf type google.cloud.lifesciences.v2beta.PersistentDisk
Pipeline
Specifies a series of actions to execute, expressed as Docker containers.
Protobuf type google.cloud.lifesciences.v2beta.Pipeline
Pipeline.Builder
Specifies a series of actions to execute, expressed as Docker containers.
Protobuf type google.cloud.lifesciences.v2beta.Pipeline
PullStartedEvent
An event generated when the worker starts pulling an image.
Protobuf type google.cloud.lifesciences.v2beta.PullStartedEvent
PullStartedEvent.Builder
An event generated when the worker starts pulling an image.
Protobuf type google.cloud.lifesciences.v2beta.PullStartedEvent
PullStoppedEvent
An event generated when the worker stops pulling an image.
Protobuf type google.cloud.lifesciences.v2beta.PullStoppedEvent
PullStoppedEvent.Builder
An event generated when the worker stops pulling an image.
Protobuf type google.cloud.lifesciences.v2beta.PullStoppedEvent
Resources
The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail.
Protobuf type google.cloud.lifesciences.v2beta.Resources
Resources.Builder
The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail.
Protobuf type google.cloud.lifesciences.v2beta.Resources
RunPipelineRequest
The arguments to the RunPipeline method. The requesting user must have
the iam.serviceAccounts.actAs permission for the Cloud Life Sciences
service account or the request will fail.
Protobuf type google.cloud.lifesciences.v2beta.RunPipelineRequest
RunPipelineRequest.Builder
The arguments to the RunPipeline method. The requesting user must have
the iam.serviceAccounts.actAs permission for the Cloud Life Sciences
service account or the request will fail.
Protobuf type google.cloud.lifesciences.v2beta.RunPipelineRequest
RunPipelineResponse
The response to the RunPipeline method, returned in the operation's result field on success.
Protobuf type google.cloud.lifesciences.v2beta.RunPipelineResponse
RunPipelineResponse.Builder
The response to the RunPipeline method, returned in the operation's result field on success.
Protobuf type google.cloud.lifesciences.v2beta.RunPipelineResponse
Secret
Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.
Protobuf type google.cloud.lifesciences.v2beta.Secret
Secret.Builder
Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.
Protobuf type google.cloud.lifesciences.v2beta.Secret
ServiceAccount
Carries information about a Google Cloud service account.
Protobuf type google.cloud.lifesciences.v2beta.ServiceAccount
ServiceAccount.Builder
Carries information about a Google Cloud service account.
Protobuf type google.cloud.lifesciences.v2beta.ServiceAccount
UnexpectedExitStatusEvent
An event generated when the execution of a container results in a
non-zero exit status that was not otherwise ignored. Execution will
continue, but only actions that are flagged as ALWAYS_RUN will be
executed. Other actions will be skipped.
Protobuf type google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent
UnexpectedExitStatusEvent.Builder
An event generated when the execution of a container results in a
non-zero exit status that was not otherwise ignored. Execution will
continue, but only actions that are flagged as ALWAYS_RUN will be
executed. Other actions will be skipped.
Protobuf type google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent
VirtualMachine
Carries information about a Compute Engine VM resource.
Protobuf type google.cloud.lifesciences.v2beta.VirtualMachine
VirtualMachine.Builder
Carries information about a Compute Engine VM resource.
Protobuf type google.cloud.lifesciences.v2beta.VirtualMachine
Volume
Carries information about storage that can be attached to a VM.
Specify either Volume or
Disk, but not both.
Protobuf type google.cloud.lifesciences.v2beta.Volume
Volume.Builder
Carries information about storage that can be attached to a VM.
Specify either Volume or
Disk, but not both.
Protobuf type google.cloud.lifesciences.v2beta.Volume
WorkerAssignedEvent
An event generated after a worker VM has been assigned to run the pipeline.
Protobuf type google.cloud.lifesciences.v2beta.WorkerAssignedEvent
WorkerAssignedEvent.Builder
An event generated after a worker VM has been assigned to run the pipeline.
Protobuf type google.cloud.lifesciences.v2beta.WorkerAssignedEvent
WorkerReleasedEvent
An event generated when the worker VM that was assigned to the pipeline has been released (deleted).
Protobuf type google.cloud.lifesciences.v2beta.WorkerReleasedEvent
WorkerReleasedEvent.Builder
An event generated when the worker VM that was assigned to the pipeline has been released (deleted).
Protobuf type google.cloud.lifesciences.v2beta.WorkerReleasedEvent
WorkflowsProto
WorkflowsServiceV2BetaClient
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.
WorkflowsServiceV2BetaClient.ListLocationsFixedSizeCollection
WorkflowsServiceV2BetaClient.ListLocationsPage
WorkflowsServiceV2BetaClient.ListLocationsPagedResponse
WorkflowsServiceV2BetaGrpc
A service for running workflows, such as pipelines consisting of Docker containers.
WorkflowsServiceV2BetaGrpc.WorkflowsServiceV2BetaBlockingStub
A stub to allow clients to do synchronous rpc calls to service WorkflowsServiceV2Beta.
A service for running workflows, such as pipelines consisting of Docker containers.
WorkflowsServiceV2BetaGrpc.WorkflowsServiceV2BetaFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service WorkflowsServiceV2Beta.
A service for running workflows, such as pipelines consisting of Docker containers.
WorkflowsServiceV2BetaGrpc.WorkflowsServiceV2BetaImplBase
Base class for the server implementation of the service WorkflowsServiceV2Beta.
A service for running workflows, such as pipelines consisting of Docker containers.
WorkflowsServiceV2BetaGrpc.WorkflowsServiceV2BetaStub
A stub to allow clients to do asynchronous rpc calls to service WorkflowsServiceV2Beta.
A service for running workflows, such as pipelines consisting of Docker containers.
WorkflowsServiceV2BetaSettings
Settings class to configure an instance of WorkflowsServiceV2BetaClient.
The default instance has everything set to sensible defaults:
- The default service address (lifesciences.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getLocation to 30 seconds:
// 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.Builder workflowsServiceV2BetaSettingsBuilder =
WorkflowsServiceV2BetaSettings.newBuilder();
workflowsServiceV2BetaSettingsBuilder
.getLocationSettings()
.setRetrySettings(
workflowsServiceV2BetaSettingsBuilder
.getLocationSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
WorkflowsServiceV2BetaSettings workflowsServiceV2BetaSettings =
workflowsServiceV2BetaSettingsBuilder.build();
WorkflowsServiceV2BetaSettings.Builder
Builder for WorkflowsServiceV2BetaSettings.
Interfaces
AcceleratorOrBuilder
ActionOrBuilder
ContainerKilledEventOrBuilder
ContainerStartedEventOrBuilder
ContainerStoppedEventOrBuilder
DelayedEventOrBuilder
DiskOrBuilder
EventOrBuilder
ExistingDiskOrBuilder
FailedEventOrBuilder
MetadataOrBuilder
MountOrBuilder
NFSMountOrBuilder
NetworkOrBuilder
PersistentDiskOrBuilder
PipelineOrBuilder
PullStartedEventOrBuilder
PullStoppedEventOrBuilder
ResourcesOrBuilder
RunPipelineRequestOrBuilder
RunPipelineResponseOrBuilder
SecretOrBuilder
ServiceAccountOrBuilder
UnexpectedExitStatusEventOrBuilder
VirtualMachineOrBuilder
VolumeOrBuilder
WorkerAssignedEventOrBuilder
WorkerReleasedEventOrBuilder
WorkflowsServiceV2BetaGrpc.AsyncService
A service for running workflows, such as pipelines consisting of Docker containers.