software.amazon.awssdk.services.cloudsearchdomain.model

Class FieldStats

java.lang.Object

software.amazon.awssdk.services.cloudsearchdomain.model.FieldStats

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<FieldStats.Builder,FieldStats>

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

The statistics for a field calculated in the request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FieldStats.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

min

public 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 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 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 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 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 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 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FieldStats.Builder,FieldStats>

Returns:

a builder for type T

builder

public static FieldStats.Builder builder()

serializableBuilderClass

public static Class<? extends FieldStats.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.