File Coverage

blib/lib/Paws/CloudSearch/DocumentSuggesterOptions.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::DocumentSuggesterOptions;
2 1     1   279 use Moose;
  1         3  
  1         5  
3             has FuzzyMatching => (is => 'ro', isa => 'Str');
4             has SortExpression => (is => 'ro', isa => 'Str');
5             has SourceField => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::CloudSearch::DocumentSuggesterOptions
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::CloudSearch::DocumentSuggesterOptions object:
24              
25             $service_obj->Method(Att1 => { FuzzyMatching => $value, ..., SourceField => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::DocumentSuggesterOptions object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->FuzzyMatching
33              
34             =head1 DESCRIPTION
35              
36             Options for a search suggester.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 FuzzyMatching => Str
42              
43             The level of fuzziness allowed when suggesting matches for a string:
44             C<none>, C<low>, or C<high>. With none, the specified string is treated
45             as an exact prefix. With low, suggestions must differ from the
46             specified string by no more than one character. With high, suggestions
47             can differ by up to two characters. The default is none.
48              
49              
50             =head2 SortExpression => Str
51              
52             An expression that computes a score for each suggestion to control how
53             they are sorted. The scores are rounded to the nearest integer, with a
54             floor of 0 and a ceiling of 2^31-1. A document's relevance score is not
55             computed for suggestions, so sort expressions cannot reference the
56             C<_score> value. To sort suggestions using a numeric field or existing
57             expression, simply specify the name of the field or expression. If no
58             expression is configured for the suggester, the suggestions are sorted
59             with the closest matches listed first.
60              
61              
62             =head2 B<REQUIRED> SourceField => Str
63              
64             The name of the index field you want to use for suggestions.
65              
66              
67              
68             =head1 SEE ALSO
69              
70             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch>
71              
72             =head1 BUGS and CONTRIBUTIONS
73              
74             The source code is located here: https://github.com/pplu/aws-sdk-perl
75              
76             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
77              
78             =cut
79