« blib/lib/Paws/CloudSearch/IndexDocumentsResponse.pm
↑ Summary
blib/lib/Paws/CloudSearch/IndexFieldStatus.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudSearch::IndexField; | ||
| 3 | use Moose; | ||
| 4 | has DateArrayOptions => (is => 'ro', isa => 'Paws::CloudSearch::DateArrayOptions'); | ||
| 5 | has DateOptions => (is => 'ro', isa => 'Paws::CloudSearch::DateOptions'); | ||
| 6 | has DoubleArrayOptions => (is => 'ro', isa => 'Paws::CloudSearch::DoubleArrayOptions'); | ||
| 7 | has DoubleOptions => (is => 'ro', isa => 'Paws::CloudSearch::DoubleOptions'); | ||
| 8 | has IndexFieldName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has IndexFieldType => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has IntArrayOptions => (is => 'ro', isa => 'Paws::CloudSearch::IntArrayOptions'); | ||
| 11 | has IntOptions => (is => 'ro', isa => 'Paws::CloudSearch::IntOptions'); | ||
| 12 | has LatLonOptions => (is => 'ro', isa => 'Paws::CloudSearch::LatLonOptions'); | ||
| 13 | has LiteralArrayOptions => (is => 'ro', isa => 'Paws::CloudSearch::LiteralArrayOptions'); | ||
| 14 | has LiteralOptions => (is => 'ro', isa => 'Paws::CloudSearch::LiteralOptions'); | ||
| 15 | has TextArrayOptions => (is => 'ro', isa => 'Paws::CloudSearch::TextArrayOptions'); | ||
| 16 | has TextOptions => (is => 'ro', isa => 'Paws::CloudSearch::TextOptions'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::CloudSearch::IndexField | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::CloudSearch::IndexField object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { DateArrayOptions => $value, ..., TextOptions => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::IndexField object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->DateArrayOptions | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Configuration information for a field in the index, including its name, | ||
| 49 | type, and options. The supported options depend on the | ||
| 50 | C<IndexFieldType>. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 DateArrayOptions => L<Paws::CloudSearch::DateArrayOptions> | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 DateOptions => L<Paws::CloudSearch::DateOptions> | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 DoubleArrayOptions => L<Paws::CloudSearch::DoubleArrayOptions> | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 DoubleOptions => L<Paws::CloudSearch::DoubleOptions> | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> IndexFieldName => Str | ||
| 76 | |||
| 77 | A string that represents the name of an index field. CloudSearch | ||
| 78 | supports regular index fields as well as dynamic fields. A dynamic | ||
| 79 | field's name defines a pattern that begins or ends with a wildcard. Any | ||
| 80 | document fields that don't map to a regular index field but do match a | ||
| 81 | dynamic field's pattern are configured with the dynamic field's | ||
| 82 | indexing options. | ||
| 83 | |||
| 84 | Regular field names begin with a letter and can contain the following | ||
| 85 | characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field | ||
| 86 | names must begin or end with a wildcard (*). The wildcard can also be | ||
| 87 | the only character in a dynamic field name. Multiple wildcards, and | ||
| 88 | wildcards embedded within a string are not supported. | ||
| 89 | |||
| 90 | The name C<score> is reserved and cannot be used as a field name. To | ||
| 91 | reference a document's ID, you can use the name C<_id>. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> IndexFieldType => Str | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 IntArrayOptions => L<Paws::CloudSearch::IntArrayOptions> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 IntOptions => L<Paws::CloudSearch::IntOptions> | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 LatLonOptions => L<Paws::CloudSearch::LatLonOptions> | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 LiteralArrayOptions => L<Paws::CloudSearch::LiteralArrayOptions> | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 LiteralOptions => L<Paws::CloudSearch::LiteralOptions> | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 TextArrayOptions => L<Paws::CloudSearch::TextArrayOptions> | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 TextOptions => L<Paws::CloudSearch::TextOptions> | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |