Class IndexField
- java.lang.Object
-
- com.amazonaws.services.cloudsearchv2.model.IndexField
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class IndexField extends Object implements 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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IndexField()
-
Method Summary
-
-
-
Method Detail
-
setIndexFieldName
public void setIndexFieldName(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
.- 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
public 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
.- 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
public IndexField withIndexFieldName(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
.- 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
public void setIndexFieldType(String indexFieldType)
- Parameters:
indexFieldType
-- See Also:
IndexFieldType
-
getIndexFieldType
public String getIndexFieldType()
- Returns:
- See Also:
IndexFieldType
-
withIndexFieldType
public IndexField withIndexFieldType(String indexFieldType)
- Parameters:
indexFieldType
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IndexFieldType
-
setIndexFieldType
public void setIndexFieldType(IndexFieldType indexFieldType)
- Parameters:
indexFieldType
-- See Also:
IndexFieldType
-
withIndexFieldType
public IndexField withIndexFieldType(IndexFieldType indexFieldType)
- Parameters:
indexFieldType
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IndexFieldType
-
setIntOptions
public void setIntOptions(IntOptions intOptions)
- Parameters:
intOptions
-
-
getIntOptions
public IntOptions getIntOptions()
- Returns:
-
withIntOptions
public IndexField withIntOptions(IntOptions intOptions)
- Parameters:
intOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDoubleOptions
public void setDoubleOptions(DoubleOptions doubleOptions)
- Parameters:
doubleOptions
-
-
getDoubleOptions
public DoubleOptions getDoubleOptions()
- Returns:
-
withDoubleOptions
public IndexField withDoubleOptions(DoubleOptions doubleOptions)
- Parameters:
doubleOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLiteralOptions
public void setLiteralOptions(LiteralOptions literalOptions)
- Parameters:
literalOptions
-
-
getLiteralOptions
public LiteralOptions getLiteralOptions()
- Returns:
-
withLiteralOptions
public IndexField withLiteralOptions(LiteralOptions literalOptions)
- Parameters:
literalOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTextOptions
public void setTextOptions(TextOptions textOptions)
- Parameters:
textOptions
-
-
getTextOptions
public TextOptions getTextOptions()
- Returns:
-
withTextOptions
public IndexField withTextOptions(TextOptions textOptions)
- Parameters:
textOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDateOptions
public void setDateOptions(DateOptions dateOptions)
- Parameters:
dateOptions
-
-
getDateOptions
public DateOptions getDateOptions()
- Returns:
-
withDateOptions
public IndexField withDateOptions(DateOptions dateOptions)
- Parameters:
dateOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLatLonOptions
public void setLatLonOptions(LatLonOptions latLonOptions)
- Parameters:
latLonOptions
-
-
getLatLonOptions
public LatLonOptions getLatLonOptions()
- Returns:
-
withLatLonOptions
public IndexField withLatLonOptions(LatLonOptions latLonOptions)
- Parameters:
latLonOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIntArrayOptions
public void setIntArrayOptions(IntArrayOptions intArrayOptions)
- Parameters:
intArrayOptions
-
-
getIntArrayOptions
public IntArrayOptions getIntArrayOptions()
- Returns:
-
withIntArrayOptions
public IndexField withIntArrayOptions(IntArrayOptions intArrayOptions)
- Parameters:
intArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDoubleArrayOptions
public void setDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
- Parameters:
doubleArrayOptions
-
-
getDoubleArrayOptions
public DoubleArrayOptions getDoubleArrayOptions()
- Returns:
-
withDoubleArrayOptions
public IndexField withDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
- Parameters:
doubleArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLiteralArrayOptions
public void setLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
- Parameters:
literalArrayOptions
-
-
getLiteralArrayOptions
public LiteralArrayOptions getLiteralArrayOptions()
- Returns:
-
withLiteralArrayOptions
public IndexField withLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
- Parameters:
literalArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTextArrayOptions
public void setTextArrayOptions(TextArrayOptions textArrayOptions)
- Parameters:
textArrayOptions
-
-
getTextArrayOptions
public TextArrayOptions getTextArrayOptions()
- Returns:
-
withTextArrayOptions
public IndexField withTextArrayOptions(TextArrayOptions textArrayOptions)
- Parameters:
textArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDateArrayOptions
public void setDateArrayOptions(DateArrayOptions dateArrayOptions)
- Parameters:
dateArrayOptions
-
-
getDateArrayOptions
public DateArrayOptions getDateArrayOptions()
- Returns:
-
withDateArrayOptions
public IndexField withDateArrayOptions(DateArrayOptions dateArrayOptions)
- Parameters:
dateArrayOptions
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public IndexField clone()
-
-