Class IndexField
- All Implemented Interfaces:
Serializable
,Cloneable
Configuration information for a field in the index, including its name, type,
and options. The supported options depend on the
IndexFieldType
.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
A string that represents the name of an index field.int
hashCode()
void
setDateArrayOptions
(DateArrayOptions dateArrayOptions) void
setDateOptions
(DateOptions dateOptions) void
setDoubleArrayOptions
(DoubleArrayOptions doubleArrayOptions) void
setDoubleOptions
(DoubleOptions doubleOptions) void
setIndexFieldName
(String indexFieldName) A string that represents the name of an index field.void
setIndexFieldType
(IndexFieldType indexFieldType) void
setIndexFieldType
(String indexFieldType) void
setIntArrayOptions
(IntArrayOptions intArrayOptions) void
setIntOptions
(IntOptions intOptions) void
setLatLonOptions
(LatLonOptions latLonOptions) void
setLiteralArrayOptions
(LiteralArrayOptions literalArrayOptions) void
setLiteralOptions
(LiteralOptions literalOptions) void
setTextArrayOptions
(TextArrayOptions textArrayOptions) void
setTextOptions
(TextOptions textOptions) toString()
Returns a string representation of this object; useful for testing and debugging.withDateArrayOptions
(DateArrayOptions dateArrayOptions) withDateOptions
(DateOptions dateOptions) withDoubleArrayOptions
(DoubleArrayOptions doubleArrayOptions) withDoubleOptions
(DoubleOptions doubleOptions) withIndexFieldName
(String indexFieldName) A string that represents the name of an index field.withIndexFieldType
(IndexFieldType indexFieldType) withIndexFieldType
(String indexFieldType) withIntArrayOptions
(IntArrayOptions intArrayOptions) withIntOptions
(IntOptions intOptions) withLatLonOptions
(LatLonOptions latLonOptions) withLiteralArrayOptions
(LiteralArrayOptions literalArrayOptions) withLiteralOptions
(LiteralOptions literalOptions) withTextArrayOptions
(TextArrayOptions textArrayOptions) withTextOptions
(TextOptions textOptions)
-
Constructor Details
-
IndexField
public IndexField()
-
-
Method Details
-
setIndexFieldName
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
.- Parameters:
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
.
-
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
.- 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
.
-
withIndexFieldName
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
.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setIndexFieldType
- Parameters:
indexFieldType
-- See Also:
-
getIndexFieldType
- Returns:
- See Also:
-
withIndexFieldType
- Parameters:
indexFieldType
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setIndexFieldType
- Parameters:
indexFieldType
-- See Also:
-
withIndexFieldType
- Parameters:
indexFieldType
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setIntOptions
- Parameters:
intOptions
-
-
getIntOptions
- Returns:
-
withIntOptions
- Parameters:
intOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDoubleOptions
- Parameters:
doubleOptions
-
-
getDoubleOptions
- Returns:
-
withDoubleOptions
- Parameters:
doubleOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLiteralOptions
- Parameters:
literalOptions
-
-
getLiteralOptions
- Returns:
-
withLiteralOptions
- Parameters:
literalOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTextOptions
- Parameters:
textOptions
-
-
getTextOptions
- Returns:
-
withTextOptions
- Parameters:
textOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDateOptions
- Parameters:
dateOptions
-
-
getDateOptions
- Returns:
-
withDateOptions
- Parameters:
dateOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLatLonOptions
- Parameters:
latLonOptions
-
-
getLatLonOptions
- Returns:
-
withLatLonOptions
- Parameters:
latLonOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIntArrayOptions
- Parameters:
intArrayOptions
-
-
getIntArrayOptions
- Returns:
-
withIntArrayOptions
- Parameters:
intArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDoubleArrayOptions
- Parameters:
doubleArrayOptions
-
-
getDoubleArrayOptions
- Returns:
-
withDoubleArrayOptions
- Parameters:
doubleArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLiteralArrayOptions
- Parameters:
literalArrayOptions
-
-
getLiteralArrayOptions
- Returns:
-
withLiteralArrayOptions
- Parameters:
literalArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTextArrayOptions
- Parameters:
textArrayOptions
-
-
getTextArrayOptions
- Returns:
-
withTextArrayOptions
- Parameters:
textArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDateArrayOptions
- Parameters:
dateArrayOptions
-
-
getDateArrayOptions
- Returns:
-
withDateArrayOptions
- Parameters:
dateArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-