Package software.amazon.awssdk.services.cloudsearch.model

Class TextArrayOptions

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.TextArrayOptions

All Implemented Interfaces:

ToCopyableBuilder<TextArrayOptions.Builder,TextArrayOptions>

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

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextArrayOptions.Builder

Method Summary

Modifier and Type	Method	Description
String	analysisScheme()	The name of an analysis scheme for a text-array field.
static TextArrayOptions.Builder	builder()
String	defaultValue()	A value to use for the field if the field isn't specified for a document.
boolean	equals(Object obj)
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.
static Class<? extends TextArrayOptions.Builder>	serializableBuilderClass()
String	sourceFields()	A list of source fields to map to the field.
TextArrayOptions.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

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.

sourceFields

public String sourceFields()

A list of source fields to map to the field.

Returns:

A list of source fields to map to the field.

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.

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-array field.

Returns:

The name of an analysis scheme for a text-array field.

toBuilder

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

Returns:

a builder for type T

builder

public static TextArrayOptions.Builder builder()

serializableBuilderClass

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