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

Interface CSVInput.Builder

    • Method Detail

      • fileHeaderInfo

        CSVInput.Builder fileHeaderInfo​(String 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).

        Parameters:
        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).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FileHeaderInfo, FileHeaderInfo

      • fileHeaderInfo

        CSVInput.Builder fileHeaderInfo​(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).

        Parameters:
        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).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FileHeaderInfo, FileHeaderInfo

      • comments

        CSVInput.Builder comments​(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: #

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • quoteEscapeCharacter

        CSVInput.Builder quoteEscapeCharacter​(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 ".

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • recordDelimiter

        CSVInput.Builder recordDelimiter​(String recordDelimiter)

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

        Parameters:
        recordDelimiter - A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fieldDelimiter

        CSVInput.Builder fieldDelimiter​(String fieldDelimiter)

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

        Parameters:
        fieldDelimiter - A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • quoteCharacter

        CSVInput.Builder quoteCharacter​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • allowQuotedRecordDelimiter

        CSVInput.Builder allowQuotedRecordDelimiter​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.