| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::CSVOutput; | ||
| 3 | use Moose; | ||
| 4 | has FieldDelimiter => (is => 'ro', isa => 'Str'); | ||
| 5 | has QuoteCharacter => (is => 'ro', isa => 'Str'); | ||
| 6 | has QuoteEscapeCharacter => (is => 'ro', isa => 'Str'); | ||
| 7 | has QuoteFields => (is => 'ro', isa => 'Str'); | ||
| 8 | has RecordDelimiter => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::S3::CSVOutput | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::S3::CSVOutput object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { FieldDelimiter => $value, ..., RecordDelimiter => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3::CSVOutput object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->FieldDelimiter | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Describes how uncompressed comma-separated values (CSV)-formatted | ||
| 41 | results are formatted. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 FieldDelimiter => Str | ||
| 47 | |||
| 48 | The value used to separate individual fields in a record. You can | ||
| 49 | specify an arbitrary delimiter. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 QuoteCharacter => Str | ||
| 53 | |||
| 54 | A single character used for escaping when the field delimiter is part | ||
| 55 | of the value. For example, if the value is C<a, b>, Amazon S3 wraps | ||
| 56 | this field value in quotation marks, as follows: C<" a , b ">. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 QuoteEscapeCharacter => Str | ||
| 60 | |||
| 61 | The single character used for escaping the quote character inside an | ||
| 62 | already escaped value. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 QuoteFields => Str | ||
| 66 | |||
| 67 | Indicates whether to use quotation marks around output fields. | ||
| 68 | |||
| 69 | =over | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<ALWAYS>: Always use quotation marks for output fields. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<ASNEEDED>: Use quotation marks for output fields when needed. | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 RecordDelimiter => Str | ||
| 84 | |||
| 85 | A single character used to separate individual records in the output. | ||
| 86 | Instead of the default value, you can specify an arbitrary delimiter. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |