blib/lib/Paws/CloudSearch/DefineIndexField.pm untested

filter: Statementstmt 0.0% 0 / 11 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 13 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CloudSearch::DefineIndexField;
3 use Moose;
4 has DomainName => (is => 'ro', isa => 'Str', required => 1);
5 has IndexField => (is => 'ro', isa => 'Paws::CloudSearch::IndexField', required => 1);
6  
7 use MooseX::ClassAttribute;
8  
9 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DefineIndexField');
10 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudSearch::DefineIndexFieldResponse');
11 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DefineIndexFieldResult');
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::CloudSearch::DefineIndexField - Arguments for method DefineIndexField on L<Paws::CloudSearch>
19  
20 =head1 DESCRIPTION
21  
22 This class represents the parameters used for calling the method DefineIndexField on the
23 L<Amazon CloudSearch|Paws::CloudSearch> service. Use the attributes of this class
24 as arguments to method DefineIndexField.
25  
26 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DefineIndexField.
27  
28 =head1 SYNOPSIS
29  
30 my $cloudsearch = Paws->service('CloudSearch');
31 my $DefineIndexFieldResponse = $cloudsearch->DefineIndexField(
32 DomainName => 'MyDomainName',
33 IndexField => {
34 IndexFieldName => 'MyDynamicFieldName', # min: 1, max: 64
35 IndexFieldType => 'int'
36 , # values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
37 DateArrayOptions => {
38 DefaultValue => 'MyFieldValue', # max: 1024; OPTIONAL
39 FacetEnabled => 1, # OPTIONAL
40 ReturnEnabled => 1, # OPTIONAL
41 SearchEnabled => 1, # OPTIONAL
42 SourceFields => 'MyFieldNameCommaList', # OPTIONAL
43 }, # OPTIONAL
44 DateOptions => {
45 DefaultValue => 'MyFieldValue', # max: 1024; OPTIONAL
46 FacetEnabled => 1, # OPTIONAL
47 ReturnEnabled => 1, # OPTIONAL
48 SearchEnabled => 1, # OPTIONAL
49 SortEnabled => 1, # OPTIONAL
50 SourceField => 'MyFieldName', # min: 1, max: 64; OPTIONAL
51 }, # OPTIONAL
52 DoubleArrayOptions => {
53 DefaultValue => 1, # OPTIONAL
54 FacetEnabled => 1, # OPTIONAL
55 ReturnEnabled => 1, # OPTIONAL
56 SearchEnabled => 1, # OPTIONAL
57 SourceFields => 'MyFieldNameCommaList', # OPTIONAL
58 }, # OPTIONAL
59 DoubleOptions => {
60 DefaultValue => 1, # OPTIONAL
61 FacetEnabled => 1, # OPTIONAL
62 ReturnEnabled => 1, # OPTIONAL
63 SearchEnabled => 1, # OPTIONAL
64 SortEnabled => 1, # OPTIONAL
65 SourceField => 'MyFieldName', # min: 1, max: 64; OPTIONAL
66 }, # OPTIONAL
67 IntArrayOptions => {
68 DefaultValue => 1, # OPTIONAL
69 FacetEnabled => 1, # OPTIONAL
70 ReturnEnabled => 1, # OPTIONAL
71 SearchEnabled => 1, # OPTIONAL
72 SourceFields => 'MyFieldNameCommaList', # OPTIONAL
73 }, # OPTIONAL
74 IntOptions => {
75 DefaultValue => 1, # OPTIONAL
76 FacetEnabled => 1, # OPTIONAL
77 ReturnEnabled => 1, # OPTIONAL
78 SearchEnabled => 1, # OPTIONAL
79 SortEnabled => 1, # OPTIONAL
80 SourceField => 'MyFieldName', # min: 1, max: 64; OPTIONAL
81 }, # OPTIONAL
82 LatLonOptions => {
83 DefaultValue => 'MyFieldValue', # max: 1024; OPTIONAL
84 FacetEnabled => 1, # OPTIONAL
85 ReturnEnabled => 1, # OPTIONAL
86 SearchEnabled => 1, # OPTIONAL
87 SortEnabled => 1, # OPTIONAL
88 SourceField => 'MyFieldName', # min: 1, max: 64; OPTIONAL
89 }, # OPTIONAL
90 LiteralArrayOptions => {
91 DefaultValue => 'MyFieldValue', # max: 1024; OPTIONAL
92 FacetEnabled => 1, # OPTIONAL
93 ReturnEnabled => 1, # OPTIONAL
94 SearchEnabled => 1, # OPTIONAL
95 SourceFields => 'MyFieldNameCommaList', # OPTIONAL
96 }, # OPTIONAL
97 LiteralOptions => {
98 DefaultValue => 'MyFieldValue', # max: 1024; OPTIONAL
99 FacetEnabled => 1, # OPTIONAL
100 ReturnEnabled => 1, # OPTIONAL
101 SearchEnabled => 1, # OPTIONAL
102 SortEnabled => 1, # OPTIONAL
103 SourceField => 'MyFieldName', # min: 1, max: 64; OPTIONAL
104 }, # OPTIONAL
105 TextArrayOptions => {
106 AnalysisScheme => 'MyWord', # OPTIONAL
107 DefaultValue => 'MyFieldValue', # max: 1024; OPTIONAL
108 HighlightEnabled => 1, # OPTIONAL
109 ReturnEnabled => 1, # OPTIONAL
110 SourceFields => 'MyFieldNameCommaList', # OPTIONAL
111 }, # OPTIONAL
112 TextOptions => {
113 AnalysisScheme => 'MyWord', # OPTIONAL
114 DefaultValue => 'MyFieldValue', # max: 1024; OPTIONAL
115 HighlightEnabled => 1, # OPTIONAL
116 ReturnEnabled => 1, # OPTIONAL
117 SortEnabled => 1, # OPTIONAL
118 SourceField => 'MyFieldName', # min: 1, max: 64; OPTIONAL
119 }, # OPTIONAL
120 },
121  
122 );
123  
124 # Results:
125 my $IndexField = $DefineIndexFieldResponse->IndexField;
126  
127 # Returns a L<Paws::CloudSearch::DefineIndexFieldResponse> object.
128  
129 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
130 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudsearch/DefineIndexField>
131  
132 =head1 ATTRIBUTES
133  
134  
135 =head2 B<REQUIRED> DomainName => Str
136  
137  
138  
139  
140  
141 =head2 B<REQUIRED> IndexField => L<Paws::CloudSearch::IndexField>
142  
143 The index field and field options you want to configure.
144  
145  
146  
147  
148 =head1 SEE ALSO
149  
150 This class forms part of L<Paws>, documenting arguments for method DefineIndexField in L<Paws::CloudSearch>
151  
152 =head1 BUGS and CONTRIBUTIONS
153  
154 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
155  
156 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
157  
158 =cut
159