Package com.google.cloud.batch.v1alpha

Class Runnable.Container

  • All Implemented Interfaces:
    Runnable.ContainerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Runnable
    public static final class Runnable.Container
extends com.google.protobuf.GeneratedMessageV3
implements Runnable.ContainerOrBuilder
     Container runnable.
    Protobuf type google.cloud.batch.v1alpha.Runnable.Container
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Runnable.Container.Builder
      Container runnable.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      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.
      com.google.protobuf.ProtocolStringList getCommandsList()
      Overrides the `CMD` specified in the container.
      static Runnable.Container getDefaultInstance()  
      Runnable.Container getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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.
      com.google.protobuf.Parser<Runnable.Container> getParserForType()  
      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.
      int getSerializedSize()  
      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.
      com.google.protobuf.ProtocolStringList 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.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Runnable.Container.Builder newBuilder()  
      static Runnable.Container.Builder newBuilder​(Runnable.Container prototype)  
      Runnable.Container.Builder newBuilderForType()  
      protected Runnable.Container.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Runnable.Container parseDelimitedFrom​(InputStream input)  
      static Runnable.Container parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runnable.Container parseFrom​(byte[] data)  
      static Runnable.Container parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runnable.Container parseFrom​(com.google.protobuf.ByteString data)  
      static Runnable.Container parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runnable.Container parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Runnable.Container parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runnable.Container parseFrom​(InputStream input)  
      static Runnable.Container parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Runnable.Container parseFrom​(ByteBuffer data)  
      static Runnable.Container parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Runnable.Container> parser()  
      Runnable.Container.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Method Detail

      • newInstance

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

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getImageUriBytes

        public com.google.protobuf.ByteString getImageUriBytes()
         The URI to pull the container image from.
        string image_uri = 1;
        Specified by:
        getImageUriBytes in interface Runnable.ContainerOrBuilder
        Returns:
        The bytes for imageUri.

      • getCommandsList

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

      • getCommandsCount

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

      • getCommands

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

      • getCommandsBytes

        public com.google.protobuf.ByteString getCommandsBytes​(int index)
         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;
        Specified by:
        getCommandsBytes in interface Runnable.ContainerOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the commands at the given index.

      • getEntrypointBytes

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

      • getVolumesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getVolumesList in interface Runnable.ContainerOrBuilder
        Returns:
        A list containing the volumes.

      • getVolumesCount

        public 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;
        Specified by:
        getVolumesCount in interface Runnable.ContainerOrBuilder
        Returns:
        The count of volumes.

      • getVolumes

        public 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;
        Specified by:
        getVolumes in interface Runnable.ContainerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The volumes at the given index.

      • getVolumesBytes

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

      • getOptions

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

      • getOptionsBytes

        public 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;
        Specified by:
        getOptionsBytes in interface Runnable.ContainerOrBuilder
        Returns:
        The bytes for options.

      • getBlockExternalNetwork

        public 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;
        Specified by:
        getBlockExternalNetwork in interface Runnable.ContainerOrBuilder
        Returns:
        The blockExternalNetwork.

      • getUsername

        public 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;
        Specified by:
        getUsername in interface Runnable.ContainerOrBuilder
        Returns:
        The username.

      • getUsernameBytes

        public 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;
        Specified by:
        getUsernameBytes in interface Runnable.ContainerOrBuilder
        Returns:
        The bytes for username.

      • getPassword

        public 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;
        Specified by:
        getPassword in interface Runnable.ContainerOrBuilder
        Returns:
        The password.

      • getPasswordBytes

        public 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;
        Specified by:
        getPasswordBytes in interface Runnable.ContainerOrBuilder
        Returns:
        The bytes for password.

      • getEnableImageStreaming

        public 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];
        Specified by:
        getEnableImageStreaming in interface Runnable.ContainerOrBuilder
        Returns:
        The enableImageStreaming.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

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

      • hashCode

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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

      • getDefaultInstanceForType

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