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