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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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",
}

Describes how a CSV-formatted input object is formatted.

Instance Attribute Summary collapse

Instance Attribute Details

#commentsString

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

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
# File 'lib/aws-sdk-s3/types.rb', line 583

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

#field_delimiterString

Value used to separate individual fields in a record.

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
# File 'lib/aws-sdk-s3/types.rb', line 583

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

#file_header_infoString

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

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
# File 'lib/aws-sdk-s3/types.rb', line 583

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

#quote_characterString

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

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
# File 'lib/aws-sdk-s3/types.rb', line 583

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

#quote_escape_characterString

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

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
# File 'lib/aws-sdk-s3/types.rb', line 583

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

#record_delimiterString

Value used to separate individual records.

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
# File 'lib/aws-sdk-s3/types.rb', line 583

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