@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.
Modifier and Type | Class and Description |
---|---|
static interface |
TextArrayOptions.Builder |
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.
|
copy
public final String defaultValue()
public final String sourceFields()
A list of source fields to map to the field.
public final Boolean returnEnabled()
Whether the contents of the field can be returned in the search results.
public final Boolean highlightEnabled()
Whether highlights can be returned for the field.
public final String analysisScheme()
The name of an analysis scheme for a text-array
field.
text-array
field.public TextArrayOptions.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TextArrayOptions.Builder,TextArrayOptions>
public static TextArrayOptions.Builder builder()
public static Class<? extends TextArrayOptions.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.