Class Action (0.38.0)

public final class Action extends GeneratedMessageV3 implements ActionOrBuilder

Specifies a single action that runs a Docker container.

Protobuf type google.cloud.lifesciences.v2beta.Action

Implements

ActionOrBuilder

Static Fields

ALWAYS_RUN_FIELD_NUMBER

public static final int ALWAYS_RUN_FIELD_NUMBER
Field Value
TypeDescription
int

BLOCK_EXTERNAL_NETWORK_FIELD_NUMBER

public static final int BLOCK_EXTERNAL_NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

COMMANDS_FIELD_NUMBER

public static final int COMMANDS_FIELD_NUMBER
Field Value
TypeDescription
int

CONTAINER_NAME_FIELD_NUMBER

public static final int CONTAINER_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

CREDENTIALS_FIELD_NUMBER

public static final int CREDENTIALS_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLE_IMAGE_PREFETCH_FIELD_NUMBER

public static final int DISABLE_IMAGE_PREFETCH_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLE_STANDARD_ERROR_CAPTURE_FIELD_NUMBER

public static final int DISABLE_STANDARD_ERROR_CAPTURE_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_FUSE_FIELD_NUMBER

public static final int ENABLE_FUSE_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTED_ENVIRONMENT_FIELD_NUMBER

public static final int ENCRYPTED_ENVIRONMENT_FIELD_NUMBER
Field Value
TypeDescription
int

ENTRYPOINT_FIELD_NUMBER

public static final int ENTRYPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
TypeDescription
int

IGNORE_EXIT_STATUS_FIELD_NUMBER

public static final int IGNORE_EXIT_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MOUNTS_FIELD_NUMBER

public static final int MOUNTS_FIELD_NUMBER
Field Value
TypeDescription
int

PID_NAMESPACE_FIELD_NUMBER

public static final int PID_NAMESPACE_FIELD_NUMBER
Field Value
TypeDescription
int

PORT_MAPPINGS_FIELD_NUMBER

public static final int PORT_MAPPINGS_FIELD_NUMBER
Field Value
TypeDescription
int

PUBLISH_EXPOSED_PORTS_FIELD_NUMBER

public static final int PUBLISH_EXPOSED_PORTS_FIELD_NUMBER
Field Value
TypeDescription
int

RUN_IN_BACKGROUND_FIELD_NUMBER

public static final int RUN_IN_BACKGROUND_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Action getDefaultInstance()
Returns
TypeDescription
Action

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Action.Builder newBuilder()
Returns
TypeDescription
Action.Builder

newBuilder(Action prototype)

public static Action.Builder newBuilder(Action prototype)
Parameter
NameDescription
prototypeAction
Returns
TypeDescription
Action.Builder

parseDelimitedFrom(InputStream input)

public static Action parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Action
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Action parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Action
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Action parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Action
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Action parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Action
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Action parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Action
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Action parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Action
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Action parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Action
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Action parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Action
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Action parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Action
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Action parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Action
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Action parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Action
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Action parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Action
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Action> parser()
Returns
TypeDescription
Parser<Action>

Methods

containsEnvironment(String key)

public boolean containsEnvironment(String key)

The environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values.

In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten.

GOOGLE_PIPELINE_FAILED will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the IGNORE_EXIT_STATUS flag set). This can be used to determine if additional debug or logging actions should execute.

GOOGLE_LAST_EXIT_STATUS will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.

map<string, string> environment = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsPortMappings(int key)

public boolean containsPortMappings(int key)

A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the PUBLISH_EXPOSED_PORTS flag instead.

The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the ContainerStartedEvent in the operation metadata.

map<int32, int32> port_mappings = 8;

Parameter
NameDescription
keyint
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAlwaysRun()

public boolean getAlwaysRun()

By default, after an action fails, no further actions are run. This flag indicates that this action must be run even if the pipeline has already failed. This is useful for actions that copy output files off of the VM or for debugging. Note that no actions will be run if image prefetching fails.

bool always_run = 15;

Returns
TypeDescription
boolean

The alwaysRun.

getBlockExternalNetwork()

public boolean getBlockExternalNetwork()

Prevents the container from accessing the external network.

bool block_external_network = 20;

Returns
TypeDescription
boolean

The blockExternalNetwork.

getCommands(int index)

public String getCommands(int index)

If specified, overrides the CMD specified in the container. If the container also has an ENTRYPOINT the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.

repeated string commands = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The commands at the given index.

getCommandsBytes(int index)

public ByteString getCommandsBytes(int index)

If specified, overrides the CMD specified in the container. If the container also has an ENTRYPOINT the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.

repeated string commands = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the commands at the given index.

getCommandsCount()

public int getCommandsCount()

If specified, overrides the CMD specified in the container. If the container also has an ENTRYPOINT the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.

repeated string commands = 3;

Returns
TypeDescription
int

The count of commands.

getCommandsList()

public ProtocolStringList getCommandsList()

If specified, overrides the CMD specified in the container. If the container also has an ENTRYPOINT the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.

repeated string commands = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the commands.

getContainerName()

public String getContainerName()

An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.

string container_name = 1;

Returns
TypeDescription
String

The containerName.

getContainerNameBytes()

public ByteString getContainerNameBytes()

An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.

string container_name = 1;

Returns
TypeDescription
ByteString

The bytes for containerName.

getCredentials()

public Secret getCredentials()

If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret.

The secret must decrypt to a JSON-encoded dictionary containing both username and password keys.

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

Returns
TypeDescription
Secret

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;

Returns
TypeDescription
SecretOrBuilder

getDefaultInstanceForType()

public Action getDefaultInstanceForType()
Returns
TypeDescription
Action

getDisableImagePrefetch()

public boolean getDisableImagePrefetch()

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

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

bool disable_image_prefetch = 18;

Returns
TypeDescription
boolean

The disableImagePrefetch.

getDisableStandardErrorCapture()

public boolean getDisableStandardErrorCapture()

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

bool disable_standard_error_capture = 19;

Returns
TypeDescription
boolean

The disableStandardErrorCapture.

getEnableFuse()

public boolean getEnableFuse()

Enable access to the FUSE device for this action. Filesystems can then be mounted into disks shared with other actions. The other actions do not need the enable_fuse flag to access the mounted filesystem.

This has the effect of causing the container to be executed with CAP_SYS_ADMIN and exposes /dev/fuse to the container, so use it only for containers you trust.

bool enable_fuse = 16;

Returns
TypeDescription
boolean

The enableFuse.

getEncryptedEnvironment()

public Secret getEncryptedEnvironment()

The encrypted environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values.

The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the environment field.

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

Returns
TypeDescription
Secret

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 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
TypeDescription
SecretOrBuilder

getEntrypoint()

public String getEntrypoint()

If specified, overrides the ENTRYPOINT specified in the container.

string entrypoint = 4;

Returns
TypeDescription
String

The entrypoint.

getEntrypointBytes()

public ByteString getEntrypointBytes()

If specified, overrides the ENTRYPOINT specified in the container.

string entrypoint = 4;

Returns
TypeDescription
ByteString

The bytes for entrypoint.

getEnvironment() (deprecated)

public Map<String,String> getEnvironment()

Use #getEnvironmentMap() instead.

Returns
TypeDescription
Map<String,String>

getEnvironmentCount()

public int getEnvironmentCount()

The environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values.

In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten.

GOOGLE_PIPELINE_FAILED will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the IGNORE_EXIT_STATUS flag set). This can be used to determine if additional debug or logging actions should execute.

GOOGLE_LAST_EXIT_STATUS will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.

map<string, string> environment = 5;

Returns
TypeDescription
int

getEnvironmentMap()

public Map<String,String> getEnvironmentMap()

The environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values.

In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten.

GOOGLE_PIPELINE_FAILED will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the IGNORE_EXIT_STATUS flag set). This can be used to determine if additional debug or logging actions should execute.

GOOGLE_LAST_EXIT_STATUS will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.

map<string, string> environment = 5;

Returns
TypeDescription
Map<String,String>

getEnvironmentOrDefault(String key, String defaultValue)

public String getEnvironmentOrDefault(String key, String defaultValue)

The environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values.

In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten.

GOOGLE_PIPELINE_FAILED will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the IGNORE_EXIT_STATUS flag set). This can be used to determine if additional debug or logging actions should execute.

GOOGLE_LAST_EXIT_STATUS will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.

map<string, string> environment = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getEnvironmentOrThrow(String key)

public String getEnvironmentOrThrow(String key)

The environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values.

In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten.

GOOGLE_PIPELINE_FAILED will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the IGNORE_EXIT_STATUS flag set). This can be used to determine if additional debug or logging actions should execute.

GOOGLE_LAST_EXIT_STATUS will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.

map<string, string> environment = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getIgnoreExitStatus()

public boolean getIgnoreExitStatus()

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

bool ignore_exit_status = 13;

Returns
TypeDescription
boolean

The ignoreExitStatus.

getImageUri()

public String getImageUri()

Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline.

The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases.

If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.cloud.lifesciences.v2beta.Action.credentials field.

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

Returns
TypeDescription
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline.

The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases.

If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.cloud.lifesciences.v2beta.Action.credentials field.

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

Returns
TypeDescription
ByteString

The bytes for imageUri.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.

map<string, string> labels = 10;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.

map<string, string> labels = 10;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.

map<string, string> labels = 10;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMounts(int index)

public Mount getMounts(int index)

A list of mounts to make available to the action.

In addition to the values specified here, every action has a special virtual disk mounted under /google that contains log files and other operational components.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Mount

getMountsCount()

public int getMountsCount()

A list of mounts to make available to the action.

In addition to the values specified here, every action has a special virtual disk mounted under /google that contains log files and other operational components.

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

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

Returns
TypeDescription
int

getMountsList()

public List<Mount> getMountsList()

A list of mounts to make available to the action.

In addition to the values specified here, every action has a special virtual disk mounted under /google that contains log files and other operational components.

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

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

Returns
TypeDescription
List<Mount>

getMountsOrBuilder(int index)

public MountOrBuilder getMountsOrBuilder(int index)

A list of mounts to make available to the action.

In addition to the values specified here, every action has a special virtual disk mounted under /google that contains log files and other operational components.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
MountOrBuilder

getMountsOrBuilderList()

public List<? extends MountOrBuilder> getMountsOrBuilderList()

A list of mounts to make available to the action.

In addition to the values specified here, every action has a special virtual disk mounted under /google that contains log files and other operational components.

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

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

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

getParserForType()

public Parser<Action> getParserForType()
Returns
TypeDescription
Parser<Action>
Overrides

getPidNamespace()

public String getPidNamespace()

An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used.

string pid_namespace = 6;

Returns
TypeDescription
String

The pidNamespace.

getPidNamespaceBytes()

public ByteString getPidNamespaceBytes()

An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used.

string pid_namespace = 6;

Returns
TypeDescription
ByteString

The bytes for pidNamespace.

getPortMappings() (deprecated)

public Map<Integer,Integer> getPortMappings()

Use #getPortMappingsMap() instead.

Returns
TypeDescription
Map<java.lang.Integer,java.lang.Integer>

getPortMappingsCount()

public int getPortMappingsCount()

A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the PUBLISH_EXPOSED_PORTS flag instead.

The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the ContainerStartedEvent in the operation metadata.

map<int32, int32> port_mappings = 8;

Returns
TypeDescription
int

getPortMappingsMap()

public Map<Integer,Integer> getPortMappingsMap()

A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the PUBLISH_EXPOSED_PORTS flag instead.

The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the ContainerStartedEvent in the operation metadata.

map<int32, int32> port_mappings = 8;

Returns
TypeDescription
Map<java.lang.Integer,java.lang.Integer>

getPortMappingsOrDefault(int key, int defaultValue)

public int getPortMappingsOrDefault(int key, int defaultValue)

A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the PUBLISH_EXPOSED_PORTS flag instead.

The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the ContainerStartedEvent in the operation metadata.

map<int32, int32> port_mappings = 8;

Parameters
NameDescription
keyint
defaultValueint
Returns
TypeDescription
int

getPortMappingsOrThrow(int key)

public int getPortMappingsOrThrow(int key)

A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the PUBLISH_EXPOSED_PORTS flag instead.

The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the ContainerStartedEvent in the operation metadata.

map<int32, int32> port_mappings = 8;

Parameter
NameDescription
keyint
Returns
TypeDescription
int

getPublishExposedPorts()

public boolean getPublishExposedPorts()

Exposes all ports specified by EXPOSE statements in the container. To discover the host side port numbers, consult the ACTION_STARTED event in the operation metadata.

bool publish_exposed_ports = 17;

Returns
TypeDescription
boolean

The publishExposedPorts.

getRunInBackground()

public boolean getRunInBackground()

This flag allows an action to continue running in the background while executing subsequent actions. This is useful to provide services to other actions (or to provide debugging support tools like SSH servers).

bool run_in_background = 14;

Returns
TypeDescription
boolean

The runInBackground.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTimeout()

public Duration getTimeout()

The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the ALWAYS_RUN and IGNORE_EXIT_STATUS flags.

.google.protobuf.Duration timeout = 12;

Returns
TypeDescription
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the ALWAYS_RUN and IGNORE_EXIT_STATUS flags.

.google.protobuf.Duration timeout = 12;

Returns
TypeDescription
DurationOrBuilder

hasCredentials()

public boolean hasCredentials()

If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret.

The secret must decrypt to a JSON-encoded dictionary containing both username and password keys.

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

Returns
TypeDescription
boolean

Whether the credentials field is set.

hasEncryptedEnvironment()

public boolean hasEncryptedEnvironment()

The encrypted environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values.

The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the environment field.

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

Returns
TypeDescription
boolean

Whether the encryptedEnvironment field is set.

hasTimeout()

public boolean hasTimeout()

The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the ALWAYS_RUN and IGNORE_EXIT_STATUS flags.

.google.protobuf.Duration timeout = 12;

Returns
TypeDescription
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Action.Builder newBuilderForType()
Returns
TypeDescription
Action.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Action.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Action.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Action.Builder toBuilder()
Returns
TypeDescription
Action.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException