* 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;
*
* @return The containerName.
*/
java.lang.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;
*
* @return The bytes for containerName.
*/
com.google.protobuf.ByteString getContainerNameBytes();
/**
*
*
*
* 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.
*
*
* string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The imageUri.
*/
java.lang.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][google.cloud.lifesciences.v2beta.Action.credentials]
* field.
*
*
* string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for imageUri.
*/
com.google.protobuf.ByteString getImageUriBytes();
/**
*
*
* * 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;
*
* @return A list containing the commands.
*/
java.util.List* 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;
*
* @return The count of commands.
*/
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;
*
* @param index The index of the element to return.
* @return The commands at the given index.
*/
java.lang.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;
*
* @param index The index of the value to return.
* @return The bytes of the commands at the given index.
*/
com.google.protobuf.ByteString getCommandsBytes(int index);
/**
*
*
* * If specified, overrides the `ENTRYPOINT` specified in the container. ** *
string entrypoint = 4;
*
* @return The entrypoint.
*/
java.lang.String getEntrypoint();
/**
*
*
* * If specified, overrides the `ENTRYPOINT` specified in the container. ** *
string entrypoint = 4;
*
* @return The bytes for entrypoint.
*/
com.google.protobuf.ByteString getEntrypointBytes();
/**
*
*
* * 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. ** *
map<string, string> environment = 5;
*/
int getEnvironmentCount();
/**
*
*
* * 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. ** *
map<string, string> environment = 5;
*/
boolean containsEnvironment(java.lang.String key);
/** Use {@link #getEnvironmentMap()} instead. */
@java.lang.Deprecated
java.util.Map* 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. ** *
map<string, string> environment = 5;
*/
java.util.Map* 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. ** *
map<string, string> environment = 5;
*/
/* nullable */
java.lang.String getEnvironmentOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
* * 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. ** *
map<string, string> environment = 5;
*/
java.lang.String getEnvironmentOrThrow(java.lang.String key);
/**
*
*
* * 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. ** *
.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;
*
* @return Whether the encryptedEnvironment field is set.
*/
boolean hasEncryptedEnvironment();
/**
*
*
* * 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. ** *
.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;
*
* @return The encryptedEnvironment.
*/
com.google.cloud.lifesciences.v2beta.Secret getEncryptedEnvironment();
/**
*
*
* * 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. ** *
.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 21;
*/
com.google.cloud.lifesciences.v2beta.SecretOrBuilder getEncryptedEnvironmentOrBuilder();
/**
*
*
* * 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;
*
* @return The pidNamespace.
*/
java.lang.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;
*
* @return The bytes for pidNamespace.
*/
com.google.protobuf.ByteString getPidNamespaceBytes();
/**
*
*
* * 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;
*/
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;
*/
boolean containsPortMappings(int key);
/** Use {@link #getPortMappingsMap()} instead. */
@java.lang.Deprecated
java.util.Map* 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;
*/
java.util.Map* 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;
*/
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;
*/
int getPortMappingsOrThrow(int key);
/**
*
*
* * 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;
*/
java.util.List* 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;
*/
com.google.cloud.lifesciences.v2beta.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;
*/
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;
*/
java.util.List
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;
*/
com.google.cloud.lifesciences.v2beta.MountOrBuilder getMountsOrBuilder(int index);
/**
*
*
* * 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;
*/
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;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map* 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;
*/
java.util.Map* 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;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
* * 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;
*
* @return Whether the credentials field is set.
*/
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;
*
* @return The credentials.
*/
com.google.cloud.lifesciences.v2beta.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;
*/
com.google.cloud.lifesciences.v2beta.SecretOrBuilder getCredentialsOrBuilder();
/**
*
*
* * 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;
*
* @return Whether the timeout field is set.
*/
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;
*
* @return The timeout.
*/
com.google.protobuf.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;
*/
com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder();
/**
*
*
* * 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;
*
* @return The ignoreExitStatus.
*/
boolean getIgnoreExitStatus();
/**
*
*
* * 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;
*
* @return The runInBackground.
*/
boolean getRunInBackground();
/**
*
*
* * 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;
*
* @return The alwaysRun.
*/
boolean getAlwaysRun();
/**
*
*
* * 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;
*
* @return The enableFuse.
*/
boolean getEnableFuse();
/**
*
*
* * 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;
*
* @return The publishExposedPorts.
*/
boolean getPublishExposedPorts();
/**
*
*
* * 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;
*
* @return The disableImagePrefetch.
*/
boolean getDisableImagePrefetch();
/**
*
*
* * 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;
*
* @return The disableStandardErrorCapture.
*/
boolean getDisableStandardErrorCapture();
/**
*
*
* * Prevents the container from accessing the external network. ** *
bool block_external_network = 20;
*
* @return The blockExternalNetwork.
*/
boolean getBlockExternalNetwork();
}