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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass CSVInput data as a 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.

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)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 590

class CSVInput < Struct.new(
  :file_header_info,
  :comments,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character,
  :allow_quoted_record_delimiter)
  include Aws::Structure
end

#commentsString

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

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 590

class CSVInput < Struct.new(
  :file_header_info,
  :comments,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character,
  :allow_quoted_record_delimiter)
  include Aws::Structure
end

#field_delimiterString

Value used to separate individual fields in a record.

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 590

class CSVInput < Struct.new(
  :file_header_info,
  :comments,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character,
  :allow_quoted_record_delimiter)
  include Aws::Structure
end

#file_header_infoString

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

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 590

class CSVInput < Struct.new(
  :file_header_info,
  :comments,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character,
  :allow_quoted_record_delimiter)
  include Aws::Structure
end

#quote_characterString

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

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 590

class CSVInput < Struct.new(
  :file_header_info,
  :comments,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character,
  :allow_quoted_record_delimiter)
  include Aws::Structure
end

#quote_escape_characterString

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

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 590

class CSVInput < Struct.new(
  :file_header_info,
  :comments,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character,
  :allow_quoted_record_delimiter)
  include Aws::Structure
end

#record_delimiterString

Value used to separate individual records.

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 590

class CSVInput < Struct.new(
  :file_header_info,
  :comments,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character,
  :allow_quoted_record_delimiter)
  include Aws::Structure
end