AWS SDK for .NET Documentation
IndexField Class
AmazonAmazon.CloudSearch.ModelIndexField Did this page help you?   Yes   No    Tell us about it...

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType .

Declaration Syntax
C#
public class IndexField
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
IndexField()()()()
Initializes a new instance of the IndexField class

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.

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.

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.

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.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
IndexFieldName
The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name.

Constraints:

Length
1 - 64
Pattern
[a-z][a-z0-9_]*


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.

Constraints:

Allowed Values
int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array


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.

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.

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.

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.

LiteralOptions
Options for literal field. Present if IndexFieldType specifies the field is of type literal. 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.

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.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithDateArrayOptions(DateArrayOptions) Obsolete.
Sets the DateArrayOptions property

WithDateOptions(DateOptions) Obsolete.
Sets the DateOptions property

WithDoubleArrayOptions(DoubleArrayOptions) Obsolete.
Sets the DoubleArrayOptions property

WithDoubleOptions(DoubleOptions) Obsolete.
Sets the DoubleOptions property

WithIndexFieldName(String) Obsolete.
Sets the IndexFieldName property

WithIndexFieldType(String) Obsolete.
Sets the IndexFieldType property

WithIntArrayOptions(IntArrayOptions) Obsolete.
Sets the IntArrayOptions property

WithIntOptions(IntOptions) Obsolete.
Sets the IntOptions property

WithLatLonOptions(LatLonOptions) Obsolete.
Sets the LatLonOptions property

WithLiteralArrayOptions(LiteralArrayOptions) Obsolete.
Sets the LiteralArrayOptions property

WithLiteralOptions(LiteralOptions) Obsolete.
Sets the LiteralOptions property

WithTextArrayOptions(TextArrayOptions) Obsolete.
Sets the TextArrayOptions property

WithTextOptions(TextOptions) Obsolete.
Sets the TextOptions property

Inheritance Hierarchy
Object
IndexField

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)