software.amazon.awssdk.services.cloudsearch.model

Class DoubleOptions

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.DoubleOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DoubleOptions.Builder,DoubleOptions>

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

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DoubleOptions.Builder

Method Summary

Modifier and Type	Method and Description
static DoubleOptions.Builder	builder()
Double	defaultValue() A value to use for the field if the field isn't specified for a document.
boolean	equals(Object obj)
Boolean	facetEnabled() Whether facet information can be returned for the field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	returnEnabled() Whether the contents of the field can be returned in the search results.
List<SdkField<?>>	sdkFields()
Boolean	searchEnabled() Whether the contents of the field are searchable.
static Class<? extends DoubleOptions.Builder>	serializableBuilderClass()
Boolean	sortEnabled() Whether the field can be used to sort the search results.
String	sourceField() The name of the source field to map to the field.
DoubleOptions.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

defaultValue

public Double defaultValue()

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

Returns:

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

sourceField

public String sourceField()

The name of the source field to map to the field.

Returns:

The name of the source field to map to the field.

facetEnabled

public Boolean facetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

searchEnabled

public Boolean searchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

returnEnabled

public Boolean returnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

sortEnabled

public Boolean sortEnabled()

Whether the field can be used to sort the search results.

Returns:

Whether the field can be used to sort the search results.

toBuilder

public DoubleOptions.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<DoubleOptions.Builder,DoubleOptions>

Returns:

a builder for type T

builder

public static DoubleOptions.Builder builder()

serializableBuilderClass

public static Class<? extends DoubleOptions.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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.