Package com.google.cloud.batch.v1alpha

Interface Runnable.ContainerOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Runnable.Container, Runnable.Container.Builder
    Enclosing class:
    Runnable
    public static interface Runnable.ContainerOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getBlockExternalNetwork()
      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.
      String getCommands​(int index)
      Overrides the `CMD` specified in the container.
      com.google.protobuf.ByteString getCommandsBytes​(int index)
      Overrides the `CMD` specified in the container.
      int getCommandsCount()
      Overrides the `CMD` specified in the container.
      List<String> getCommandsList()
      Overrides the `CMD` specified in the container.
      boolean getEnableImageStreaming()
      Optional.
      String getEntrypoint()
      Overrides the `ENTRYPOINT` specified in the container.
      com.google.protobuf.ByteString getEntrypointBytes()
      Overrides the `ENTRYPOINT` specified in the container.
      String getImageUri()
      The URI to pull the container image from.
      com.google.protobuf.ByteString getImageUriBytes()
      The URI to pull the container image from.
      String getOptions()
      Arbitrary additional options to include in the "docker run" command when running this container, e.g.
      com.google.protobuf.ByteString getOptionsBytes()
      Arbitrary additional options to include in the "docker run" command when running this container, e.g.
      String getPassword()
      Optional password for logging in to a docker registry.
      com.google.protobuf.ByteString getPasswordBytes()
      Optional password for logging in to a docker registry.
      String getUsername()
      Optional username for logging in to a docker registry.
      com.google.protobuf.ByteString getUsernameBytes()
      Optional username for logging in to a docker registry.
      String getVolumes​(int index)
      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.
      com.google.protobuf.ByteString getVolumesBytes​(int index)
      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.
      int getVolumesCount()
      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.
      List<String> getVolumesList()
      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.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getImageUri

        String getImageUri()
         The URI to pull the container image from.
        string image_uri = 1;
        Returns:
        The imageUri.

      • getImageUriBytes

        com.google.protobuf.ByteString getImageUriBytes()
         The URI to pull the container image from.
        string image_uri = 1;
        Returns:
        The bytes for imageUri.

      • getCommandsList

        List<String> getCommandsList()
         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.
        repeated string commands = 2;
        Returns:
        A list containing the commands.

      • getCommandsCount

        int getCommandsCount()
         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.
        repeated string commands = 2;
        Returns:
        The count of commands.

      • getCommands

        String getCommands​(int index)
         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.
        repeated string commands = 2;
        Parameters:
        index - The index of the element to return.
        Returns:
        The commands at the given index.

      • getCommandsBytes

        com.google.protobuf.ByteString getCommandsBytes​(int index)
         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.
        repeated string commands = 2;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the commands at the given index.

      • getEntrypoint

        String getEntrypoint()
         Overrides the `ENTRYPOINT` specified in the container.
        string entrypoint = 3;
        Returns:
        The entrypoint.

      • getEntrypointBytes

        com.google.protobuf.ByteString getEntrypointBytes()
         Overrides the `ENTRYPOINT` specified in the container.
        string entrypoint = 3;
        Returns:
        The bytes for entrypoint.

      • getVolumesList

        List<String> getVolumesList()
         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
        repeated string volumes = 7;
        Returns:
        A list containing the volumes.

      • getVolumesCount

        int getVolumesCount()
         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
        repeated string volumes = 7;
        Returns:
        The count of volumes.

      • getVolumes

        String getVolumes​(int index)
         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
        repeated string volumes = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The volumes at the given index.

      • getVolumesBytes

        com.google.protobuf.ByteString getVolumesBytes​(int index)
         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
        repeated string volumes = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the volumes at the given index.

      • getOptions

        String getOptions()
         Arbitrary additional options to include in the "docker run" command when
 running this container, e.g. "--network host".
        string options = 8;
        Returns:
        The options.

      • getOptionsBytes

        com.google.protobuf.ByteString getOptionsBytes()
         Arbitrary additional options to include in the "docker run" command when
 running this container, e.g. "--network host".
        string options = 8;
        Returns:
        The bytes for options.

      • getBlockExternalNetwork

        boolean getBlockExternalNetwork()
         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.
        bool block_external_network = 9;
        Returns:
        The blockExternalNetwork.

      • getUsername

        String getUsername()
         Optional username for logging in to a docker registry. If username
 matches `projects/*/secrets/*/versions/*` then Batch will read the
 username from the Secret Manager.
        string username = 10;
        Returns:
        The username.

      • getUsernameBytes

        com.google.protobuf.ByteString getUsernameBytes()
         Optional username for logging in to a docker registry. If username
 matches `projects/*/secrets/*/versions/*` then Batch will read the
 username from the Secret Manager.
        string username = 10;
        Returns:
        The bytes for username.

      • getPassword

        String getPassword()
         Optional password for logging in to a docker registry. If password
 matches `projects/*/secrets/*/versions/*` then Batch will read the
 password from the Secret Manager;
        string password = 11;
        Returns:
        The password.

      • getPasswordBytes

        com.google.protobuf.ByteString getPasswordBytes()
         Optional password for logging in to a docker registry. If password
 matches `projects/*/secrets/*/versions/*` then Batch will read the
 password from the Secret Manager;
        string password = 11;
        Returns:
        The bytes for password.

      • getEnableImageStreaming

        boolean getEnableImageStreaming()
         Optional. Not yet implemented.
 If set to true, container will run with Image streaming.
 The container runtime will be changed to containerd
 instead of docker. Currently, only imageUri, commands, entrypoint
 and volumes are supported and any other fields will be ignored.
        bool enable_image_streaming = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enableImageStreaming.