Package flyteidl.core

Interface Tasks.DataLoadingConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Tasks.DataLoadingConfig, Tasks.DataLoadingConfig.Builder
    Enclosing class:
    Tasks
    public static interface Tasks.DataLoadingConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getEnabled()
      Flag enables DataLoading Config.
      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.
      int getFormatValue()
      In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values.
      String getInputPath()
      File system path (start at root).
      com.google.protobuf.ByteString getInputPathBytes()
      File system path (start at root).
      Tasks.IOStrategy getIoStrategy()
      .flyteidl.core.IOStrategy io_strategy = 5;
      Tasks.IOStrategyOrBuilder getIoStrategyOrBuilder()
      .flyteidl.core.IOStrategy io_strategy = 5;
      String getOutputPath()
      File system path (start at root).
      com.google.protobuf.ByteString getOutputPathBytes()
      File system path (start at root).
      boolean hasIoStrategy()
      .flyteidl.core.IOStrategy io_strategy = 5;

      • 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

      • getEnabled

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

      • getInputPath

        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;
        Returns:
        The inputPath.

      • getInputPathBytes

        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;
        Returns:
        The bytes for inputPath.

      • getOutputPath

        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;
        Returns:
        The outputPath.

      • getOutputPathBytes

        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;
        Returns:
        The bytes for outputPath.

      • getFormatValue

        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;
        Returns:
        The enum numeric value on the wire for format.

      • getFormat

        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;
        Returns:
        The format.

      • hasIoStrategy

        boolean hasIoStrategy()
        .flyteidl.core.IOStrategy io_strategy = 5;
        Returns:
        Whether the ioStrategy field is set.

      • getIoStrategy

        Tasks.IOStrategy getIoStrategy()
        .flyteidl.core.IOStrategy io_strategy = 5;
        Returns:
        The ioStrategy.