File Coverage

blib/lib/Paws/CloudSearch/LiteralArrayOptions.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::LiteralArrayOptions;
2 1     1   436 use Moose;
  1         2  
  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 SourceFields => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::CloudSearch::LiteralArrayOptions
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::CloudSearch::LiteralArrayOptions object:
26              
27             $service_obj->Method(Att1 => { DefaultValue => $value, ..., SourceFields => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::LiteralArrayOptions object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->DefaultValue
35              
36             =head1 DESCRIPTION
37              
38             Options for a field that contains an array of literal strings. Present
39             if C<IndexFieldType> specifies the field is of type C<literal-array>.
40             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 SourceFields => Str
68              
69             A list of source fields to map to the field.
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84