Package 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("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	Description
static interface	TextOptions.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(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()
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

defaultValue

public final 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 final String sourceField()

Returns the value of the SourceField property for this object.

Returns:

The value of the SourceField property for this object.

returnEnabled

public final 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 final 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 final Boolean highlightEnabled()

Whether highlights can be returned for the field.

Returns:

Whether highlights can be returned for the field.

analysisScheme

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

Specified by:

toBuilder in interface ToCopyableBuilder<TextOptions.Builder,TextOptions>

builder

public static TextOptions.Builder builder()

serializableBuilderClass

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