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 an uncompressed comma-separated values (CSV)-formatted input object is formatted.

Constant Summary collapse

SENSITIVE =
[]

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)


754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 754

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

#commentsString

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)


754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 754

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

#field_delimiterString

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

Returns:

  • (String)


754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 754

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

#file_header_infoString

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

Returns:

  • (String)


754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 754

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

#quote_characterString

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)


754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 754

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

#quote_escape_characterString

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)


754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 754

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

#record_delimiterString

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

Returns:

  • (String)


754
755
756
757
758
759
760
761
762
763
764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 754

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