public sealed class Action : IMessage<Action>, IEquatable<Action>, IDeepCloneable<Action>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Life Sciences v2beta API class Action.
Specifies a single action that runs a Docker container.
Namespace
Google.Cloud.LifeSciences.V2BetaAssembly
Google.Cloud.LifeSciences.V2Beta.dll
Constructors
Action()
public Action()Action(Action)
public Action(Action other)| Parameter | |
|---|---|
| Name | Description |
other |
Action |
Properties
AlwaysRun
public bool AlwaysRun { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
BlockExternalNetwork
public bool BlockExternalNetwork { get; set; }Prevents the container from accessing the external network.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Commands
public RepeatedField<string> Commands { get; }If specified, overrides the CMD specified in the container. If the
container also has an ENTRYPOINT the values are used as entrypoint
arguments. Otherwise, they are used as a command and arguments to run
inside the container.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
ContainerName
public string ContainerName { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Credentials
public Secret Credentials { get; set; }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
username and password keys.
| Property Value | |
|---|---|
| Type | Description |
Secret |
|
DisableImagePrefetch
public bool DisableImagePrefetch { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DisableStandardErrorCapture
public bool DisableStandardErrorCapture { get; set; }A small portion of the container's standard error stream is typically
captured and returned inside the ContainerStoppedEvent. Setting this
flag disables this functionality.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
EnableFuse
public bool EnableFuse { get; set; }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 enable_fuse flag to access the mounted filesystem.
This has the effect of causing the container to be executed with
CAP_SYS_ADMIN and exposes /dev/fuse to the container, so use it only
for containers you trust.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
EncryptedEnvironment
public Secret EncryptedEnvironment { get; set; }The encrypted environment to pass into the container. This environment is merged with values specified in the [google.cloud.lifesciences.v2beta.Pipeline][google.cloud.lifesciences.v2beta.Pipeline] message, overwriting any duplicate values.
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
environment field.
| Property Value | |
|---|---|
| Type | Description |
Secret |
|
Entrypoint
public string Entrypoint { get; set; }If specified, overrides the ENTRYPOINT specified in the container.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Environment
public MapField<string, string> Environment { get; }The environment to pass into the container. This environment is merged with values specified in the [google.cloud.lifesciences.v2beta.Pipeline][google.cloud.lifesciences.v2beta.Pipeline] message, overwriting any duplicate values.
In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten.
GOOGLE_PIPELINE_FAILED will be set to "1" if the pipeline failed
because an action has exited with a non-zero status (and did not have the
IGNORE_EXIT_STATUS flag set). This can be used to determine if additional
debug or logging actions should execute.
GOOGLE_LAST_EXIT_STATUS will be set to the exit status of the last
non-background action that executed. This can be used by workflow engine
authors to determine whether an individual action has succeeded or failed.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
IgnoreExitStatus
public bool IgnoreExitStatus { get; set; }Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
ImageUri
public string ImageUri { get; set; }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 [google.cloud.lifesciences.v2beta.Action.credentials][google.cloud.lifesciences.v2beta.Action.credentials] field.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Mounts
public RepeatedField<Mount> Mounts { get; }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 /google that contains log files and other
operational components.
<ul> <li><code>/google/logs</code> All logs written during the pipeline execution.</li> <li><code>/google/logs/output</code> The combined standard output and standard error of all actions run as part of the pipeline execution.</li> <li><code>/google/logs/action//stdout</code> The complete contents of each individual action's standard output.</li> <li><code>/google/logs/action//stderr</code> The complete contents of each individual action's standard error output.</li> </ul>
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldMount |
|
PidNamespace
public string PidNamespace { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PortMappings
public MapField<int, int> PortMappings { get; }A map of containers to host port mappings for this container. If the
container already specifies exposed ports, use the
PUBLISH_EXPOSED_PORTS flag instead.
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 ContainerStartedEvent in the operation metadata.
| Property Value | |
|---|---|
| Type | Description |
MapFieldintint |
|
PublishExposedPorts
public bool PublishExposedPorts { get; set; }Exposes all ports specified by EXPOSE statements in the container. To
discover the host side port numbers, consult the ACTION_STARTED event
in the operation metadata.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
RunInBackground
public bool RunInBackground { get; set; }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).
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Timeout
public Duration Timeout { get; set; }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 ALWAYS_RUN and IGNORE_EXIT_STATUS flags.
| Property Value | |
|---|---|
| Type | Description |
Duration |
|