software.amazon.awssdk.services.cloudsearch.model

Class TextOptions

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.TextOptions

All Implemented Interfaces:

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

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

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextOptions.Builder

Method Summary

Modifier and Type	Method and Description
String	analysisScheme() The name of an analysis scheme for a text field.
static TextOptions.Builder	builder()
String	defaultValue() A value to use for the field if the field isn't specified for a document.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	highlightEnabled() Whether highlights can be returned for the field.
Boolean	returnEnabled() Whether the contents of the field can be returned in the search results.
List<SdkField<?>>	sdkFields()
static Class<? extends TextOptions.Builder>	serializableBuilderClass()
Boolean	sortEnabled() Whether the field can be used to sort the search results.
String	sourceField() Returns the value of the SourceField property for this object.
TextOptions.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 String defaultValue()

A value to use for the field if the field isn't specified for a document.

Returns:

A value to use for the field if the field isn't specified for a document.

sourceField

public String sourceField()

Returns the value of the SourceField property for this object.

Returns:

The value of the SourceField property for this object.

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.

highlightEnabled

public Boolean highlightEnabled()

Whether highlights can be returned for the field.

Returns:

Whether highlights can be returned for the field.

analysisScheme

public String analysisScheme()

The name of an analysis scheme for a text field.

Returns:

The name of an analysis scheme for a text field.

toBuilder

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

Returns:

a builder for type T

builder

public static TextOptions.Builder builder()

serializableBuilderClass

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