Package software.amazon.awssdk.services.s3.model

Class CSVInput

    • Method Detail

      • fileHeaderInfo

        public final FileHeaderInfo fileHeaderInfo()

        Describes the first line of input. Valid values are:

        • NONE: First line is not a header.

        • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

        • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

        If the service returns an enum value that is not available in the current SDK version, fileHeaderInfo will return FileHeaderInfo.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileHeaderInfoAsString().

        Returns:
        Describes the first line of input. Valid values are:

        • NONE: First line is not a header.

        • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

        • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

        See Also:
        FileHeaderInfo

      • fileHeaderInfoAsString

        public final String fileHeaderInfoAsString()

        Describes the first line of input. Valid values are:

        • NONE: First line is not a header.

        • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

        • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

        If the service returns an enum value that is not available in the current SDK version, fileHeaderInfo will return FileHeaderInfo.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileHeaderInfoAsString().

        Returns:
        Describes the first line of input. Valid values are:

        • NONE: First line is not a header.

        • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

        • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

        See Also:
        FileHeaderInfo

      • comments

        public final String comments()

        A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

        Default: #

        Returns:
        A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

        Default: #

      • quoteEscapeCharacter

        public final String quoteEscapeCharacter()

        A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

        Returns:
        A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

      • recordDelimiter

        public final String recordDelimiter()

        A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

        Returns:
        A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

      • fieldDelimiter

        public final String fieldDelimiter()

        A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

        Returns:
        A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

      • quoteCharacter

        public final String quoteCharacter()

        A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

        Type: String

        Default: "

        Ancestors: CSV

        Returns:
        A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

        Type: String

        Default: "

        Ancestors: CSV

      • allowQuotedRecordDelimiter

        public final Boolean allowQuotedRecordDelimiter()

        Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

        Returns:
        Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)