Package com.google.cloud.lifesciences.v2beta

Class Action

  • All Implemented Interfaces:
    ActionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Action
extends com.google.protobuf.GeneratedMessageV3
implements ActionOrBuilder
     Specifies a single action that runs a Docker container.
    Protobuf type google.cloud.lifesciences.v2beta.Action
    See Also:
    Serialized Form

    • Field Detail

      • CONTAINER_NAME_FIELD_NUMBER

        public static final int CONTAINER_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTRYPOINT_FIELD_NUMBER

        public static final int ENTRYPOINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENVIRONMENT_FIELD_NUMBER

        public static final int ENVIRONMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENCRYPTED_ENVIRONMENT_FIELD_NUMBER

        public static final int ENCRYPTED_ENVIRONMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PID_NAMESPACE_FIELD_NUMBER

        public static final int PID_NAMESPACE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PORT_MAPPINGS_FIELD_NUMBER

        public static final int PORT_MAPPINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREDENTIALS_FIELD_NUMBER

        public static final int CREDENTIALS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IGNORE_EXIT_STATUS_FIELD_NUMBER

        public static final int IGNORE_EXIT_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUN_IN_BACKGROUND_FIELD_NUMBER

        public static final int RUN_IN_BACKGROUND_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALWAYS_RUN_FIELD_NUMBER

        public static final int ALWAYS_RUN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_FUSE_FIELD_NUMBER

        public static final int ENABLE_FUSE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PUBLISH_EXPOSED_PORTS_FIELD_NUMBER

        public static final int PUBLISH_EXPOSED_PORTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_IMAGE_PREFETCH_FIELD_NUMBER

        public static final int DISABLE_IMAGE_PREFETCH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_STANDARD_ERROR_CAPTURE_FIELD_NUMBER

        public static final int DISABLE_STANDARD_ERROR_CAPTURE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BLOCK_EXTERNAL_NETWORK_FIELD_NUMBER

        public static final int BLOCK_EXTERNAL_NETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        getContainerName in interface ActionOrBuilder
        Returns:
        The containerName.

      • getContainerNameBytes

        public 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;
        Specified by:
        getContainerNameBytes in interface ActionOrBuilder
        Returns:
        The bytes for containerName.

      • 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][google.cloud.lifesciences.v2beta.Action.credentials]
 field.
        string image_uri = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getImageUri in interface ActionOrBuilder
        Returns:
        The imageUri.

      • getImageUriBytes

        public 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];
        Specified by:
        getImageUriBytes in interface ActionOrBuilder
        Returns:
        The bytes for imageUri.

      • getCommandsList

        public com.google.protobuf.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;
        Specified by:
        getCommandsList in interface ActionOrBuilder
        Returns:
        A list containing the commands.

      • 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;
        Specified by:
        getCommandsCount in interface ActionOrBuilder
        Returns:
        The count of commands.

      • getCommands

        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;
        Specified by:
        getCommands in interface ActionOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The commands at the given index.

      • getCommandsBytes

        public 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;
        Specified by:
        getCommandsBytes in interface ActionOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the commands at the given index.

      • getEntrypoint

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

      • getEntrypointBytes

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

      • getEnvironmentCount

        public int getEnvironmentCount()
        Description copied from interface: ActionOrBuilder
         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;
        Specified by:
        getEnvironmentCount in interface ActionOrBuilder

      • containsEnvironment

        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][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;
        Specified by:
        containsEnvironment in interface ActionOrBuilder

      • 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][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;
        Specified by:
        getEnvironmentMap in interface ActionOrBuilder

      • getEnvironmentOrDefault

        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][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;
        Specified by:
        getEnvironmentOrDefault in interface ActionOrBuilder

      • getEnvironmentOrThrow

        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][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;
        Specified by:
        getEnvironmentOrThrow in interface ActionOrBuilder

      • 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][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;
        Specified by:
        hasEncryptedEnvironment in interface ActionOrBuilder
        Returns:
        Whether the encryptedEnvironment field is set.

      • 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][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;
        Specified by:
        getEncryptedEnvironment in interface ActionOrBuilder
        Returns:
        The encryptedEnvironment.

      • 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][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;
        Specified by:
        getEncryptedEnvironmentOrBuilder in interface ActionOrBuilder

      • 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;
        Specified by:
        getPidNamespace in interface ActionOrBuilder
        Returns:
        The pidNamespace.

      • getPidNamespaceBytes

        public 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;
        Specified by:
        getPidNamespaceBytes in interface ActionOrBuilder
        Returns:
        The bytes for pidNamespace.

      • getPortMappingsCount

        public int getPortMappingsCount()
        Description copied from interface: ActionOrBuilder
         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;
        Specified by:
        getPortMappingsCount in interface ActionOrBuilder

      • containsPortMappings

        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;
        Specified by:
        containsPortMappings in interface ActionOrBuilder

      • 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;
        Specified by:
        getPortMappingsMap in interface ActionOrBuilder

      • getPortMappingsOrDefault

        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;
        Specified by:
        getPortMappingsOrDefault in interface ActionOrBuilder

      • getPortMappingsOrThrow

        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;
        Specified by:
        getPortMappingsOrThrow in interface ActionOrBuilder

      • 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;
        Specified by:
        getMountsList in interface ActionOrBuilder

      • 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;
        Specified by:
        getMountsOrBuilderList in interface ActionOrBuilder

      • 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;
        Specified by:
        getMountsCount in interface ActionOrBuilder

      • getMounts

        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;
        Specified by:
        getMounts in interface ActionOrBuilder

      • getMountsOrBuilder

        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;
        Specified by:
        getMountsOrBuilder in interface ActionOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ActionOrBuilder
         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;
        Specified by:
        getLabelsCount in interface ActionOrBuilder

      • containsLabels

        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;
        Specified by:
        containsLabels in interface ActionOrBuilder

      • 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;
        Specified by:
        getLabelsMap in interface ActionOrBuilder

      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface ActionOrBuilder

      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface ActionOrBuilder

      • 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;
        Specified by:
        hasCredentials in interface ActionOrBuilder
        Returns:
        Whether the credentials field is set.

      • 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;
        Specified by:
        getCredentials in interface ActionOrBuilder
        Returns:
        The credentials.

      • 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;
        Specified by:
        getCredentialsOrBuilder in interface ActionOrBuilder

      • 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;
        Specified by:
        hasTimeout in interface ActionOrBuilder
        Returns:
        Whether the timeout field is set.

      • getTimeout

        public 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;
        Specified by:
        getTimeout in interface ActionOrBuilder
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        public 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;
        Specified by:
        getTimeoutOrBuilder in interface ActionOrBuilder

      • 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;
        Specified by:
        getIgnoreExitStatus in interface ActionOrBuilder
        Returns:
        The ignoreExitStatus.

      • 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;
        Specified by:
        getRunInBackground in interface ActionOrBuilder
        Returns:
        The runInBackground.

      • 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;
        Specified by:
        getAlwaysRun in interface ActionOrBuilder
        Returns:
        The alwaysRun.

      • 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;
        Specified by:
        getEnableFuse in interface ActionOrBuilder
        Returns:
        The enableFuse.

      • 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;
        Specified by:
        getPublishExposedPorts in interface ActionOrBuilder
        Returns:
        The publishExposedPorts.

      • 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;
        Specified by:
        getDisableImagePrefetch in interface ActionOrBuilder
        Returns:
        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;
        Specified by:
        getDisableStandardErrorCapture in interface ActionOrBuilder
        Returns:
        The disableStandardErrorCapture.

      • getBlockExternalNetwork

        public boolean getBlockExternalNetwork()
         Prevents the container from accessing the external network.
        bool block_external_network = 20;
        Specified by:
        getBlockExternalNetwork in interface ActionOrBuilder
        Returns:
        The blockExternalNetwork.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Action parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Action parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Action parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Action parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Action parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Action parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Action parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Action.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Action.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Action.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Action getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Action> parser()

      • getParserForType

        public com.google.protobuf.Parser<Action> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Action getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder