File Coverage

blib/lib/Paws/CloudSearch/LiteralOptions.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::LiteralOptions;
2 1     1   634 use Moose;
  1         3  
  1         7  
3             has DefaultValue => (is => 'ro', isa => 'Str');
4             has FacetEnabled => (is => 'ro', isa => 'Bool');
5             has ReturnEnabled => (is => 'ro', isa => 'Bool');
6             has SearchEnabled => (is => 'ro', isa => 'Bool');
7             has SortEnabled => (is => 'ro', isa => 'Bool');
8             has SourceField => (is => 'ro', isa => 'Str');
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::CloudSearch::LiteralOptions
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::CloudSearch::LiteralOptions object:
27              
28             $service_obj->Method(Att1 => { DefaultValue => $value, ..., SourceField => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::LiteralOptions object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->DefaultValue
36              
37             =head1 DESCRIPTION
38              
39             Options for literal field. Present if C<IndexFieldType> specifies the
40             field is of type C<literal>. All options are enabled by default.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 DefaultValue => Str
46              
47             A value to use for the field if the field isn't specified for a
48             document.
49              
50              
51             =head2 FacetEnabled => Bool
52              
53             Whether facet information can be returned for the field.
54              
55              
56             =head2 ReturnEnabled => Bool
57              
58             Whether the contents of the field can be returned in the search
59             results.
60              
61              
62             =head2 SearchEnabled => Bool
63              
64             Whether the contents of the field are searchable.
65              
66              
67             =head2 SortEnabled => Bool
68              
69             Whether the field can be used to sort the search results.
70              
71              
72             =head2 SourceField => Str
73              
74            
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89