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

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

Overview

The statistics for a field calculated in the request.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#count ⇒ Integer

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

Returns:

  • (Integer) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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

#max ⇒ String

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.

[1]: tools.ietf.org/html/rfc3339

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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

#mean ⇒ String

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.

[1]: tools.ietf.org/html/rfc3339

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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

#min ⇒ String

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.

[1]: tools.ietf.org/html/rfc3339

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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

#missing ⇒ Integer

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

Returns:

  • (Integer) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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

#stddev ⇒ Float

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

Returns:

  • (Float) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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

#sum ⇒ Float

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

Returns:

  • (Float) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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

#sum_of_squares ⇒ Float

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

Returns:

  • (Float) 


144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 144

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