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 a CSV-formatted input object is formatted.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#allow_quoted_record_delimiterBoolean

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.

#commentsString

Single character used to indicate a row should be ignored when present at the start of a row.

Returns:

  • (String)

    Single character used to indicate a row should be ignored when present at the start of a row.

#field_delimiterString

Value used to separate individual fields in a record.

Returns:

  • (String)

    Value used to separate individual fields in a record.

#file_header_infoString

Describes the first line of input. Valid values: None, Ignore, Use.

Possible values:

  • USE
  • IGNORE
  • NONE

Returns:

  • (String)

    Describes the first line of input.

#quote_characterString

Value used for escaping where the field delimiter is part of the value.

Returns:

  • (String)

    Value used for escaping where the field delimiter is part of the value.

#quote_escape_characterString

Single character used for escaping the quote character inside an already escaped value.

Returns:

  • (String)

    Single character used for escaping the quote character inside an already escaped value.

#record_delimiterString

Value used to separate individual records.

Returns:

  • (String)

    Value used to separate individual records.