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
.
Constructor and Description |
---|
IndexField() |
Modifier and Type | Method and Description |
---|---|
IndexField |
clone() |
boolean |
equals(Object obj) |
DateArrayOptions |
getDateArrayOptions()
Options for a field that contains an array of dates.
|
DateOptions |
getDateOptions()
Options for a date field.
|
DoubleArrayOptions |
getDoubleArrayOptions()
Options for a field that contains an array of double-precision 64-bit
floating point values.
|
DoubleOptions |
getDoubleOptions()
Options for a double-precision 64-bit floating point field.
|
String |
getIndexFieldName()
A string that represents the name of an index field.
|
String |
getIndexFieldType()
The type of field.
|
IntArrayOptions |
getIntArrayOptions()
Options for a field that contains an array of 64-bit signed integers.
|
IntOptions |
getIntOptions()
Options for a 64-bit signed integer field.
|
LatLonOptions |
getLatLonOptions()
Options for a latlon field.
|
LiteralArrayOptions |
getLiteralArrayOptions()
Options for a field that contains an array of literal strings.
|
LiteralOptions |
getLiteralOptions()
Options for literal field.
|
TextArrayOptions |
getTextArrayOptions()
Options for a field that contains an array of text strings.
|
TextOptions |
getTextOptions()
Options for text field.
|
int |
hashCode() |
void |
setDateArrayOptions(DateArrayOptions dateArrayOptions)
Options for a field that contains an array of dates.
|
void |
setDateOptions(DateOptions dateOptions)
Options for a date field.
|
void |
setDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
Options for a field that contains an array of double-precision 64-bit
floating point values.
|
void |
setDoubleOptions(DoubleOptions doubleOptions)
Options for a double-precision 64-bit floating point field.
|
void |
setIndexFieldName(String indexFieldName)
A string that represents the name of an index field.
|
void |
setIndexFieldType(IndexFieldType indexFieldType)
The type of field.
|
void |
setIndexFieldType(String indexFieldType)
The type of field.
|
void |
setIntArrayOptions(IntArrayOptions intArrayOptions)
Options for a field that contains an array of 64-bit signed integers.
|
void |
setIntOptions(IntOptions intOptions)
Options for a 64-bit signed integer field.
|
void |
setLatLonOptions(LatLonOptions latLonOptions)
Options for a latlon field.
|
void |
setLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
Options for a field that contains an array of literal strings.
|
void |
setLiteralOptions(LiteralOptions literalOptions)
Options for literal field.
|
void |
setTextArrayOptions(TextArrayOptions textArrayOptions)
Options for a field that contains an array of text strings.
|
void |
setTextOptions(TextOptions textOptions)
Options for text field.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
IndexField |
withDateArrayOptions(DateArrayOptions dateArrayOptions)
Options for a field that contains an array of dates.
|
IndexField |
withDateOptions(DateOptions dateOptions)
Options for a date field.
|
IndexField |
withDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
Options for a field that contains an array of double-precision 64-bit
floating point values.
|
IndexField |
withDoubleOptions(DoubleOptions doubleOptions)
Options for a double-precision 64-bit floating point field.
|
IndexField |
withIndexFieldName(String indexFieldName)
A string that represents the name of an index field.
|
IndexField |
withIndexFieldType(IndexFieldType indexFieldType)
The type of field.
|
IndexField |
withIndexFieldType(String indexFieldType)
The type of field.
|
IndexField |
withIntArrayOptions(IntArrayOptions intArrayOptions)
Options for a field that contains an array of 64-bit signed integers.
|
IndexField |
withIntOptions(IntOptions intOptions)
Options for a 64-bit signed integer field.
|
IndexField |
withLatLonOptions(LatLonOptions latLonOptions)
Options for a latlon field.
|
IndexField |
withLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
Options for a field that contains an array of literal strings.
|
IndexField |
withLiteralOptions(LiteralOptions literalOptions)
Options for literal field.
|
IndexField |
withTextArrayOptions(TextArrayOptions textArrayOptions)
Options for a field that contains an array of text strings.
|
IndexField |
withTextOptions(TextOptions textOptions)
Options for text field.
|
public String getIndexFieldName()
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
.
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
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 setIndexFieldName(String indexFieldName)
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
.
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
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 IndexField withIndexFieldName(String indexFieldName)
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 reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
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 String getIndexFieldType()
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
IndexFieldType
public void setIndexFieldType(String indexFieldType)
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
indexFieldType
- The type of field. The valid options for a field depend on the field
type. For more information about the supported field types, see Configuring Index Fields in the Amazon
CloudSearch Developer Guide.IndexFieldType
public IndexField withIndexFieldType(String indexFieldType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
indexFieldType
- The type of field. The valid options for a field depend on the field
type. For more information about the supported field types, see Configuring Index Fields in the Amazon
CloudSearch Developer Guide.IndexFieldType
public void setIndexFieldType(IndexFieldType indexFieldType)
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
indexFieldType
- The type of field. The valid options for a field depend on the field
type. For more information about the supported field types, see Configuring Index Fields in the Amazon
CloudSearch Developer Guide.IndexFieldType
public IndexField withIndexFieldType(IndexFieldType indexFieldType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
indexFieldType
- The type of field. The valid options for a field depend on the field
type. For more information about the supported field types, see Configuring Index Fields in the Amazon
CloudSearch Developer Guide.IndexFieldType
public IntOptions getIntOptions()
IndexFieldType
specifies the field is of type
int
. All options are enabled by default.IndexFieldType
specifies the field is of type
int
. All options are enabled by default.public void setIntOptions(IntOptions intOptions)
IndexFieldType
specifies the field is of type
int
. All options are enabled by default.intOptions
- Options for a 64-bit signed integer field. Present if
IndexFieldType
specifies the field is of type
int
. All options are enabled by default.public IndexField withIntOptions(IntOptions intOptions)
IndexFieldType
specifies the field is of type
int
. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
intOptions
- Options for a 64-bit signed integer field. Present if
IndexFieldType
specifies the field is of type
int
. All options are enabled by default.public DoubleOptions getDoubleOptions()
IndexFieldType
specifies the field is of type
double
. All options are enabled by default.IndexFieldType
specifies the field is of type
double
. All options are enabled by default.public void setDoubleOptions(DoubleOptions doubleOptions)
IndexFieldType
specifies the field is of type
double
. All options are enabled by default.doubleOptions
- Options for a double-precision 64-bit floating point field. Present if
IndexFieldType
specifies the field is of type
double
. All options are enabled by default.public IndexField withDoubleOptions(DoubleOptions doubleOptions)
IndexFieldType
specifies the field is of type
double
. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
doubleOptions
- Options for a double-precision 64-bit floating point field. Present if
IndexFieldType
specifies the field is of type
double
. All options are enabled by default.public LiteralOptions getLiteralOptions()
IndexFieldType
specifies the field is of type literal
. All options are
enabled by default.IndexFieldType
specifies the field is of type literal
. All options are
enabled by default.public void setLiteralOptions(LiteralOptions literalOptions)
IndexFieldType
specifies the field is of type literal
. All options are
enabled by default.literalOptions
- Options for literal field. Present if IndexFieldType
specifies the field is of type literal
. All options are
enabled by default.public IndexField withLiteralOptions(LiteralOptions literalOptions)
IndexFieldType
specifies the field is of type literal
. All options are
enabled by default.
Returns a reference to this object so that method calls can be chained together.
literalOptions
- Options for literal field. Present if IndexFieldType
specifies the field is of type literal
. All options are
enabled by default.public TextOptions getTextOptions()
IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.public void setTextOptions(TextOptions textOptions)
IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.textOptions
- Options for text field. Present if IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.public IndexField withTextOptions(TextOptions textOptions)
IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
textOptions
- Options for text field. Present if IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.public DateOptions getDateOptions()
IndexFieldType
specifies
the field is of type date
. All options are enabled by
default.IndexFieldType
specifies
the field is of type date
. All options are enabled by
default.public void setDateOptions(DateOptions dateOptions)
IndexFieldType
specifies
the field is of type date
. All options are enabled by
default.dateOptions
- Options for a date field. Dates and times are specified in UTC
(Coordinated Universal Time) according to IETF RFC3339:
yyyy-mm-ddT00:00:00Z. Present if IndexFieldType
specifies
the field is of type date
. All options are enabled by
default.public IndexField withDateOptions(DateOptions dateOptions)
IndexFieldType
specifies
the field is of type date
. All options are enabled by
default.
Returns a reference to this object so that method calls can be chained together.
dateOptions
- Options for a date field. Dates and times are specified in UTC
(Coordinated Universal Time) according to IETF RFC3339:
yyyy-mm-ddT00:00:00Z. Present if IndexFieldType
specifies
the field is of type date
. All options are enabled by
default.public LatLonOptions getLatLonOptions()
IndexFieldType
specifies the field is of type
latlon
. All options are enabled by default.IndexFieldType
specifies the field is of type
latlon
. All options are enabled by default.public void setLatLonOptions(LatLonOptions latLonOptions)
IndexFieldType
specifies the field is of type
latlon
. All options are enabled by default.latLonOptions
- Options for a latlon field. A latlon field contains a location stored
as a latitude and longitude value pair. Present if
IndexFieldType
specifies the field is of type
latlon
. All options are enabled by default.public IndexField withLatLonOptions(LatLonOptions latLonOptions)
IndexFieldType
specifies the field is of type
latlon
. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
latLonOptions
- Options for a latlon field. A latlon field contains a location stored
as a latitude and longitude value pair. Present if
IndexFieldType
specifies the field is of type
latlon
. All options are enabled by default.public IntArrayOptions getIntArrayOptions()
IndexFieldType
specifies the field is of type
int-array
. All options are enabled by default.IndexFieldType
specifies the field is of type
int-array
. All options are enabled by default.public void setIntArrayOptions(IntArrayOptions intArrayOptions)
IndexFieldType
specifies the field is of type
int-array
. All options are enabled by default.intArrayOptions
- Options for a field that contains an array of 64-bit signed integers.
Present if IndexFieldType
specifies the field is of type
int-array
. All options are enabled by default.public IndexField withIntArrayOptions(IntArrayOptions intArrayOptions)
IndexFieldType
specifies the field is of type
int-array
. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
intArrayOptions
- Options for a field that contains an array of 64-bit signed integers.
Present if IndexFieldType
specifies the field is of type
int-array
. All options are enabled by default.public DoubleArrayOptions getDoubleArrayOptions()
IndexFieldType
specifies the field is of type double-array
. All options
are enabled by default.IndexFieldType
specifies the field is of type double-array
. All options
are enabled by default.public void setDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
IndexFieldType
specifies the field is of type double-array
. All options
are enabled by default.doubleArrayOptions
- Options for a field that contains an array of double-precision 64-bit
floating point values. Present if IndexFieldType
specifies the field is of type double-array
. All options
are enabled by default.public IndexField withDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
IndexFieldType
specifies the field is of type double-array
. All options
are enabled by default.
Returns a reference to this object so that method calls can be chained together.
doubleArrayOptions
- Options for a field that contains an array of double-precision 64-bit
floating point values. Present if IndexFieldType
specifies the field is of type double-array
. All options
are enabled by default.public LiteralArrayOptions getLiteralArrayOptions()
IndexFieldType
specifies the field is of type
literal-array
. All options are enabled by default.IndexFieldType
specifies the field is of type
literal-array
. All options are enabled by default.public void setLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
IndexFieldType
specifies the field is of type
literal-array
. All options are enabled by default.literalArrayOptions
- Options for a field that contains an array of literal strings. Present
if IndexFieldType
specifies the field is of type
literal-array
. All options are enabled by default.public IndexField withLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
IndexFieldType
specifies the field is of type
literal-array
. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
literalArrayOptions
- Options for a field that contains an array of literal strings. Present
if IndexFieldType
specifies the field is of type
literal-array
. All options are enabled by default.public TextArrayOptions getTextArrayOptions()
IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.public void setTextArrayOptions(TextArrayOptions textArrayOptions)
IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.textArrayOptions
- Options for a field that contains an array of text strings. Present if
IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.public IndexField withTextArrayOptions(TextArrayOptions textArrayOptions)
IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
textArrayOptions
- Options for a field that contains an array of text strings. Present if
IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.public DateArrayOptions getDateArrayOptions()
IndexFieldType
specifies the field is of type
date-array
. All options are enabled by default.IndexFieldType
specifies the field is of type
date-array
. All options are enabled by default.public void setDateArrayOptions(DateArrayOptions dateArrayOptions)
IndexFieldType
specifies the field is of type
date-array
. All options are enabled by default.dateArrayOptions
- Options for a field that contains an array of dates. Present if
IndexFieldType
specifies the field is of type
date-array
. All options are enabled by default.public IndexField withDateArrayOptions(DateArrayOptions dateArrayOptions)
IndexFieldType
specifies the field is of type
date-array
. All options are enabled by default.
Returns a reference to this object so that method calls can be chained together.
dateArrayOptions
- Options for a field that contains an array of dates. Present if
IndexFieldType
specifies the field is of type
date-array
. All options are enabled by default.public String toString()
toString
in class Object
Object.toString()
public IndexField clone()
Copyright © 2015. All rights reserved.