You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudSearchDomain::Types::FieldStats

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb

Overview

The statistics for a field calculated in the request.

Instance Attribute Summary collapse

Instance Attribute Details

#countInteger

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

Returns:

  • (Integer)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end

#maxString

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.

Returns:

  • (String)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end

#meanString

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.

Returns:

  • (String)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end

#minString

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.

Returns:

  • (String)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end

#missingInteger

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

Returns:

  • (Integer)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end

#stddevFloat

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

Returns:

  • (Float)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end

#sumFloat

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

Returns:

  • (Float)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end

#sum_of_squaresFloat

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

Returns:

  • (Float)


123
124
125
126
127
128
129
130
131
132
133
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 123

class FieldStats < Struct.new(
  :min,
  :max,
  :count,
  :missing,
  :sum,
  :sum_of_squares,
  :mean,
  :stddev)
  include Aws::Structure
end