Package com.google.cloud.lifesciences.v2beta

Interface ActionOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Action, Action.Builder
    public interface ActionOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getContainerName

        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:
        The containerName.

      • getContainerNameBytes

        com.google.protobuf.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:
        The bytes for containerName.

      • getImageUri

        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];
        Returns:
        The imageUri.

      • getImageUriBytes

        com.google.protobuf.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][google.cloud.lifesciences.v2beta.Action.credentials]
 field.
        string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for imageUri.

      • getCommandsList

        List<String> 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:
        A list containing the commands.

      • getCommandsCount

        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:
        The count of commands.

      • getCommands

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The commands at the given index.

      • getCommandsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the commands at the given index.

      • getEntrypoint

        String getEntrypoint()
         If specified, overrides the `ENTRYPOINT` specified in the container.
        string entrypoint = 4;
        Returns:
        The entrypoint.

      • getEntrypointBytes

        com.google.protobuf.ByteString getEntrypointBytes()
         If specified, overrides the `ENTRYPOINT` specified in the container.
        string entrypoint = 4;
        Returns:
        The bytes for entrypoint.

      • getEnvironmentCount

        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;

      • containsEnvironment

        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][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;

      • getEnvironmentMap

        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][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;

      • getEnvironmentOrDefault

        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][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;

      • getEnvironmentOrThrow

        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][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;

      • hasEncryptedEnvironment

        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;
        Returns:
        Whether the encryptedEnvironment field is set.

      • getEncryptedEnvironment

        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;
        Returns:
        The encryptedEnvironment.

      • getEncryptedEnvironmentOrBuilder

        SecretOrBuilder getEncryptedEnvironmentOrBuilder()
         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;

      • getPidNamespace

        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:
        The pidNamespace.

      • getPidNamespaceBytes

        com.google.protobuf.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:
        The bytes for pidNamespace.

      • getPortMappingsCount

        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;

      • containsPortMappings

        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;

      • getPortMappingsMap

        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;

      • getPortMappingsOrDefault

        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;

      • getPortMappingsOrThrow

        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;

      • getMountsList

        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;

      • getMounts

        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;

      • getMountsCount

        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;

      • getMountsOrBuilderList

        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;

      • getMountsOrBuilder

        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;

      • getLabelsCount

        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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;

      • hasCredentials

        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:
        Whether the credentials field is set.

      • getCredentials

        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:
        The credentials.

      • getCredentialsOrBuilder

        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;

      • hasTimeout

        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:
        Whether the timeout field is set.

      • getTimeout

        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;
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        com.google.protobuf.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;

      • getIgnoreExitStatus

        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:
        The ignoreExitStatus.

      • getRunInBackground

        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:
        The runInBackground.

      • getAlwaysRun

        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:
        The alwaysRun.

      • getEnableFuse

        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:
        The enableFuse.

      • getPublishExposedPorts

        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:
        The publishExposedPorts.

      • getDisableImagePrefetch

        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:
        The disableImagePrefetch.

      • getDisableStandardErrorCapture

        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:
        The disableStandardErrorCapture.

      • getBlockExternalNetwork

        boolean getBlockExternalNetwork()
         Prevents the container from accessing the external network.
        bool block_external_network = 20;
        Returns:
        The blockExternalNetwork.