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",
  allow_quoted_record_delimiter: false,
}

Describes how a CSV-formatted input object is formatted.

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) 


656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-s3/types.rb', line 656

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

#comments ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-s3/types.rb', line 656

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_delimiter ⇒ String

The value used to separate individual fields in a record.

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-s3/types.rb', line 656

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_info ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-s3/types.rb', line 656

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_character ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-s3/types.rb', line 656

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_character ⇒ String

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

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-s3/types.rb', line 656

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_delimiter ⇒ String

The value used to separate individual records.

Returns:

  • (String) 


656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-s3/types.rb', line 656

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