@Generated(value="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
.
Modifier and Type | Class and Description |
---|---|
static interface |
IndexField.Builder |
Modifier and Type | Method and Description |
---|---|
static IndexField.Builder |
builder() |
DateArrayOptions |
dateArrayOptions()
Returns the value of the DateArrayOptions property for this object.
|
DateOptions |
dateOptions()
Returns the value of the DateOptions property for this object.
|
DoubleArrayOptions |
doubleArrayOptions()
Returns the value of the DoubleArrayOptions property for this object.
|
DoubleOptions |
doubleOptions()
Returns the value of the DoubleOptions property for this object.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
indexFieldName()
A string that represents the name of an index field.
|
IndexFieldType |
indexFieldType()
Returns the value of the IndexFieldType property for this object.
|
String |
indexFieldTypeString()
Returns the value of the IndexFieldType property for this object.
|
IntArrayOptions |
intArrayOptions()
Returns the value of the IntArrayOptions property for this object.
|
IntOptions |
intOptions()
Returns the value of the IntOptions property for this object.
|
LatLonOptions |
latLonOptions()
Returns the value of the LatLonOptions property for this object.
|
LiteralArrayOptions |
literalArrayOptions()
Returns the value of the LiteralArrayOptions property for this object.
|
LiteralOptions |
literalOptions()
Returns the value of the LiteralOptions property for this object.
|
static Class<? extends IndexField.Builder> |
serializableBuilderClass() |
TextArrayOptions |
textArrayOptions()
Returns the value of the TextArrayOptions property for this object.
|
TextOptions |
textOptions()
Returns the value of the TextOptions property for this object.
|
IndexField.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
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
.
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
.
public IndexFieldType indexFieldType()
If the service returns an enum value that is not available in the current SDK version, indexFieldType
will return IndexFieldType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from indexFieldTypeString()
.
IndexFieldType
public String indexFieldTypeString()
If the service returns an enum value that is not available in the current SDK version, indexFieldType
will return IndexFieldType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from indexFieldTypeString()
.
IndexFieldType
public IntOptions intOptions()
public DoubleOptions doubleOptions()
public LiteralOptions literalOptions()
public TextOptions textOptions()
public DateOptions dateOptions()
public LatLonOptions latLonOptions()
public IntArrayOptions intArrayOptions()
public DoubleArrayOptions doubleArrayOptions()
public LiteralArrayOptions literalArrayOptions()
public TextArrayOptions textArrayOptions()
public DateArrayOptions dateArrayOptions()
public IndexField.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<IndexField.Builder,IndexField>
public static IndexField.Builder builder()
public static Class<? extends IndexField.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.