File Coverage

blib/lib/Paws/CloudSearch/IndexField.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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