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

Class IndexField

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.IndexField

All Implemented Interfaces:

ToCopyableBuilder<IndexField.Builder,IndexField>

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

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IndexField.Builder

Method Summary

Modifier and Type	Method	Description
static IndexField.Builder	builder()
DateArrayOptions	dateArrayOptions()
DateOptions	dateOptions()
DoubleArrayOptions	doubleArrayOptions()
DoubleOptions	doubleOptions()
boolean	equals(Object obj)
int	hashCode()
String	indexFieldName()	A string that represents the name of an index field.
String	indexFieldType()
IntArrayOptions	intArrayOptions()
IntOptions	intOptions()
LatLonOptions	latLonOptions()
LiteralArrayOptions	literalArrayOptions()
LiteralOptions	literalOptions()
static Class<? extends IndexField.Builder>	serializableBuilderClass()
TextArrayOptions	textArrayOptions()
TextOptions	textOptions()
IndexField.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

indexFieldName

public String indexFieldName()

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns:

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

indexFieldType

public String indexFieldType()

Returns:

See Also:

IndexFieldType

intOptions

public IntOptions intOptions()

Returns:

doubleOptions

public DoubleOptions doubleOptions()

Returns:

literalOptions

public LiteralOptions literalOptions()

Returns:

textOptions

public TextOptions textOptions()

Returns:

dateOptions

public DateOptions dateOptions()

Returns:

latLonOptions

public LatLonOptions latLonOptions()

Returns:

intArrayOptions

public IntArrayOptions intArrayOptions()

Returns:

doubleArrayOptions

public DoubleArrayOptions doubleArrayOptions()

Returns:

literalArrayOptions

public LiteralArrayOptions literalArrayOptions()

Returns:

textArrayOptions

public TextArrayOptions textArrayOptions()

Returns:

dateArrayOptions

public DateArrayOptions dateArrayOptions()

Returns:

toBuilder

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

Returns:

a builder for type T

builder

public static IndexField.Builder builder()

serializableBuilderClass

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