blib/lib/Paws/Kendra/SortingConfiguration.pm untested

filter: Statementstmt 0.0% 0 / 5 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 6 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Kendra::SortingConfiguration;
3 use Moose;
4 has DocumentAttributeKey => (is => 'ro', isa => 'Str', required => 1);
5 has SortOrder => (is => 'ro', isa => 'Str', required => 1);
6  
7 1;
8  
9 ### main pod documentation begin ###
10  
11 =head1 NAME
12  
13 Paws::Kendra::SortingConfiguration
14  
15 =head1 USAGE
16  
17 This class represents one of two things:
18  
19 =head3 Arguments in a call to a service
20  
21 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22 Each attribute should be used as a named argument in the calls that expect this type of object.
23  
24 As an example, if Att1 is expected to be a Paws::Kendra::SortingConfiguration object:
25  
26 $service_obj->Method(Att1 => { DocumentAttributeKey => $value, ..., SortOrder => $value });
27  
28 =head3 Results returned from an API call
29  
30 Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::SortingConfiguration object:
31  
32 $result = $service_obj->Method(...);
33 $result->Att1->DocumentAttributeKey
34  
35 =head1 DESCRIPTION
36  
37 Specifies the document attribute to use to sort the response to a
38 Amazon Kendra query. You can specify a single attribute for sorting.
39 The attribute must have the C<Sortable> flag set to C<true>, otherwise
40 Amazon Kendra returns an exception.
41  
42 You can sort attributes of the following types.
43  
44 =over
45  
46 =item *
47  
48 Date value
49  
50 =item *
51  
52 Long value
53  
54 =item *
55  
56 String value
57  
58 =back
59  
60 You can't sort attributes of the following type.
61  
62 =over
63  
64 =item *
65  
66 String list value
67  
68 =back
69  
70  
71 =head1 ATTRIBUTES
72  
73  
74 =head2 B<REQUIRED> DocumentAttributeKey => Str
75  
76 The name of the document attribute used to sort the response. You can
77 use any field that has the C<Sortable> flag set to true.
78  
79 You can also sort by any of the following built-in attributes:
80  
81 =over
82  
83 =item *
84  
85 _category
86  
87 =item *
88  
89 _created_at
90  
91 =item *
92  
93 _last_updated_at
94  
95 =item *
96  
97 _version
98  
99 =item *
100  
101 _view_count
102  
103 =back
104  
105  
106  
107 =head2 B<REQUIRED> SortOrder => Str
108  
109 The order that the results should be returned in. In case of ties, the
110 relevance assigned to the result by Amazon Kendra is used as the
111 tie-breaker.
112  
113  
114  
115 =head1 SEE ALSO
116  
117 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
118  
119 =head1 BUGS and CONTRIBUTIONS
120  
121 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
122  
123 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
124  
125 =cut
126