Class Action.Builder (0.56.0) 

public static final class Action.Builder extends GeneratedMessageV3.Builder<Action.Builder> implements ActionOrBuilder

Specifies a single action that runs a Docker container.

Protobuf type google.cloud.lifesciences.v2beta.Action

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Action.Builder

Implements

ActionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllCommands(Iterable<String> values)

public Action.Builder addAllCommands(Iterable<String> values)

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.

repeated string commands = 3;

Parameter
Name Description
values Iterable<String>

The commands to add.
Returns
Type Description
Action.Builder

This builder for chaining.

addAllMounts(Iterable<? extends Mount> values)

public Action.Builder addAllMounts(Iterable<? extends Mount> values)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
values Iterable<? extends com.google.cloud.lifesciences.v2beta.Mount>
Returns
Type Description
Action.Builder

addCommands(String value)

public Action.Builder addCommands(String value)

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.

repeated string commands = 3;

Parameter
Name Description
value String

The commands to add.
Returns
Type Description
Action.Builder

This builder for chaining.

addCommandsBytes(ByteString value)

public Action.Builder addCommandsBytes(ByteString value)

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.

repeated string commands = 3;

Parameter
Name Description
value ByteString

The bytes of the commands to add.
Returns
Type Description
Action.Builder

This builder for chaining.

addMounts(Mount value)

public Action.Builder addMounts(Mount value)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
value Mount
Returns
Type Description
Action.Builder

addMounts(Mount.Builder builderForValue)

public Action.Builder addMounts(Mount.Builder builderForValue)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
builderForValue Mount.Builder
Returns
Type Description
Action.Builder

addMounts(int index, Mount value)

public Action.Builder addMounts(int index, Mount value)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameters
Name Description
index int
value Mount
Returns
Type Description
Action.Builder

addMounts(int index, Mount.Builder builderForValue)

public Action.Builder addMounts(int index, Mount.Builder builderForValue)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameters
Name Description
index int
builderForValue Mount.Builder
Returns
Type Description
Action.Builder

addMountsBuilder()

public Mount.Builder addMountsBuilder()

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Returns
Type Description
Mount.Builder

addMountsBuilder(int index)

public Mount.Builder addMountsBuilder(int index)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
index int
Returns
Type Description
Mount.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Action.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Action.Builder
Overrides

build()

public Action build()
Returns
Type Description
Action

buildPartial()

public Action buildPartial()
Returns
Type Description
Action

clear()

public Action.Builder clear()
Returns
Type Description
Action.Builder
Overrides

clearAlwaysRun()

public Action.Builder clearAlwaysRun()

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.

bool always_run = 15;

Returns
Type Description
Action.Builder

This builder for chaining.

clearBlockExternalNetwork()

public Action.Builder clearBlockExternalNetwork()

Prevents the container from accessing the external network.

bool block_external_network = 20;

Returns
Type Description
Action.Builder

This builder for chaining.

clearCommands()

public Action.Builder clearCommands()

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.

repeated string commands = 3;

Returns
Type Description
Action.Builder

This builder for chaining.

clearContainerName()

public Action.Builder clearContainerName()

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.

string container_name = 1;

Returns
Type Description
Action.Builder

This builder for chaining.

clearCredentials()

public Action.Builder clearCredentials()

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Returns
Type Description
Action.Builder

clearDisableImagePrefetch()

public Action.Builder clearDisableImagePrefetch()

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.

bool disable_image_prefetch = 18;

Returns
Type Description
Action.Builder

This builder for chaining.

clearDisableStandardErrorCapture()

public Action.Builder clearDisableStandardErrorCapture()

A small portion of the container's standard error stream is typically captured and returned inside the ContainerStoppedEvent. Setting this flag disables this functionality.

bool disable_standard_error_capture = 19;

Returns
Type Description
Action.Builder

This builder for chaining.

clearEnableFuse()

public Action.Builder clearEnableFuse()

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.

bool enable_fuse = 16;

Returns
Type Description
Action.Builder

This builder for chaining.

clearEncryptedEnvironment()

public Action.Builder clearEncryptedEnvironment()

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Returns
Type Description
Action.Builder

clearEntrypoint()

public Action.Builder clearEntrypoint()

If specified, overrides the ENTRYPOINT specified in the container.

string entrypoint = 4;

Returns
Type Description
Action.Builder

This builder for chaining.

clearEnvironment()

public Action.Builder clearEnvironment()
Returns
Type Description
Action.Builder

clearField(Descriptors.FieldDescriptor field)

public Action.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Action.Builder
Overrides

clearIgnoreExitStatus()

public Action.Builder clearIgnoreExitStatus()

Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.

bool ignore_exit_status = 13;

Returns
Type Description
Action.Builder

This builder for chaining.

clearImageUri()

public Action.Builder clearImageUri()

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 field.

string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Action.Builder

This builder for chaining.

clearLabels()

public Action.Builder clearLabels()
Returns
Type Description
Action.Builder

clearMounts()

public Action.Builder clearMounts()

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Returns
Type Description
Action.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Action.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Action.Builder
Overrides

clearPidNamespace()

public Action.Builder clearPidNamespace()

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.

string pid_namespace = 6;

Returns
Type Description
Action.Builder

This builder for chaining.

clearPortMappings()

public Action.Builder clearPortMappings()
Returns
Type Description
Action.Builder

clearPublishExposedPorts()

public Action.Builder clearPublishExposedPorts()

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.

bool publish_exposed_ports = 17;

Returns
Type Description
Action.Builder

This builder for chaining.

clearRunInBackground()

public Action.Builder clearRunInBackground()

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

bool run_in_background = 14;

Returns
Type Description
Action.Builder

This builder for chaining.

clearTimeout()

public Action.Builder clearTimeout()

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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
Action.Builder

clone()

public Action.Builder clone()
Returns
Type Description
Action.Builder
Overrides

containsEnvironment(String key)

public boolean containsEnvironment(String key)

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsPortMappings(int key)

public boolean containsPortMappings(int key)

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.

map<int32, int32> port_mappings = 8;

Parameter
Name Description
key int
Returns
Type Description
boolean

getAlwaysRun()

public boolean getAlwaysRun()

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.

bool always_run = 15;

Returns
Type Description
boolean

The alwaysRun.

getBlockExternalNetwork()

public boolean getBlockExternalNetwork()

Prevents the container from accessing the external network.

bool block_external_network = 20;

Returns
Type Description
boolean

The blockExternalNetwork.

getCommands(int index)

public String getCommands(int index)

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.

repeated string commands = 3;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The commands at the given index.

getCommandsBytes(int index)

public ByteString getCommandsBytes(int index)

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.

repeated string commands = 3;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the commands at the given index.

getCommandsCount()

public int getCommandsCount()

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.

repeated string commands = 3;

Returns
Type Description
int

The count of commands.

getCommandsList()

public ProtocolStringList getCommandsList()

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.

repeated string commands = 3;

Returns
Type Description
ProtocolStringList

A list containing the commands.

getContainerName()

public String getContainerName()

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.

string container_name = 1;

Returns
Type Description
String

The containerName.

getContainerNameBytes()

public ByteString getContainerNameBytes()

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.

string container_name = 1;

Returns
Type Description
ByteString

The bytes for containerName.

getCredentials()

public Secret getCredentials()

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Returns
Type Description
Secret

The credentials.

getCredentialsBuilder()

public Secret.Builder getCredentialsBuilder()

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Returns
Type Description
Secret.Builder

getCredentialsOrBuilder()

public SecretOrBuilder getCredentialsOrBuilder()

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Returns
Type Description
SecretOrBuilder

getDefaultInstanceForType()

public Action getDefaultInstanceForType()
Returns
Type Description
Action

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableImagePrefetch()

public boolean getDisableImagePrefetch()

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.

bool disable_image_prefetch = 18;

Returns
Type Description
boolean

The disableImagePrefetch.

getDisableStandardErrorCapture()

public boolean getDisableStandardErrorCapture()

A small portion of the container's standard error stream is typically captured and returned inside the ContainerStoppedEvent. Setting this flag disables this functionality.

bool disable_standard_error_capture = 19;

Returns
Type Description
boolean

The disableStandardErrorCapture.

getEnableFuse()

public boolean getEnableFuse()

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.

bool enable_fuse = 16;

Returns
Type Description
boolean

The enableFuse.

getEncryptedEnvironment()

public Secret getEncryptedEnvironment()

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Returns
Type Description
Secret

The encryptedEnvironment.

getEncryptedEnvironmentBuilder()

public Secret.Builder getEncryptedEnvironmentBuilder()

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Returns
Type Description
Secret.Builder

getEncryptedEnvironmentOrBuilder()

public SecretOrBuilder getEncryptedEnvironmentOrBuilder()

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Returns
Type Description
SecretOrBuilder

getEntrypoint()

public String getEntrypoint()

If specified, overrides the ENTRYPOINT specified in the container.

string entrypoint = 4;

Returns
Type Description
String

The entrypoint.

getEntrypointBytes()

public ByteString getEntrypointBytes()

If specified, overrides the ENTRYPOINT specified in the container.

string entrypoint = 4;

Returns
Type Description
ByteString

The bytes for entrypoint.

getEnvironment() (deprecated)

public Map<String,String> getEnvironment()

Use #getEnvironmentMap() instead.

Returns
Type Description
Map<String,String>

getEnvironmentCount()

public int getEnvironmentCount()

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Returns
Type Description
int

getEnvironmentMap()

public Map<String,String> getEnvironmentMap()

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Returns
Type Description
Map<String,String>

getEnvironmentOrDefault(String key, String defaultValue)

public String getEnvironmentOrDefault(String key, String defaultValue)

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvironmentOrThrow(String key)

public String getEnvironmentOrThrow(String key)

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Parameter
Name Description
key String
Returns
Type Description
String

getIgnoreExitStatus()

public boolean getIgnoreExitStatus()

Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.

bool ignore_exit_status = 13;

Returns
Type Description
boolean

The ignoreExitStatus.

getImageUri()

public String getImageUri()

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 field.

string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

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 field.

string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for imageUri.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 10;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 10;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 10;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
String

getMounts(int index)

public Mount getMounts(int index)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
index int
Returns
Type Description
Mount

getMountsBuilder(int index)

public Mount.Builder getMountsBuilder(int index)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
index int
Returns
Type Description
Mount.Builder

getMountsBuilderList()

public List<Mount.Builder> getMountsBuilderList()

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Returns
Type Description
List<Builder>

getMountsCount()

public int getMountsCount()

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Returns
Type Description
int

getMountsList()

public List<Mount> getMountsList()

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Returns
Type Description
List<Mount>

getMountsOrBuilder(int index)

public MountOrBuilder getMountsOrBuilder(int index)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
index int
Returns
Type Description
MountOrBuilder

getMountsOrBuilderList()

public List<? extends MountOrBuilder> getMountsOrBuilderList()

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Returns
Type Description
List<? extends com.google.cloud.lifesciences.v2beta.MountOrBuilder>

getMutableEnvironment() (deprecated)

public Map<String,String> getMutableEnvironment()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutablePortMappings() (deprecated)

public Map<Integer,Integer> getMutablePortMappings()

Use alternate mutation accessors instead.

Returns
Type Description
Map<java.lang.Integer,java.lang.Integer>

getPidNamespace()

public String getPidNamespace()

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.

string pid_namespace = 6;

Returns
Type Description
String

The pidNamespace.

getPidNamespaceBytes()

public ByteString getPidNamespaceBytes()

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.

string pid_namespace = 6;

Returns
Type Description
ByteString

The bytes for pidNamespace.

getPortMappings() (deprecated)

public Map<Integer,Integer> getPortMappings()

Use #getPortMappingsMap() instead.

Returns
Type Description
Map<java.lang.Integer,java.lang.Integer>

getPortMappingsCount()

public int getPortMappingsCount()

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.

map<int32, int32> port_mappings = 8;

Returns
Type Description
int

getPortMappingsMap()

public Map<Integer,Integer> getPortMappingsMap()

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.

map<int32, int32> port_mappings = 8;

Returns
Type Description
Map<java.lang.Integer,java.lang.Integer>

getPortMappingsOrDefault(int key, int defaultValue)

public int getPortMappingsOrDefault(int key, int defaultValue)

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.

map<int32, int32> port_mappings = 8;

Parameters
Name Description
key int
defaultValue int
Returns
Type Description
int

getPortMappingsOrThrow(int key)

public int getPortMappingsOrThrow(int key)

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.

map<int32, int32> port_mappings = 8;

Parameter
Name Description
key int
Returns
Type Description
int

getPublishExposedPorts()

public boolean getPublishExposedPorts()

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.

bool publish_exposed_ports = 17;

Returns
Type Description
boolean

The publishExposedPorts.

getRunInBackground()

public boolean getRunInBackground()

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

bool run_in_background = 14;

Returns
Type Description
boolean

The runInBackground.

getTimeout()

public Duration getTimeout()

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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
Duration

The timeout.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
Builder

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
DurationOrBuilder

hasCredentials()

public boolean hasCredentials()

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Returns
Type Description
boolean

Whether the credentials field is set.

hasEncryptedEnvironment()

public boolean hasEncryptedEnvironment()

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Returns
Type Description
boolean

Whether the encryptedEnvironment field is set.

hasTimeout()

public boolean hasTimeout()

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.

.google.protobuf.Duration timeout = 12;

Returns
Type Description
boolean

Whether the timeout field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCredentials(Secret value)

public Action.Builder mergeCredentials(Secret value)

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Parameter
Name Description
value Secret
Returns
Type Description
Action.Builder

mergeEncryptedEnvironment(Secret value)

public Action.Builder mergeEncryptedEnvironment(Secret value)

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Parameter
Name Description
value Secret
Returns
Type Description
Action.Builder

mergeFrom(Action other)

public Action.Builder mergeFrom(Action other)
Parameter
Name Description
other Action
Returns
Type Description
Action.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Action.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Action.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Action.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Action.Builder
Overrides

mergeTimeout(Duration value)

public Action.Builder mergeTimeout(Duration value)

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.

.google.protobuf.Duration timeout = 12;

Parameter
Name Description
value Duration
Returns
Type Description
Action.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Action.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Action.Builder
Overrides

putAllEnvironment(Map<String,String> values)

public Action.Builder putAllEnvironment(Map<String,String> values)

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Action.Builder

putAllLabels(Map<String,String> values)

public Action.Builder putAllLabels(Map<String,String> values)

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.

map<string, string> labels = 10;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Action.Builder

putAllPortMappings(Map<Integer,Integer> values)

public Action.Builder putAllPortMappings(Map<Integer,Integer> values)

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.

map<int32, int32> port_mappings = 8;

Parameter
Name Description
values Map<java.lang.Integer,java.lang.Integer>
Returns
Type Description
Action.Builder

putEnvironment(String key, String value)

public Action.Builder putEnvironment(String key, String value)

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Parameters
Name Description
key String
value String
Returns
Type Description
Action.Builder

putLabels(String key, String value)

public Action.Builder putLabels(String key, String value)

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.

map<string, string> labels = 10;

Parameters
Name Description
key String
value String
Returns
Type Description
Action.Builder

putPortMappings(int key, int value)

public Action.Builder putPortMappings(int key, int value)

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.

map<int32, int32> port_mappings = 8;

Parameters
Name Description
key int
value int
Returns
Type Description
Action.Builder

removeEnvironment(String key)

public Action.Builder removeEnvironment(String key)

The environment to pass into the container. This environment is merged with values specified in the 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.

map<string, string> environment = 5;

Parameter
Name Description
key String
Returns
Type Description
Action.Builder

removeLabels(String key)

public Action.Builder removeLabels(String key)

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.

map<string, string> labels = 10;

Parameter
Name Description
key String
Returns
Type Description
Action.Builder

removeMounts(int index)

public Action.Builder removeMounts(int index)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameter
Name Description
index int
Returns
Type Description
Action.Builder

removePortMappings(int key)

public Action.Builder removePortMappings(int key)

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.

map<int32, int32> port_mappings = 8;

Parameter
Name Description
key int
Returns
Type Description
Action.Builder

setAlwaysRun(boolean value)

public Action.Builder setAlwaysRun(boolean value)

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.

bool always_run = 15;

Parameter
Name Description
value boolean

The alwaysRun to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setBlockExternalNetwork(boolean value)

public Action.Builder setBlockExternalNetwork(boolean value)

Prevents the container from accessing the external network.

bool block_external_network = 20;

Parameter
Name Description
value boolean

The blockExternalNetwork to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setCommands(int index, String value)

public Action.Builder setCommands(int index, String value)

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.

repeated string commands = 3;

Parameters
Name Description
index int

The index to set the value at.
value String

The commands to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setContainerName(String value)

public Action.Builder setContainerName(String value)

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.

string container_name = 1;

Parameter
Name Description
value String

The containerName to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setContainerNameBytes(ByteString value)

public Action.Builder setContainerNameBytes(ByteString value)

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.

string container_name = 1;

Parameter
Name Description
value ByteString

The bytes for containerName to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setCredentials(Secret value)

public Action.Builder setCredentials(Secret value)

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Parameter
Name Description
value Secret
Returns
Type Description
Action.Builder

setCredentials(Secret.Builder builderForValue)

public Action.Builder setCredentials(Secret.Builder builderForValue)

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.

.google.cloud.lifesciences.v2beta.Secret credentials = 11;

Parameter
Name Description
builderForValue Secret.Builder
Returns
Type Description
Action.Builder

setDisableImagePrefetch(boolean value)

public Action.Builder setDisableImagePrefetch(boolean value)

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.

bool disable_image_prefetch = 18;

Parameter
Name Description
value boolean

The disableImagePrefetch to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setDisableStandardErrorCapture(boolean value)

public Action.Builder setDisableStandardErrorCapture(boolean value)

A small portion of the container's standard error stream is typically captured and returned inside the ContainerStoppedEvent. Setting this flag disables this functionality.

bool disable_standard_error_capture = 19;

Parameter
Name Description
value boolean

The disableStandardErrorCapture to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setEnableFuse(boolean value)

public Action.Builder setEnableFuse(boolean value)

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.

bool enable_fuse = 16;

Parameter
Name Description
value boolean

The enableFuse to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setEncryptedEnvironment(Secret value)

public Action.Builder setEncryptedEnvironment(Secret value)

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Parameter
Name Description
value Secret
Returns
Type Description
Action.Builder

setEncryptedEnvironment(Secret.Builder builderForValue)

public Action.Builder setEncryptedEnvironment(Secret.Builder builderForValue)

The encrypted environment to pass into the container. This environment is merged with values specified in the 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.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;

Parameter
Name Description
builderForValue Secret.Builder
Returns
Type Description
Action.Builder

setEntrypoint(String value)

public Action.Builder setEntrypoint(String value)

If specified, overrides the ENTRYPOINT specified in the container.

string entrypoint = 4;

Parameter
Name Description
value String

The entrypoint to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setEntrypointBytes(ByteString value)

public Action.Builder setEntrypointBytes(ByteString value)

If specified, overrides the ENTRYPOINT specified in the container.

string entrypoint = 4;

Parameter
Name Description
value ByteString

The bytes for entrypoint to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Action.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Action.Builder
Overrides

setIgnoreExitStatus(boolean value)

public Action.Builder setIgnoreExitStatus(boolean value)

Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.

bool ignore_exit_status = 13;

Parameter
Name Description
value boolean

The ignoreExitStatus to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setImageUri(String value)

public Action.Builder setImageUri(String value)

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 field.

string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The imageUri to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setImageUriBytes(ByteString value)

public Action.Builder setImageUriBytes(ByteString value)

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 field.

string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for imageUri to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setMounts(int index, Mount value)

public Action.Builder setMounts(int index, Mount value)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameters
Name Description
index int
value Mount
Returns
Type Description
Action.Builder

setMounts(int index, Mount.Builder builderForValue)

public Action.Builder setMounts(int index, Mount.Builder builderForValue)

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>

repeated .google.cloud.lifesciences.v2beta.Mount mounts = 9;

Parameters
Name Description
index int
builderForValue Mount.Builder
Returns
Type Description
Action.Builder

setPidNamespace(String value)

public Action.Builder setPidNamespace(String value)

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.

string pid_namespace = 6;

Parameter
Name Description
value String

The pidNamespace to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setPidNamespaceBytes(ByteString value)

public Action.Builder setPidNamespaceBytes(ByteString value)

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.

string pid_namespace = 6;

Parameter
Name Description
value ByteString

The bytes for pidNamespace to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setPublishExposedPorts(boolean value)

public Action.Builder setPublishExposedPorts(boolean value)

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.

bool publish_exposed_ports = 17;

Parameter
Name Description
value boolean

The publishExposedPorts to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Action.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Action.Builder
Overrides

setRunInBackground(boolean value)

public Action.Builder setRunInBackground(boolean value)

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

bool run_in_background = 14;

Parameter
Name Description
value boolean

The runInBackground to set.
Returns
Type Description
Action.Builder

This builder for chaining.

setTimeout(Duration value)

public Action.Builder setTimeout(Duration value)

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.

.google.protobuf.Duration timeout = 12;

Parameter
Name Description
value Duration
Returns
Type Description
Action.Builder

setTimeout(Duration.Builder builderForValue)

public Action.Builder setTimeout(Duration.Builder builderForValue)

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.

.google.protobuf.Duration timeout = 12;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Action.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Action.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Action.Builder
Overrides