Package flyteidl.core

Class Tasks.DataLoadingConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Tasks.DataLoadingConfigOrBuilder, Cloneable
    Enclosing class:
    Tasks.DataLoadingConfig
    public static final class Tasks.DataLoadingConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Tasks.DataLoadingConfig.Builder>
implements Tasks.DataLoadingConfigOrBuilder
     This configuration allows executing raw containers in Flyte using the Flyte CoPilot system.
 Flyte CoPilot, eliminates the needs of flytekit or sdk inside the container. Any inputs required by the users container are side-loaded in the input_path
 Any outputs generated by the user container - within output_path are automatically uploaded.
    Protobuf type flyteidl.core.DataLoadingConfig

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

    • 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<Tasks.DataLoadingConfig.Builder>

      • clear

        public Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>

      • getDefaultInstanceForType

        public Tasks.DataLoadingConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>

      • clearField

        public Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>

      • clearOneof

        public Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>

      • setRepeatedField

        public Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>

      • addRepeatedField

        public Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>

      • isInitialized

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

      • mergeFrom

        public Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>
        Throws:
        IOException

      • getEnabled

        public boolean getEnabled()
         Flag enables DataLoading Config. If this is not set, data loading will not be used!
        bool enabled = 1;
        Specified by:
        getEnabled in interface Tasks.DataLoadingConfigOrBuilder
        Returns:
        The enabled.

      • setEnabled

        public Tasks.DataLoadingConfig.Builder setEnabled​(boolean value)
         Flag enables DataLoading Config. If this is not set, data loading will not be used!
        bool enabled = 1;
        Parameters:
        value - The enabled to set.
        Returns:
        This builder for chaining.

      • clearEnabled

        public Tasks.DataLoadingConfig.Builder clearEnabled()
         Flag enables DataLoading Config. If this is not set, data loading will not be used!
        bool enabled = 1;
        Returns:
        This builder for chaining.

      • getInputPath

        public String getInputPath()
         File system path (start at root). This folder will contain all the inputs exploded to a separate file.
 Example, if the input interface needs (x: int, y: blob, z: multipart_blob) and the input path is '/var/flyte/inputs', then the file system will look like
 /var/flyte/inputs/inputs.<metadata format dependent -> .pb .json .yaml> -> Format as defined previously. The Blob and Multipart blob will reference local filesystem instead of remote locations
 /var/flyte/inputs/x -> X is a file that contains the value of x (integer) in string format
 /var/flyte/inputs/y -> Y is a file in Binary format
 /var/flyte/inputs/z/... -> Note Z itself is a directory
 More information about the protocol - refer to docs #TODO reference docs here
        string input_path = 2;
        Specified by:
        getInputPath in interface Tasks.DataLoadingConfigOrBuilder
        Returns:
        The inputPath.

      • getInputPathBytes

        public com.google.protobuf.ByteString getInputPathBytes()
         File system path (start at root). This folder will contain all the inputs exploded to a separate file.
 Example, if the input interface needs (x: int, y: blob, z: multipart_blob) and the input path is '/var/flyte/inputs', then the file system will look like
 /var/flyte/inputs/inputs.<metadata format dependent -> .pb .json .yaml> -> Format as defined previously. The Blob and Multipart blob will reference local filesystem instead of remote locations
 /var/flyte/inputs/x -> X is a file that contains the value of x (integer) in string format
 /var/flyte/inputs/y -> Y is a file in Binary format
 /var/flyte/inputs/z/... -> Note Z itself is a directory
 More information about the protocol - refer to docs #TODO reference docs here
        string input_path = 2;
        Specified by:
        getInputPathBytes in interface Tasks.DataLoadingConfigOrBuilder
        Returns:
        The bytes for inputPath.

      • setInputPath

        public Tasks.DataLoadingConfig.Builder setInputPath​(String value)
         File system path (start at root). This folder will contain all the inputs exploded to a separate file.
 Example, if the input interface needs (x: int, y: blob, z: multipart_blob) and the input path is '/var/flyte/inputs', then the file system will look like
 /var/flyte/inputs/inputs.<metadata format dependent -> .pb .json .yaml> -> Format as defined previously. The Blob and Multipart blob will reference local filesystem instead of remote locations
 /var/flyte/inputs/x -> X is a file that contains the value of x (integer) in string format
 /var/flyte/inputs/y -> Y is a file in Binary format
 /var/flyte/inputs/z/... -> Note Z itself is a directory
 More information about the protocol - refer to docs #TODO reference docs here
        string input_path = 2;
        Parameters:
        value - The inputPath to set.
        Returns:
        This builder for chaining.

      • clearInputPath

        public Tasks.DataLoadingConfig.Builder clearInputPath()
         File system path (start at root). This folder will contain all the inputs exploded to a separate file.
 Example, if the input interface needs (x: int, y: blob, z: multipart_blob) and the input path is '/var/flyte/inputs', then the file system will look like
 /var/flyte/inputs/inputs.<metadata format dependent -> .pb .json .yaml> -> Format as defined previously. The Blob and Multipart blob will reference local filesystem instead of remote locations
 /var/flyte/inputs/x -> X is a file that contains the value of x (integer) in string format
 /var/flyte/inputs/y -> Y is a file in Binary format
 /var/flyte/inputs/z/... -> Note Z itself is a directory
 More information about the protocol - refer to docs #TODO reference docs here
        string input_path = 2;
        Returns:
        This builder for chaining.

      • setInputPathBytes

        public Tasks.DataLoadingConfig.Builder setInputPathBytes​(com.google.protobuf.ByteString value)
         File system path (start at root). This folder will contain all the inputs exploded to a separate file.
 Example, if the input interface needs (x: int, y: blob, z: multipart_blob) and the input path is '/var/flyte/inputs', then the file system will look like
 /var/flyte/inputs/inputs.<metadata format dependent -> .pb .json .yaml> -> Format as defined previously. The Blob and Multipart blob will reference local filesystem instead of remote locations
 /var/flyte/inputs/x -> X is a file that contains the value of x (integer) in string format
 /var/flyte/inputs/y -> Y is a file in Binary format
 /var/flyte/inputs/z/... -> Note Z itself is a directory
 More information about the protocol - refer to docs #TODO reference docs here
        string input_path = 2;
        Parameters:
        value - The bytes for inputPath to set.
        Returns:
        This builder for chaining.

      • getOutputPath

        public String getOutputPath()
         File system path (start at root). This folder should contain all the outputs for the task as individual files and/or an error text file
        string output_path = 3;
        Specified by:
        getOutputPath in interface Tasks.DataLoadingConfigOrBuilder
        Returns:
        The outputPath.

      • getOutputPathBytes

        public com.google.protobuf.ByteString getOutputPathBytes()
         File system path (start at root). This folder should contain all the outputs for the task as individual files and/or an error text file
        string output_path = 3;
        Specified by:
        getOutputPathBytes in interface Tasks.DataLoadingConfigOrBuilder
        Returns:
        The bytes for outputPath.

      • setOutputPath

        public Tasks.DataLoadingConfig.Builder setOutputPath​(String value)
         File system path (start at root). This folder should contain all the outputs for the task as individual files and/or an error text file
        string output_path = 3;
        Parameters:
        value - The outputPath to set.
        Returns:
        This builder for chaining.

      • clearOutputPath

        public Tasks.DataLoadingConfig.Builder clearOutputPath()
         File system path (start at root). This folder should contain all the outputs for the task as individual files and/or an error text file
        string output_path = 3;
        Returns:
        This builder for chaining.

      • setOutputPathBytes

        public Tasks.DataLoadingConfig.Builder setOutputPathBytes​(com.google.protobuf.ByteString value)
         File system path (start at root). This folder should contain all the outputs for the task as individual files and/or an error text file
        string output_path = 3;
        Parameters:
        value - The bytes for outputPath to set.
        Returns:
        This builder for chaining.

      • getFormatValue

        public int getFormatValue()
         In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values.
 This format decides the actual encoding for the data. Refer to the encoding to understand the specifics of the contents and the encoding
        .flyteidl.core.DataLoadingConfig.LiteralMapFormat format = 4;
        Specified by:
        getFormatValue in interface Tasks.DataLoadingConfigOrBuilder
        Returns:
        The enum numeric value on the wire for format.

      • setFormatValue

        public Tasks.DataLoadingConfig.Builder setFormatValue​(int value)
         In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values.
 This format decides the actual encoding for the data. Refer to the encoding to understand the specifics of the contents and the encoding
        .flyteidl.core.DataLoadingConfig.LiteralMapFormat format = 4;
        Parameters:
        value - The enum numeric value on the wire for format to set.
        Returns:
        This builder for chaining.

      • getFormat

        public Tasks.DataLoadingConfig.LiteralMapFormat getFormat()
         In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values.
 This format decides the actual encoding for the data. Refer to the encoding to understand the specifics of the contents and the encoding
        .flyteidl.core.DataLoadingConfig.LiteralMapFormat format = 4;
        Specified by:
        getFormat in interface Tasks.DataLoadingConfigOrBuilder
        Returns:
        The format.

      • setFormat

        public Tasks.DataLoadingConfig.Builder setFormat​(Tasks.DataLoadingConfig.LiteralMapFormat value)
         In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values.
 This format decides the actual encoding for the data. Refer to the encoding to understand the specifics of the contents and the encoding
        .flyteidl.core.DataLoadingConfig.LiteralMapFormat format = 4;
        Parameters:
        value - The format to set.
        Returns:
        This builder for chaining.

      • clearFormat

        public Tasks.DataLoadingConfig.Builder clearFormat()
         In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values.
 This format decides the actual encoding for the data. Refer to the encoding to understand the specifics of the contents and the encoding
        .flyteidl.core.DataLoadingConfig.LiteralMapFormat format = 4;
        Returns:
        This builder for chaining.

      • getIoStrategyBuilder

        public Tasks.IOStrategy.Builder getIoStrategyBuilder()
        .flyteidl.core.IOStrategy io_strategy = 5;

      • setUnknownFields

        public final Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>

      • mergeUnknownFields

        public final Tasks.DataLoadingConfig.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<Tasks.DataLoadingConfig.Builder>