Cloud Life Sciences V2beta API - Class Google::Cloud::LifeSciences::V2beta::Action (v0.7.0)

Reference documentation and code samples for the Cloud Life Sciences V2beta API class Google::Cloud::LifeSciences::V2beta::Action.

Specifies a single action that runs a Docker container.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#always_run

def always_run() -> ::Boolean
Returns
  • (::Boolean) — 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.

#always_run=

def always_run=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#block_external_network

def block_external_network() -> ::Boolean
Returns
  • (::Boolean) — Prevents the container from accessing the external network.

#block_external_network=

def block_external_network=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Prevents the container from accessing the external network.
Returns
  • (::Boolean) — Prevents the container from accessing the external network.

#commands

def commands() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#commands=

def commands=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.

#container_name

def container_name() -> ::String
Returns
  • (::String) — 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.

#container_name=

def container_name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#credentials

def credentials() -> ::Google::Cloud::LifeSciences::V2beta::Secret
Returns
  • (::Google::Cloud::LifeSciences::V2beta::Secret) — 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.

#credentials=

def credentials=(value) -> ::Google::Cloud::LifeSciences::V2beta::Secret
Parameter
  • value (::Google::Cloud::LifeSciences::V2beta::Secret) — 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.

Returns
  • (::Google::Cloud::LifeSciences::V2beta::Secret) — 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.

#disable_image_prefetch

def disable_image_prefetch() -> ::Boolean
Returns
  • (::Boolean) — All container images are typically downloaded before any actions are executed. This helps prevent typos in URIs or issues like lack of disk space from wasting large amounts of compute resources.

    If set, this flag prevents the worker from downloading the image until just before the action is executed.

#disable_image_prefetch=

def disable_image_prefetch=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — All container images are typically downloaded before any actions are executed. This helps prevent typos in URIs or issues like lack of disk space from wasting large amounts of compute resources.

    If set, this flag prevents the worker from downloading the image until just before the action is executed.

#disable_standard_error_capture

def disable_standard_error_capture() -> ::Boolean
Returns
  • (::Boolean) — A small portion of the container's standard error stream is typically captured and returned inside the ContainerStoppedEvent. Setting this flag disables this functionality.

#disable_standard_error_capture=

def disable_standard_error_capture=(value) -> ::Boolean
Parameter
  • value (::Boolean) — A small portion of the container's standard error stream is typically captured and returned inside the ContainerStoppedEvent. Setting this flag disables this functionality.
Returns
  • (::Boolean) — A small portion of the container's standard error stream is typically captured and returned inside the ContainerStoppedEvent. Setting this flag disables this functionality.

#enable_fuse

def enable_fuse() -> ::Boolean
Returns
  • (::Boolean) — 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.

#enable_fuse=

def enable_fuse=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#encrypted_environment

def encrypted_environment() -> ::Google::Cloud::LifeSciences::V2beta::Secret
Returns
  • (::Google::Cloud::LifeSciences::V2beta::Secret) — 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.

#encrypted_environment=

def encrypted_environment=(value) -> ::Google::Cloud::LifeSciences::V2beta::Secret
Parameter
  • value (::Google::Cloud::LifeSciences::V2beta::Secret) — 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.

Returns
  • (::Google::Cloud::LifeSciences::V2beta::Secret) — 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.

#entrypoint

def entrypoint() -> ::String
Returns
  • (::String) — If specified, overrides the ENTRYPOINT specified in the container.

#entrypoint=

def entrypoint=(value) -> ::String
Parameter
  • value (::String) — If specified, overrides the ENTRYPOINT specified in the container.
Returns
  • (::String) — If specified, overrides the ENTRYPOINT specified in the container.

#environment

def environment() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#environment=

def environment=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#ignore_exit_status

def ignore_exit_status() -> ::Boolean
Returns
  • (::Boolean) — Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.

#ignore_exit_status=

def ignore_exit_status=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.
Returns
  • (::Boolean) — Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead.

#image_uri

def image_uri() -> ::String
Returns
  • (::String) — 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.

#image_uri=

def image_uri=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#mounts

def mounts() -> ::Array<::Google::Cloud::LifeSciences::V2beta::Mount>
Returns
  • (::Array<::Google::Cloud::LifeSciences::V2beta::Mount>) —

    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.

    • /google/logs All logs written during the pipeline execution.
    • /google/logs/output The combined standard output and standard error of all actions run as part of the pipeline execution.
    • /google/logs/action/*/stdout The complete contents of each individual action's standard output.
    • /google/logs/action/*/stderr The complete contents of each individual action's standard error output.

#mounts=

def mounts=(value) -> ::Array<::Google::Cloud::LifeSciences::V2beta::Mount>
Parameter
  • value (::Array<::Google::Cloud::LifeSciences::V2beta::Mount>) —

    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.

    • /google/logs All logs written during the pipeline execution.
    • /google/logs/output The combined standard output and standard error of all actions run as part of the pipeline execution.
    • /google/logs/action/*/stdout The complete contents of each individual action's standard output.
    • /google/logs/action/*/stderr The complete contents of each individual action's standard error output.
Returns
  • (::Array<::Google::Cloud::LifeSciences::V2beta::Mount>) —

    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.

    • /google/logs All logs written during the pipeline execution.
    • /google/logs/output The combined standard output and standard error of all actions run as part of the pipeline execution.
    • /google/logs/action/*/stdout The complete contents of each individual action's standard output.
    • /google/logs/action/*/stderr The complete contents of each individual action's standard error output.

#pid_namespace

def pid_namespace() -> ::String
Returns
  • (::String) — 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.

#pid_namespace=

def pid_namespace=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used.

#port_mappings

def port_mappings() -> ::Google::Protobuf::Map{::Integer => ::Integer}
Returns
  • (::Google::Protobuf::Map{::Integer => ::Integer}) — 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.

#port_mappings=

def port_mappings=(value) -> ::Google::Protobuf::Map{::Integer => ::Integer}
Parameter
  • value (::Google::Protobuf::Map{::Integer => ::Integer}) — 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.

Returns
  • (::Google::Protobuf::Map{::Integer => ::Integer}) — 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.

#publish_exposed_ports

def publish_exposed_ports() -> ::Boolean
Returns
  • (::Boolean) — 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.

#publish_exposed_ports=

def publish_exposed_ports=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#run_in_background

def run_in_background() -> ::Boolean
Returns
  • (::Boolean) — 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).

#run_in_background=

def run_in_background=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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).
Returns
  • (::Boolean) — 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).

#timeout

def timeout() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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.
Returns
  • (::Google::Protobuf::Duration) — 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.