public class IndexField
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Configuration information for a field in the index, including its name, type,
and options. The supported options depend on the
IndexFieldType
.
Modifier and Type | Field and Description |
---|---|
private DateArrayOptions |
dateArrayOptions |
private DateOptions |
dateOptions |
private DoubleArrayOptions |
doubleArrayOptions |
private DoubleOptions |
doubleOptions |
private java.lang.String |
indexFieldName
A string that represents the name of an index field.
|
private java.lang.String |
indexFieldType |
private IntArrayOptions |
intArrayOptions |
private IntOptions |
intOptions |
private LatLonOptions |
latLonOptions |
private LiteralArrayOptions |
literalArrayOptions |
private LiteralOptions |
literalOptions |
private TextArrayOptions |
textArrayOptions |
private TextOptions |
textOptions |
Constructor and Description |
---|
IndexField() |
private java.lang.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
.
private java.lang.String indexFieldType
private IntOptions intOptions
private DoubleOptions doubleOptions
private LiteralOptions literalOptions
private TextOptions textOptions
private DateOptions dateOptions
private LatLonOptions latLonOptions
private IntArrayOptions intArrayOptions
private DoubleArrayOptions doubleArrayOptions
private LiteralArrayOptions literalArrayOptions
private TextArrayOptions textArrayOptions
private DateArrayOptions dateArrayOptions
public void setIndexFieldName(java.lang.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
.
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
.
public java.lang.String getIndexFieldName()
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 IndexField withIndexFieldName(java.lang.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
.
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
.
public void setIndexFieldType(java.lang.String indexFieldType)
indexFieldType
- IndexFieldType
public java.lang.String getIndexFieldType()
IndexFieldType
public IndexField withIndexFieldType(java.lang.String indexFieldType)
indexFieldType
- IndexFieldType
public void setIndexFieldType(IndexFieldType indexFieldType)
indexFieldType
- IndexFieldType
public IndexField withIndexFieldType(IndexFieldType indexFieldType)
indexFieldType
- IndexFieldType
public void setIntOptions(IntOptions intOptions)
intOptions
- public IntOptions getIntOptions()
public IndexField withIntOptions(IntOptions intOptions)
intOptions
- public void setDoubleOptions(DoubleOptions doubleOptions)
doubleOptions
- public DoubleOptions getDoubleOptions()
public IndexField withDoubleOptions(DoubleOptions doubleOptions)
doubleOptions
- public void setLiteralOptions(LiteralOptions literalOptions)
literalOptions
- public LiteralOptions getLiteralOptions()
public IndexField withLiteralOptions(LiteralOptions literalOptions)
literalOptions
- public void setTextOptions(TextOptions textOptions)
textOptions
- public TextOptions getTextOptions()
public IndexField withTextOptions(TextOptions textOptions)
textOptions
- public void setDateOptions(DateOptions dateOptions)
dateOptions
- public DateOptions getDateOptions()
public IndexField withDateOptions(DateOptions dateOptions)
dateOptions
- public void setLatLonOptions(LatLonOptions latLonOptions)
latLonOptions
- public LatLonOptions getLatLonOptions()
public IndexField withLatLonOptions(LatLonOptions latLonOptions)
latLonOptions
- public void setIntArrayOptions(IntArrayOptions intArrayOptions)
intArrayOptions
- public IntArrayOptions getIntArrayOptions()
public IndexField withIntArrayOptions(IntArrayOptions intArrayOptions)
intArrayOptions
- public void setDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
doubleArrayOptions
- public DoubleArrayOptions getDoubleArrayOptions()
public IndexField withDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
doubleArrayOptions
- public void setLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
literalArrayOptions
- public LiteralArrayOptions getLiteralArrayOptions()
public IndexField withLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
literalArrayOptions
- public void setTextArrayOptions(TextArrayOptions textArrayOptions)
textArrayOptions
- public TextArrayOptions getTextArrayOptions()
public IndexField withTextArrayOptions(TextArrayOptions textArrayOptions)
textArrayOptions
- public void setDateArrayOptions(DateArrayOptions dateArrayOptions)
dateArrayOptions
- public DateArrayOptions getDateArrayOptions()
public IndexField withDateArrayOptions(DateArrayOptions dateArrayOptions)
dateArrayOptions
- public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public IndexField clone()
clone
in class java.lang.Object