Amazonka.CloudSearchDomains.Types.FieldStats

Documentation

data FieldStats

The statistics for a field calculated in the request.

See: newFieldStats smart constructor.

Constructors

FieldStats'

Fields

• count :: Maybe Integer

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

• 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.

• 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.

• 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.

• sum :: Maybe Double

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

• sumOfSquares :: Maybe Double

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

Instances

FromJSON FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Methods

parseJSON :: Value -> Parser FieldStats

parseJSONList :: Value -> Parser [FieldStats]

Generic FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Associated Types

type Rep FieldStats :: Type -> Type

Methods

from :: FieldStats -> Rep FieldStats x

to :: Rep FieldStats x -> FieldStats

Read FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Methods

readsPrec :: Int -> ReadS FieldStats

readList :: ReadS [FieldStats]

readPrec :: ReadPrec FieldStats

readListPrec :: ReadPrec [FieldStats]

Show FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Methods

showsPrec :: Int -> FieldStats -> ShowS

show :: FieldStats -> String

showList :: [FieldStats] -> ShowS

NFData FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Methods

rnf :: FieldStats -> ()

Eq FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Methods

(==) :: FieldStats -> FieldStats -> Bool

(/=) :: FieldStats -> FieldStats -> Bool

Hashable FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Methods

hashWithSalt :: Int -> FieldStats -> Int

hash :: FieldStats -> Int

type Rep FieldStats

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

type Rep FieldStats = D1 ('MetaData "FieldStats" "Amazonka.CloudSearchDomains.Types.FieldStats" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "FieldStats'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "max") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "mean") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "min") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "missing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "stddev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "sum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "sumOfSquares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))

newFieldStats :: FieldStats

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:count:FieldStats', fieldStats_count - The number of documents that contain a value in the specified field in the result set.

$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: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: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:sum:FieldStats', fieldStats_sum - The sum of the field values across the documents in the result set. null for date fields.

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

fieldStats_count :: Lens' FieldStats (Maybe Integer)

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

fieldStats_max :: Lens' FieldStats (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.

fieldStats_mean :: Lens' FieldStats (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.

fieldStats_min :: Lens' FieldStats (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.

fieldStats_missing :: Lens' FieldStats (Maybe Integer)

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

fieldStats_stddev :: Lens' FieldStats (Maybe Double)

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

fieldStats_sum :: Lens' FieldStats (Maybe Double)

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

fieldStats_sumOfSquares :: Lens' FieldStats (Maybe Double)

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