software.amazon.awssdk.services.cloudsearch.model

Class TextArrayOptions

java.lang.Object

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

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class TextArrayOptions
extends Object
implements SdkPojo, Serializable, 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextArrayOptions.Builder

Method Summary

Modifier and Type	Method and 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)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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 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() Returns a string representation of this object.

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

sourceFields

public final 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 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.

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

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