Class: Google::Cloud::Batch::V1::Runnable

Inherits:

Object

• Object
• Google::Cloud::Batch::V1::Runnable

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/batch/v1/task.rb

Overview

Runnable describes instructions for executing a specific script or container as part of a Task.

Defined Under Namespace

Classes: Barrier, Container, LabelsEntry, Script

Instance Attribute Summary

• #always_run ⇒ ::Boolean

  By default, after a Runnable fails, no further Runnable are executed.

• #background ⇒ ::Boolean

  This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables.

• #barrier ⇒ ::Google::Cloud::Batch::V1::Runnable::Barrier

  Barrier runnable.

• #container ⇒ ::Google::Cloud::Batch::V1::Runnable::Container

  Container runnable.

• #display_name ⇒ ::String

  Optional.

• #environment ⇒ ::Google::Cloud::Batch::V1::Environment

  Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).

• #ignore_exit_status ⇒ ::Boolean

  Normally, a non-zero exit status causes the Task to fail.

• #labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  Labels for this Runnable.

• #script ⇒ ::Google::Cloud::Batch::V1::Runnable::Script

  Script runnable.

• #timeout ⇒ ::Google::Protobuf::Duration

  Timeout for this Runnable.

Instance Attribute Details

#always_run ⇒ ::Boolean

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#background ⇒ ::Boolean

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#barrier ⇒ ::Google::Cloud::Batch::V1::Runnable::Barrier

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#container ⇒ ::Google::Cloud::Batch::V1::Runnable::Container

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#environment ⇒ ::Google::Cloud::Batch::V1::Environment

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore_exit_status ⇒ ::Boolean

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#script ⇒ ::Google::Cloud::Batch::V1::Runnable::Script

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#timeout ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/cloud/batch/v1/task.rb', line 200

class Runnable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Container runnable.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI to pull the container image from.
  # @!attribute [rw] commands
  #   @return [::Array<::String>]
  #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
  #     (either in the container image or with the entrypoint field below) then
  #     commands are appended as arguments to the ENTRYPOINT.
  # @!attribute [rw] entrypoint
  #   @return [::String]
  #     Overrides the `ENTRYPOINT` specified in the container.
  # @!attribute [rw] volumes
  #   @return [::Array<::String>]
  #     Volumes to mount (bind mount) from the host machine files or directories
  #     into the container, formatted to match docker run's --volume option,
  #     e.g. /foo:/bar, or /foo:/bar:ro
  #
  #     If the `TaskSpec.Volumes` field is specified but this field is not, Batch
  #     will mount each volume from the host machine to the container with the
  #     same mount path by default. In this case, the default mount option for
  #     containers will be read-only (ro) for existing persistent disks and
  #     read-write (rw) for other volume types, regardless of the original mount
  #     options specified in `TaskSpec.Volumes`. If you need different mount
  #     settings, you can explicitly configure them in this field.
  # @!attribute [rw] options
  #   @return [::String]
  #     Arbitrary additional options to include in the "docker run" command when
  #     running this container, e.g. "--network host".
  # @!attribute [rw] block_external_network
  #   @return [::Boolean]
  #     If set to true, external network access to and from container will be
  #     blocked, containers that are with block_external_network as true can
  #     still communicate with each other, network cannot be specified in the
  #     `container.options` field.
  # @!attribute [rw] username
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     username to login to the Docker registry that contains the image.
  #
  #     You can either specify the username directly by using plain text or
  #     specify an encrypted username by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`. However, using a secret is
  #     recommended for enhanced security.
  #
  #     Caution: If you specify the username using plain text, you risk the
  #     username being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the username instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] password
  #   @return [::String]
  #     Required if the container image is from a private Docker registry. The
  #     password to login to the Docker registry that contains the image.
  #
  #     For security, it is strongly recommended to specify an
  #     encrypted password by using a Secret Manager secret:
  #     `projects/*/secrets/*/versions/*`.
  #
  #     Warning: If you specify the password using plain text, you risk the
  #     password being exposed to any users who can view the job or its logs.
  #     To avoid this risk, specify a secret that contains the password instead.
  #
  #     Learn more about [Secret
  #     Manager](https://cloud.google.com/secret-manager/docs/) and [using
  #     Secret Manager with
  #     Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
  # @!attribute [rw] enable_image_streaming
  #   @return [::Boolean]
  #     Optional. If set to true, this container runnable uses Image streaming.
  #
  #     Use Image streaming to allow the runnable to initialize without
  #     waiting for the entire container image to download, which can
  #     significantly reduce startup time for large container images.
  #
  #     When `enableImageStreaming` is set to true, the container
  #     runtime is [containerd](https://containerd.io/) instead of Docker.
  #     Additionally, this container runnable only supports the following
  #     `container` subfields: `imageUri`,
  #     `commands[]`, `entrypoint`, and
  #     `volumes[]`; any other `container` subfields are ignored.
  #
  #     For more information about the requirements and limitations for using
  #     Image streaming with Batch, see the [`image-streaming`
  #     sample on
  #     GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
  class Container
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Script runnable.
  # @!attribute [rw] path
  #   @return [::String]
  #     Script file path on the host VM.
  #
  #     To specify an interpreter, please add a `#!<interpreter>`(also known as
  #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
  #     first line of the file.(For example, to execute the script using bash,
  #     `#!/bin/bash` should be the first line of the file. To execute the
  #     script using`Python3`, `#!/usr/bin/env python3` should be the first
  #     line of the file.) Otherwise, the file will by default be executed by
  #     `/bin/sh`.
  # @!attribute [rw] text
  #   @return [::String]
  #     Shell script text.
  #
  #     To specify an interpreter, please add a `#!<interpreter>\n` at the
  #     beginning of the text.(For example, to execute the script using bash,
  #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
  #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
  #     by default be executed by `/bin/sh`.
  class Script
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Barrier runnable blocks until all tasks in a taskgroup reach it.
  # @!attribute [rw] name
  #   @return [::String]
  #     Barriers are identified by their index in runnable list.
  #     Names are not required, but if present should be an identifier.
  class Barrier
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end