java.lang.Object
- software.amazon.awssdk.services.cloudsearchdomain.model.FieldStats

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<FieldStats.Builder,FieldStats>

@Generated("software.amazon.awssdk:codegen")
public final class FieldStats
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FieldStats.Builder,FieldStats>

The statistics for a field calculated in the request.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface FieldStats.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FieldStats.Builder`	`builder()`
`Long`	`count()`	The number of documents that contain a value in the specified field in the result set.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`max()`	The maximum value found in the specified field in the result set.
`String`	`mean()`	The average of the values found in the specified field in the result set.
`String`	`min()`	The minimum value found in the specified field in the result set.
`Long`	`missing()`	The number of documents that do not contain a value in the specified field in the result set.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FieldStats.Builder>`	`serializableBuilderClass()`
`Double`	`stddev()`	The standard deviation of the values in the specified field in the result set.
`Double`	`sum()`	The sum of the field values across the documents in the result set.
`Double`	`sumOfSquares()`	The sum of all field values in the result set squared.
`FieldStats.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - min
```
public final 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.
    
    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.
  - max
```
public final 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.
    
    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.
  - count
```
public final Long count()
```
    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.
  - missing
```
public final Long missing()
```
    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.
  - sum
```
public final Double sum()
```
    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.
  - sumOfSquares
```
public final Double sumOfSquares()
```
    The sum of all field values in the result set squared.
    
    Returns:
    
    The sum of all field values in the result set squared.
  - mean
```
public final 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.
    
    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.
  - stddev
```
public final Double stddev()
```
    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.
  - toBuilder
```
public FieldStats.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FieldStats.Builder,FieldStats>
  - builder
```
public static FieldStats.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FieldStats.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class FieldStats

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

min

max

count

missing

sum

sumOfSquares

mean

stddev

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField