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

Class: Aws::S3::Types::CSVOutput

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 CSVOutput data as a hash:

{
  quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
  quote_escape_character: "QuoteEscapeCharacter",
  record_delimiter: "RecordDelimiter",
  field_delimiter: "FieldDelimiter",
  quote_character: "QuoteCharacter",
}

Describes how CSV-formatted results are formatted.

Instance Attribute Summary collapse

Instance Attribute Details

#field_delimiterString

Value used to separate individual fields in a record.

Returns:

  • (String)


638
639
640
641
642
643
644
645
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 638

class CSVOutput < Struct.new(
  :quote_fields,
  :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)


638
639
640
641
642
643
644
645
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 638

class CSVOutput < Struct.new(
  :quote_fields,
  :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)


638
639
640
641
642
643
644
645
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 638

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  include Aws::Structure
end

#quote_fieldsString

Indicates whether or not all output fields should be quoted.

Returns:

  • (String)


638
639
640
641
642
643
644
645
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 638

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  include Aws::Structure
end

#record_delimiterString

Value used to separate individual records.

Returns:

  • (String)


638
639
640
641
642
643
644
645
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 638

class CSVOutput < Struct.new(
  :quote_fields,
  :quote_escape_character,
  :record_delimiter,
  :field_delimiter,
  :quote_character)
  include Aws::Structure
end