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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CSVOutput as input to an Aws::Client method, you can use a vanilla Hash:

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

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#field_delimiter ⇒ String

The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

Returns:

  • (String) —

    The value used to separate individual fields in a record.

#quote_character ⇒ String

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

Returns:

  • (String) —

    A single character used for escaping when the field delimiter is part of the value.

#quote_escape_character ⇒ String

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

Returns:

  • (String) —

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

#quote_fields ⇒ String

Indicates whether to use quotation marks around output fields.

  • ALWAYS: Always use quotation marks for output fields.

  • ASNEEDED: Use quotation marks for output fields when needed.

    Possible values:

    • ALWAYS
    • ASNEEDED

Returns:

  • (String) —

    Indicates whether to use quotation marks around output fields.

#record_delimiter ⇒ String

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

Returns:

  • (String) —

    A single character used to separate individual records in the output.