Package com.google.cloud.batch.v1alpha

Class Runnable.Container.Builder

    • Method Detail

      • 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.Builder<Runnable.Container.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public Runnable.Container.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • clearField

        public Runnable.Container.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • clearOneof

        public Runnable.Container.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • setRepeatedField

        public Runnable.Container.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • addRepeatedField

        public Runnable.Container.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • mergeFrom

        public Runnable.Container.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Runnable.Container.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • mergeFrom

        public Runnable.Container.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Runnable.Container.Builder>
        Throws:
        IOException

      • 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.

      • setImageUri

        public Runnable.Container.Builder setImageUri​(String value)
         The URI to pull the container image from.
        string image_uri = 1;
        Parameters:
        value - The imageUri to set.
        Returns:
        This builder for chaining.

      • clearImageUri

        public Runnable.Container.Builder clearImageUri()
         The URI to pull the container image from.
        string image_uri = 1;
        Returns:
        This builder for chaining.

      • setImageUriBytes

        public Runnable.Container.Builder setImageUriBytes​(com.google.protobuf.ByteString value)
         The URI to pull the container image from.
        string image_uri = 1;
        Parameters:
        value - The bytes for imageUri to set.
        Returns:
        This builder for chaining.

      • 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.

      • setCommands

        public Runnable.Container.Builder setCommands​(int index,
                                              String value)
         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 to set the value at.
        value - The commands to set.
        Returns:
        This builder for chaining.

      • addCommands

        public Runnable.Container.Builder addCommands​(String value)
         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:
        value - The commands to add.
        Returns:
        This builder for chaining.

      • addAllCommands

        public Runnable.Container.Builder addAllCommands​(Iterable<String> values)
         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:
        values - The commands to add.
        Returns:
        This builder for chaining.

      • clearCommands

        public Runnable.Container.Builder clearCommands()
         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:
        This builder for chaining.

      • addCommandsBytes

        public Runnable.Container.Builder addCommandsBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the commands to add.
        Returns:
        This builder for chaining.

      • 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.

      • setEntrypoint

        public Runnable.Container.Builder setEntrypoint​(String value)
         Overrides the `ENTRYPOINT` specified in the container.
        string entrypoint = 3;
        Parameters:
        value - The entrypoint to set.
        Returns:
        This builder for chaining.

      • clearEntrypoint

        public Runnable.Container.Builder clearEntrypoint()
         Overrides the `ENTRYPOINT` specified in the container.
        string entrypoint = 3;
        Returns:
        This builder for chaining.

      • setEntrypointBytes

        public Runnable.Container.Builder setEntrypointBytes​(com.google.protobuf.ByteString value)
         Overrides the `ENTRYPOINT` specified in the container.
        string entrypoint = 3;
        Parameters:
        value - The bytes for entrypoint to set.
        Returns:
        This builder for chaining.

      • 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.

      • setVolumes

        public Runnable.Container.Builder setVolumes​(int index,
                                             String value)
         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 to set the value at.
        value - The volumes to set.
        Returns:
        This builder for chaining.

      • addVolumes

        public Runnable.Container.Builder addVolumes​(String value)
         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:
        value - The volumes to add.
        Returns:
        This builder for chaining.

      • addAllVolumes

        public Runnable.Container.Builder addAllVolumes​(Iterable<String> values)
         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:
        values - The volumes to add.
        Returns:
        This builder for chaining.

      • clearVolumes

        public Runnable.Container.Builder clearVolumes()
         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:
        This builder for chaining.

      • addVolumesBytes

        public Runnable.Container.Builder addVolumesBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the volumes to add.
        Returns:
        This builder for chaining.

      • 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.

      • setOptions

        public Runnable.Container.Builder setOptions​(String value)
         Arbitrary additional options to include in the "docker run" command when
 running this container, e.g. "--network host".
        string options = 8;
        Parameters:
        value - The options to set.
        Returns:
        This builder for chaining.

      • clearOptions

        public Runnable.Container.Builder clearOptions()
         Arbitrary additional options to include in the "docker run" command when
 running this container, e.g. "--network host".
        string options = 8;
        Returns:
        This builder for chaining.

      • setOptionsBytes

        public Runnable.Container.Builder setOptionsBytes​(com.google.protobuf.ByteString value)
         Arbitrary additional options to include in the "docker run" command when
 running this container, e.g. "--network host".
        string options = 8;
        Parameters:
        value - The bytes for options to set.
        Returns:
        This builder for chaining.

      • 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.

      • setBlockExternalNetwork

        public Runnable.Container.Builder setBlockExternalNetwork​(boolean value)
         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;
        Parameters:
        value - The blockExternalNetwork to set.
        Returns:
        This builder for chaining.

      • clearBlockExternalNetwork

        public Runnable.Container.Builder clearBlockExternalNetwork()
         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:
        This builder for chaining.

      • 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.

      • setUsername

        public Runnable.Container.Builder setUsername​(String value)
         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;
        Parameters:
        value - The username to set.
        Returns:
        This builder for chaining.

      • clearUsername

        public Runnable.Container.Builder clearUsername()
         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:
        This builder for chaining.

      • setUsernameBytes

        public Runnable.Container.Builder setUsernameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for username to set.
        Returns:
        This builder for chaining.

      • 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.

      • setPassword

        public Runnable.Container.Builder setPassword​(String value)
         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;
        Parameters:
        value - The password to set.
        Returns:
        This builder for chaining.

      • clearPassword

        public Runnable.Container.Builder clearPassword()
         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:
        This builder for chaining.

      • setPasswordBytes

        public Runnable.Container.Builder setPasswordBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for password to set.
        Returns:
        This builder for chaining.

      • 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.

      • setEnableImageStreaming

        public Runnable.Container.Builder setEnableImageStreaming​(boolean value)
         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];
        Parameters:
        value - The enableImageStreaming to set.
        Returns:
        This builder for chaining.

      • clearEnableImageStreaming

        public Runnable.Container.Builder clearEnableImageStreaming()
         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:
        This builder for chaining.

      • setUnknownFields

        public final Runnable.Container.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>

      • mergeUnknownFields

        public final Runnable.Container.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Runnable.Container.Builder>