| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::CSVInput; | ||
| 3 | use Moose; | ||
| 4 | has AllowQuotedRecordDelimiter => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Comments => (is => 'ro', isa => 'Str'); | ||
| 6 | has FieldDelimiter => (is => 'ro', isa => 'Str'); | ||
| 7 | has FileHeaderInfo => (is => 'ro', isa => 'Str'); | ||
| 8 | has QuoteCharacter => (is => 'ro', isa => 'Str'); | ||
| 9 | has QuoteEscapeCharacter => (is => 'ro', isa => 'Str'); | ||
| 10 | has RecordDelimiter => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::S3::CSVInput | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::S3::CSVInput object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { AllowQuotedRecordDelimiter => $value, ..., RecordDelimiter => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3::CSVInput object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->AllowQuotedRecordDelimiter | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Describes how an uncompressed comma-separated values (CSV)-formatted | ||
| 43 | input object is formatted. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AllowQuotedRecordDelimiter => Bool | ||
| 49 | |||
| 50 | Specifies that CSV field values may contain quoted record delimiters | ||
| 51 | and such records should be allowed. Default value is FALSE. Setting | ||
| 52 | this value to TRUE may lower performance. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Comments => Str | ||
| 56 | |||
| 57 | A single character used to indicate that a row should be ignored when | ||
| 58 | the character is present at the start of that row. You can specify any | ||
| 59 | character to indicate a comment line. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 FieldDelimiter => Str | ||
| 63 | |||
| 64 | A single character used to separate individual fields in a record. You | ||
| 65 | can specify an arbitrary delimiter. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 FileHeaderInfo => Str | ||
| 69 | |||
| 70 | Describes the first line of input. Valid values are: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<NONE>: First line is not a header. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<IGNORE>: First line is a header, but you can't use the header values | ||
| 81 | to indicate the column in an expression. You can use column position | ||
| 82 | (such as _1, _2, E<hellip>) to indicate the column (C<SELECT s._1 FROM | ||
| 83 | OBJECT s>). | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<Use>: First line is a header, and you can use the header value to | ||
| 88 | identify a column in an expression (C<SELECT "name" FROM OBJECT>). | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 QuoteCharacter => Str | ||
| 95 | |||
| 96 | A single character used for escaping when the field delimiter is part | ||
| 97 | of the value. For example, if the value is C<a, b>, Amazon S3 wraps | ||
| 98 | this field value in quotation marks, as follows: C<" a , b ">. | ||
| 99 | |||
| 100 | Type: String | ||
| 101 | |||
| 102 | Default: C<"> | ||
| 103 | |||
| 104 | Ancestors: C<CSV> | ||
| 105 | |||
| 106 | |||
| 107 | =head2 QuoteEscapeCharacter => Str | ||
| 108 | |||
| 109 | A single character used for escaping the quotation mark character | ||
| 110 | inside an already escaped value. For example, the value """ a , b """ | ||
| 111 | is parsed as " a , b ". | ||
| 112 | |||
| 113 | |||
| 114 | =head2 RecordDelimiter => Str | ||
| 115 | |||
| 116 | A single character used to separate individual records in the input. | ||
| 117 | Instead of the default value, you can specify an arbitrary delimiter. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |