Index
WorkflowsServiceV2Beta(interface)Accelerator(message)Action(message)ContainerKilledEvent(message)ContainerStartedEvent(message)ContainerStoppedEvent(message)DelayedEvent(message)Disk(message)Event(message)ExistingDisk(message)FailedEvent(message)Metadata(message)Mount(message)NFSMount(message)Network(message)PersistentDisk(message)Pipeline(message)PullStartedEvent(message)PullStoppedEvent(message)Resources(message)RunPipelineRequest(message)RunPipelineResponse(message)Secret(message)ServiceAccount(message)UnexpectedExitStatusEvent(message)VirtualMachine(message)Volume(message)WorkerAssignedEvent(message)WorkerReleasedEvent(message)
WorkflowsServiceV2Beta
A service for running workflows, such as pipelines consisting of Docker containers.
| RunPipeline |
|---|
|
Runs a pipeline. The returned Operation's 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:
|
Accelerator
Carries information about an accelerator that can be attached to a VM.
| Fields | |
|---|---|
type |
The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under |
count |
How many accelerators of this type to attach. |
Action
Specifies a single action that runs a Docker container.
| Fields | |
|---|---|
container_name |
An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen. |
image_uri |
Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the |
commands[] |
If specified, overrides the |
entrypoint |
If specified, overrides the |
environment |
The environment to pass into the container. This environment is merged with values specified in the In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten.
|
encrypted_environment |
The encrypted environment to pass into the container. This environment is merged with values specified in the The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the |
pid_namespace |
An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used. |
port_mappings |
A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the |
mounts[] |
A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under
|
labels |
Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored. |
credentials |
If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both |
timeout |
The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the |
ignore_exit_status |
Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead. |
run_in_background |
This flag allows an action to continue running in the background while executing subsequent actions. This is useful to provide services to other actions (or to provide debugging support tools like SSH servers). |
always_run |
By default, after an action fails, no further actions are run. This flag indicates that this action must be run even if the pipeline has already failed. This is useful for actions that copy output files off of the VM or for debugging. Note that no actions will be run if image prefetching fails. |
enable_fuse |
Enable access to the FUSE device for this action. Filesystems can then be mounted into disks shared with other actions. The other actions do not need the This has the effect of causing the container to be executed with |
publish_exposed_ports |
Exposes all ports specified by |
disable_image_prefetch |
All container images are typically downloaded before any actions are executed. This helps prevent typos in URIs or issues like lack of disk space from wasting large amounts of compute resources. If set, this flag prevents the worker from downloading the image until just before the action is executed. |
disable_standard_error_capture |
A small portion of the container's standard error stream is typically captured and returned inside the |
block_external_network |
Prevents the container from accessing the external network. |
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.
| Fields | |
|---|---|
action_id |
The numeric ID of the action that started the container. |
ContainerStartedEvent
An event generated when a container starts.
| Fields | |
|---|---|
action_id |
The numeric ID of the action that started this container. |
port_mappings |
The container-to-host port mappings installed for this container. This set will contain any ports exposed using the |
ip_address |
The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. |
ContainerStoppedEvent
An event generated when a container exits.
| Fields | |
|---|---|
action_id |
The numeric ID of the action that started this container. |
exit_status |
The exit status of the container. |
stderr |
The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the |
DelayedEvent
An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.
| Fields | |
|---|---|
cause |
A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). |
metrics[] |
If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, |
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.
| Fields | |
|---|---|
name |
A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen. |
size_gb |
The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as |
type |
The Compute Engine disk type. If unspecified, |
source_image |
An optional image to put on the disk before attaching it to the VM. |
Event
Carries information about events that occur during pipeline execution.
| Fields | |
|---|---|
timestamp |
The time at which the event occurred. |
description |
A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the |
Union field details. Machine-readable details about the event. details can be only one of the following: |
|
delayed |
|
worker_assigned |
|
worker_released |
|
pull_started |
|
pull_stopped |
|
container_started |
|
container_stopped |
|
container_killed |
|
unexpected_exit_status |
See |
failed |
|
ExistingDisk
Configuration for an existing disk to be attached to the VM.
| Fields | |
|---|---|
disk |
If If all |
FailedEvent
An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.
| Fields | |
|---|---|
code |
The Google standard error code that best describes this failure. |
cause |
The human-readable description of the cause of the failure. |
Metadata
Carries information about the pipeline execution that is returned in the long running operation's metadata field.
| Fields | |
|---|---|
pipeline |
The pipeline this operation represents. |
labels |
The user-defined labels associated with this operation. |
events[] |
The list of events that have happened so far during the execution of this operation. |
create_time |
The time at which the operation was created by the API. |
start_time |
The first time at which resources were allocated to execute the pipeline. |
end_time |
The time at which execution was completed and resources were cleaned up. |
pub_sub_topic |
The name of the Cloud Pub/Sub topic where notifications of operation status changes are sent. |
Mount
Carries information about a particular disk mount inside a container.
| Fields | |
|---|---|
disk |
The name of the disk to mount, as specified in the resources section. |
path |
The path to mount the disk inside the container. |
read_only |
If true, the disk is mounted read-only inside the container. |
NFSMount
Configuration for an NFSMount to be attached to the VM.
| Fields | |
|---|---|
target |
A target NFS mount. The target must be specified as `address:/mount". |
Network
VM networking options.
| Fields | |
|---|---|
network |
The network name to attach the VM's network interface to. The value will be prefixed with If unspecified, the global default network is used. |
use_private_address |
If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information. |
subnetwork |
If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with If the |
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.
| Fields | |
|---|---|
size_gb |
The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as |
type |
The Compute Engine disk type. If unspecified, |
source_image |
An image to put on the disk before attaching it to the VM. |
Pipeline
Specifies a series of actions to execute, expressed as Docker containers.
| Fields | |
|---|---|
actions[] |
The list of actions to execute, in the order they are specified. |
resources |
The resources required for execution. |
environment |
The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value). |
encrypted_environment |
The encrypted environment to pass into every action. Each action can also specify its own encrypted environment. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the |
timeout |
The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. |
PullStartedEvent
An event generated when the worker starts pulling an image.
| Fields | |
|---|---|
image_uri |
The URI of the image that was pulled. |
PullStoppedEvent
An event generated when the worker stops pulling an image.
| Fields | |
|---|---|
image_uri |
The URI of the image that was pulled. |
Resources
The system resources for the pipeline run.
At least one zone or region must be specified or the pipeline run will fail.
| Fields | |
|---|---|
regions[] |
The list of regions allowed for VM allocation. If set, the |
zones[] |
The list of zones allowed for VM allocation. If set, the |
virtual_machine |
The virtual machine specification. |
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.
| Fields | |
|---|---|
parent |
The project and location that this request should be executed against. Authorization requires the following IAM permission on the specified resource
|
pipeline |
Required. The description of the pipeline to run. |
labels |
User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, |
pub_sub_topic |
The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent. |
RunPipelineResponse
This type has no fields.
The response to the RunPipeline method, returned in the operation's result field on success.
Secret
Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.
| Fields | |
|---|---|
key_name |
The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the |
cipher_text |
The value of the cipherText response from the |
ServiceAccount
Carries information about a Google Cloud service account.
| Fields | |
|---|---|
email |
Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. |
scopes[] |
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default. |
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.
| Fields | |
|---|---|
action_id |
The numeric ID of the action that started the container. |
exit_status |
The exit status of the container. |
VirtualMachine
Carries information about a Compute Engine VM resource.
| Fields | |
|---|---|
machine_type |
Required. The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as "n1-standard-1") or a custom machine type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "4096" indicates the memory in MB). See Creating an instance with a custom machine type for more specifications on creating a custom machine type. |
preemptible |
If true, allocate a preemptible VM. |
labels |
Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the name and value restrictions on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. |
disks[] |
The list of disks to create and attach to the VM. Specify either the |
network |
The VM network configuration. |
accelerators[] |
The list of accelerators to attach to the VM. |
service_account |
The service account to install on the VM. This account does not need any permissions other than those required by the pipeline. |
boot_disk_size_gb |
The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used. |
cpu_platform |
The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. |
boot_image |
The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value |
nvidia_driver_version |
The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the |
enable_stackdriver_monitoring |
Whether Stackdriver monitoring should be enabled on the VM. |
docker_cache_images[] |
The Compute Engine Disk Images to use as a Docker cache. The disks will be mounted into the Docker folder in a way that the images present in the cache will not need to be pulled. The digests of the cached images must match those of the tags used or the latest version will still be pulled. The root directory of the ext4 image must contain |
volumes[] |
The list of disks and other storage to create or attach to the VM. Specify either the |
reservation |
If specified, the VM will only be allocated inside the matching reservation. It will fail if the VM parameters don't match the reservation. |
Volume
Carries information about storage that can be attached to a VM.
| Fields | |
|---|---|
volume |
A user-supplied name for the volume. Used when mounting the volume into |
Union field
|
|
persistent_disk |
Configuration for a persistent disk. |
existing_disk |
Configuration for a existing disk. |
nfs_mount |
Configuration for an NFS mount. |
WorkerAssignedEvent
An event generated after a worker VM has been assigned to run the pipeline.
| Fields | |
|---|---|
zone |
The zone the worker is running in. |
instance |
The worker's instance name. |
machine_type |
The machine type that was assigned for the worker. |
WorkerReleasedEvent
An event generated when the worker VM that was assigned to the pipeline has been released (deleted).
| Fields | |
|---|---|
zone |
The zone the worker was running in. |
instance |
The worker's instance name. |