FieldStats (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudsearchdomain.model.FieldStats

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FieldStats
extends Object
implements Serializable, Cloneable, StructuredPojo

The statistics for a field calculated in the request.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

FieldStats()

Constructors
Constructor and Description
`FieldStats()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldStats`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getCount()` The number of documents that contain a value in the specified field in the result set.
`String`	`getMax()` The maximum value found in the specified field in the result set.
`String`	`getMean()` The average of the values found in the specified field in the result set.
`String`	`getMin()` The minimum value found in the specified field in the result set.
`Long`	`getMissing()` The number of documents that do not contain a value in the specified field in the result set.
`Double`	`getStddev()` The standard deviation of the values in the specified field in the result set.
`Double`	`getSum()` The sum of the field values across the documents in the result set.
`Double`	`getSumOfSquares()` The sum of all field values in the result set squared.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCount(Long count)` The number of documents that contain a value in the specified field in the result set.
`void`	`setMax(String max)` The maximum value found in the specified field in the result set.
`void`	`setMean(String mean)` The average of the values found in the specified field in the result set.
`void`	`setMin(String min)` The minimum value found in the specified field in the result set.
`void`	`setMissing(Long missing)` The number of documents that do not contain a value in the specified field in the result set.
`void`	`setStddev(Double stddev)` The standard deviation of the values in the specified field in the result set.
`void`	`setSum(Double sum)` The sum of the field values across the documents in the result set.
`void`	`setSumOfSquares(Double sumOfSquares)` The sum of all field values in the result set squared.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`FieldStats`	`withCount(Long count)` The number of documents that contain a value in the specified field in the result set.
`FieldStats`	`withMax(String max)` The maximum value found in the specified field in the result set.
`FieldStats`	`withMean(String mean)` The average of the values found in the specified field in the result set.
`FieldStats`	`withMin(String min)` The minimum value found in the specified field in the result set.
`FieldStats`	`withMissing(Long missing)` The number of documents that do not contain a value in the specified field in the result set.
`FieldStats`	`withStddev(Double stddev)` The standard deviation of the values in the specified field in the result set.
`FieldStats`	`withSum(Double sum)` The sum of the field values across the documents in the result set.
`FieldStats`	`withSumOfSquares(Double sumOfSquares)` The sum of all field values in the result set squared.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FieldStats
```
public FieldStats()
```
- Method Detail
  - setMin
```
public void setMin(String 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.
    
    Parameters:
    
    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.
  - getMin
```
public String getMin()
```
    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:
    
    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.
  - withMin
```
public FieldStats withMin(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMax
```
public void setMax(String 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.
    
    Parameters:
    
    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.
  - getMax
```
public String getMax()
```
    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:
    
    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.
  - withMax
```
public FieldStats withMax(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCount
```
public void setCount(Long count)
```
    The number of documents that contain a value in the specified field in the result set.
    
    Parameters:
    
    count - The number of documents that contain a value in the specified field in the result set.
  - getCount
```
public Long getCount()
```
    The number of documents that contain a value in the specified field in the result set.
    
    Returns:
    
    The number of documents that contain a value in the specified field in the result set.
  - withCount
```
public FieldStats withCount(Long count)
```
    The number of documents that contain a value in the specified field in the result set.
    
    Parameters:
    
    count - The number of documents that contain a value in the specified field in the result set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMissing
```
public void setMissing(Long missing)
```
    The number of documents that do not contain a value in the specified field in the result set.
    
    Parameters:
    
    missing - The number of documents that do not contain a value in the specified field in the result set.
  - getMissing
```
public Long getMissing()
```
    The number of documents that do not contain a value in the specified field in the result set.
    
    Returns:
    
    The number of documents that do not contain a value in the specified field in the result set.
  - withMissing
```
public FieldStats withMissing(Long missing)
```
    The number of documents that do not contain a value in the specified field in the result set.
    
    Parameters:
    
    missing - The number of documents that do not contain a value in the specified field in the result set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSum
```
public void setSum(Double sum)
```
    The sum of the field values across the documents in the result set. null for date fields.
    
    Parameters:
    
    sum - The sum of the field values across the documents in the result set. null for date fields.
  - getSum
```
public Double getSum()
```
    The sum of the field values across the documents in the result set. null for date fields.
    
    Returns:
    
    The sum of the field values across the documents in the result set. null for date fields.
  - withSum
```
public FieldStats withSum(Double sum)
```
    The sum of the field values across the documents in the result set. null for date fields.
    
    Parameters:
    
    sum - The sum of the field values across the documents in the result set. null for date fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSumOfSquares
```
public void setSumOfSquares(Double sumOfSquares)
```
    The sum of all field values in the result set squared.
    
    Parameters:
    
    sumOfSquares - The sum of all field values in the result set squared.
  - getSumOfSquares
```
public Double getSumOfSquares()
```
    The sum of all field values in the result set squared.
    
    Returns:
    
    The sum of all field values in the result set squared.
  - withSumOfSquares
```
public FieldStats withSumOfSquares(Double sumOfSquares)
```
    The sum of all field values in the result set squared.
    
    Parameters:
    
    sumOfSquares - The sum of all field values in the result set squared.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMean
```
public void setMean(String 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.
    
    Parameters:
    
    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.
  - getMean
```
public String getMean()
```
    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:
    
    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.
  - withMean
```
public FieldStats withMean(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStddev
```
public void setStddev(Double stddev)
```
    The standard deviation of the values in the specified field in the result set.
    
    Parameters:
    
    stddev - The standard deviation of the values in the specified field in the result set.
  - getStddev
```
public Double getStddev()
```
    The standard deviation of the values in the specified field in the result set.
    
    Returns:
    
    The standard deviation of the values in the specified field in the result set.
  - withStddev
```
public FieldStats withStddev(Double stddev)
```
    The standard deviation of the values in the specified field in the result set.
    
    Parameters:
    
    stddev - The standard deviation of the values in the specified field in the result set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FieldStats clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class FieldStats

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldStats

Method Detail

setMin

getMin

withMin

setMax

getMax

withMax

setCount

getCount

withCount

setMissing

getMissing

withMissing

setSum

getSum

withSum

setSumOfSquares

getSumOfSquares

withSumOfSquares

setMean

getMean

withMean

setStddev

getStddev

withStddev

toString

equals

hashCode

clone

marshall