You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::CSVInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CSVInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  file_header_info: "USE", # accepts USE, IGNORE, NONE
  comments: "Comments",
  quote_escape_character: "QuoteEscapeCharacter",
  record_delimiter: "RecordDelimiter",
  field_delimiter: "FieldDelimiter",
  quote_character: "QuoteCharacter",
  allow_quoted_record_delimiter: false,
}

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allow_quoted_record_delimiter ⇒ Boolean

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:

  • (Boolean) —

    Specifies that CSV field values may contain quoted record delimiters and such records should be allowed.

#comments ⇒ String

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.

Returns:

  • (String) —

    A single character used to indicate that a row should be ignored when the character is present at the start of that row.

#field_delimiter ⇒ String

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

Returns:

  • (String) —

    A single character used to separate individual fields in a record.

#file_header_info ⇒ String

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

    Possible values:

    • USE
    • IGNORE
    • NONE

Returns:

  • (String) —

    Describes the first line of input.

#quote_character ⇒ String

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:

  • (String) —

    A single character used for escaping when the field delimiter is part of the value.

#quote_escape_character ⇒ String

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:

  • (String) —

    A single character used for escaping the quotation mark character inside an already escaped value.

#record_delimiter ⇒ String

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

Returns:

  • (String) —

    A single character used to separate individual records in the input.