File Coverage

blib/lib/Paws/CloudSearchDomain/FieldStats.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::CloudSearchDomain::FieldStats;
2 1     1   452 use Moose;
  1         2  
  1         7  
3             has Count => (is => 'ro', isa => 'Int', request_name => 'count', traits => ['NameInRequest']);
4             has Max => (is => 'ro', isa => 'Str', request_name => 'max', traits => ['NameInRequest']);
5             has Mean => (is => 'ro', isa => 'Str', request_name => 'mean', traits => ['NameInRequest']);
6             has Min => (is => 'ro', isa => 'Str', request_name => 'min', traits => ['NameInRequest']);
7             has Missing => (is => 'ro', isa => 'Int', request_name => 'missing', traits => ['NameInRequest']);
8             has Stddev => (is => 'ro', isa => 'Num', request_name => 'stddev', traits => ['NameInRequest']);
9             has Sum => (is => 'ro', isa => 'Num', request_name => 'sum', traits => ['NameInRequest']);
10             has SumOfSquares => (is => 'ro', isa => 'Num', request_name => 'sumOfSquares', traits => ['NameInRequest']);
11             1;
12              
13             ### main pod documentation begin ###
14              
15             =head1 NAME
16              
17             Paws::CloudSearchDomain::FieldStats
18              
19             =head1 USAGE
20              
21             This class represents one of two things:
22              
23             =head3 Arguments in a call to a service
24              
25             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26             Each attribute should be used as a named argument in the calls that expect this type of object.
27              
28             As an example, if Att1 is expected to be a Paws::CloudSearchDomain::FieldStats object:
29              
30             $service_obj->Method(Att1 => { Count => $value, ..., SumOfSquares => $value });
31              
32             =head3 Results returned from an API call
33              
34             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearchDomain::FieldStats object:
35              
36             $result = $service_obj->Method(...);
37             $result->Att1->Count
38              
39             =head1 DESCRIPTION
40              
41             The statistics for a field calculated in the request.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 Count => Int
47              
48             The number of documents that contain a value in the specified field in
49             the result set.
50              
51              
52             =head2 Max => Str
53              
54             The maximum value found in the specified field in the result set.
55              
56             If the field is numeric (C<int>, C<int-array>, C<double>, or
57             C<double-array>), C<max> is the string representation of a
58             double-precision 64-bit floating point value. If the field is C<date>
59             or C<date-array>, C<max> is the string representation of a date with
60             the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
61              
62              
63             =head2 Mean => Str
64              
65             The average of the values found in the specified field in the result
66             set.
67              
68             If the field is numeric (C<int>, C<int-array>, C<double>, or
69             C<double-array>), C<mean> is the string representation of a
70             double-precision 64-bit floating point value. If the field is C<date>
71             or C<date-array>, C<mean> is the string representation of a date with
72             the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
73              
74              
75             =head2 Min => Str
76              
77             The minimum value found in the specified field in the result set.
78              
79             If the field is numeric (C<int>, C<int-array>, C<double>, or
80             C<double-array>), C<min> is the string representation of a
81             double-precision 64-bit floating point value. If the field is C<date>
82             or C<date-array>, C<min> is the string representation of a date with
83             the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
84              
85              
86             =head2 Missing => Int
87              
88             The number of documents that do not contain a value in the specified
89             field in the result set.
90              
91              
92             =head2 Stddev => Num
93              
94             The standard deviation of the values in the specified field in the
95             result set.
96              
97              
98             =head2 Sum => Num
99              
100             The sum of the field values across the documents in the result set.
101             C<null> for date fields.
102              
103              
104             =head2 SumOfSquares => Num
105              
106             The sum of all field values in the result set squared.
107              
108              
109              
110             =head1 SEE ALSO
111              
112             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearchDomain>
113              
114             =head1 BUGS and CONTRIBUTIONS
115              
116             The source code is located here: https://github.com/pplu/aws-sdk-perl
117              
118             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
119              
120             =cut
121