Batch V1 API - Class Google::Cloud::Batch::V1::Runnable::Container (v0.19.0)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::Runnable::Container.

Container runnable.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#block_external_network

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

#block_external_network=

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

#commands

def commands() -> ::Array<::String>
Returns
  • (::Array<::String>) — Required for some container images. Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then these commands are appended as arguments to the ENTRYPOINT.

#commands=

def commands=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Required for some container images. Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then these commands are appended as arguments to the ENTRYPOINT.
Returns
  • (::Array<::String>) — Required for some container images. Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then these commands are appended as arguments to the ENTRYPOINT.

#enable_image_streaming

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

#enable_image_streaming=

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

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

#entrypoint

def entrypoint() -> ::String
Returns
  • (::String) — Required for some container images. Overrides the ENTRYPOINT specified in the container.

#entrypoint=

def entrypoint=(value) -> ::String
Parameter
  • value (::String) — Required for some container images. Overrides the ENTRYPOINT specified in the container.
Returns
  • (::String) — Required for some container images. Overrides the ENTRYPOINT specified in the container.

#image_uri

def image_uri() -> ::String
Returns
  • (::String) — Required. The URI to pull the container image from.

#image_uri=

def image_uri=(value) -> ::String
Parameter
  • value (::String) — Required. The URI to pull the container image from.
Returns
  • (::String) — Required. The URI to pull the container image from.

#options

def options() -> ::String
Returns
  • (::String) — Required for some container images. Arbitrary additional options to include in the docker run command when running this container—for example, --network host. For the --volume option, use the volumes field for the container.

#options=

def options=(value) -> ::String
Parameter
  • value (::String) — Required for some container images. Arbitrary additional options to include in the docker run command when running this container—for example, --network host. For the --volume option, use the volumes field for the container.
Returns
  • (::String) — Required for some container images. Arbitrary additional options to include in the docker run command when running this container—for example, --network host. For the --volume option, use the volumes field for the container.

#password

def password() -> ::String
Returns
  • (::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 and using Secret Manager with Batch.

#password=

def password=(value) -> ::String
Parameter
  • value (::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 and using Secret Manager with Batch.

Returns
  • (::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 and using Secret Manager with Batch.

#username

def username() -> ::String
Returns
  • (::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 and using Secret Manager with Batch.

#username=

def username=(value) -> ::String
Parameter
  • value (::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 and using Secret Manager with Batch.

Returns
  • (::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 and using Secret Manager with Batch.

#volumes

def volumes() -> ::Array<::String>
Returns
  • (::Array<::String>) — Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match --volume option for the docker run command—for example, /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.

#volumes=

def volumes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match --volume option for the docker run command—for example, /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.

Returns
  • (::Array<::String>) — Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match --volume option for the docker run command—for example, /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.