Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudSearchDomains.Types.FieldStats

Description

Synopsis

data FieldStats = FieldStats' {
- max :: Maybe Text
- mean :: Maybe Text
- count :: Maybe Integer
- missing :: Maybe Integer
- stddev :: Maybe Double
- min :: Maybe Text
- sumOfSquares :: Maybe Double
- sum :: Maybe Double
}
newFieldStats :: FieldStats
fieldStats_max :: Lens' FieldStats (Maybe Text)
fieldStats_mean :: Lens' FieldStats (Maybe Text)
fieldStats_count :: Lens' FieldStats (Maybe Integer)
fieldStats_missing :: Lens' FieldStats (Maybe Integer)
fieldStats_stddev :: Lens' FieldStats (Maybe Double)
fieldStats_min :: Lens' FieldStats (Maybe Text)
fieldStats_sumOfSquares :: Lens' FieldStats (Maybe Double)
fieldStats_sum :: Lens' FieldStats (Maybe Double)

Documentation

data FieldStats Source #

The statistics for a field calculated in the request.

See: newFieldStats smart constructor.

Constructors

FieldStats'

Fields

max :: Maybe Text
The maximum value found in the specified field in the result set.
If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
mean :: Maybe Text
The average of the values found in the specified field in the result set.
If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
count :: Maybe Integer
The number of documents that contain a value in the specified field in the result set.
missing :: Maybe Integer
The number of documents that do not contain a value in the specified field in the result set.
stddev :: Maybe Double
The standard deviation of the values in the specified field in the result set.
min :: Maybe Text
The minimum value found in the specified field in the result set.
If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
sumOfSquares :: Maybe Double
The sum of all field values in the result set squared.
sum :: Maybe Double
The sum of the field values across the documents in the result set. null for date fields.

Instances

Instances details

Eq FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods (==) :: FieldStats -> FieldStats -> Bool # (/=) :: FieldStats -> FieldStats -> Bool #
Read FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods readsPrec :: Int -> ReadS FieldStats # readList :: ReadS [FieldStats] # readPrec :: ReadPrec FieldStats # readListPrec :: ReadPrec [FieldStats] #
Show FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods showsPrec :: Int -> FieldStats -> ShowS # show :: FieldStats -> String # showList :: [FieldStats] -> ShowS #
Generic FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Associated Types type Rep FieldStats :: Type -> Type # Methods from :: FieldStats -> Rep FieldStats x # to :: Rep FieldStats x -> FieldStats #
NFData FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods rnf :: FieldStats -> () #
Hashable FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods hashWithSalt :: Int -> FieldStats -> Int # hash :: FieldStats -> Int #
FromJSON FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods parseJSON :: Value -> Parser FieldStats # parseJSONList :: Value -> Parser [FieldStats] #
type Rep FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats type Rep FieldStats = D1 ('MetaData "FieldStats" "Amazonka.CloudSearchDomains.Types.FieldStats" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "FieldStats'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "max") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mean") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "missing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "stddev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "min") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sumOfSquares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "sum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))

newFieldStats :: FieldStats Source #

Create a value of FieldStats with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:max:FieldStats', fieldStats_max - The maximum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

$sel:mean:FieldStats', fieldStats_mean - The average of the values found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

$sel:count:FieldStats', fieldStats_count - The number of documents that contain a value in the specified field in the result set.

$sel:missing:FieldStats', fieldStats_missing - The number of documents that do not contain a value in the specified field in the result set.

$sel:stddev:FieldStats', fieldStats_stddev - The standard deviation of the values in the specified field in the result set.

$sel:min:FieldStats', fieldStats_min - The minimum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

$sel:sumOfSquares:FieldStats', fieldStats_sumOfSquares - The sum of all field values in the result set squared.

$sel:sum:FieldStats', fieldStats_sum - The sum of the field values across the documents in the result set. null for date fields.

fieldStats_max :: Lens' FieldStats (Maybe Text) Source #

The maximum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

fieldStats_mean :: Lens' FieldStats (Maybe Text) Source #

The average of the values found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

fieldStats_count :: Lens' FieldStats (Maybe Integer) Source #

The number of documents that contain a value in the specified field in the result set.

fieldStats_missing :: Lens' FieldStats (Maybe Integer) Source #

The number of documents that do not contain a value in the specified field in the result set.

fieldStats_stddev :: Lens' FieldStats (Maybe Double) Source #

The standard deviation of the values in the specified field in the result set.

fieldStats_min :: Lens' FieldStats (Maybe Text) Source #

The minimum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

fieldStats_sumOfSquares :: Lens' FieldStats (Maybe Double) Source #

The sum of all field values in the result set squared.

fieldStats_sum :: Lens' FieldStats (Maybe Double) Source #

The sum of the field values across the documents in the result set. null for date fields.