/AWS1/CL_SRHINDEXFIELD

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_indexfieldname TYPE /AWS1/SRHDYNAMICFIELDNAME /AWS1/SRHDYNAMICFIELDNAME

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.

iv_indexfieldtype TYPE /AWS1/SRHINDEXFIELDTYPE /AWS1/SRHINDEXFIELDTYPE

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.

Optional arguments:

io_intoptions TYPE REF TO /AWS1/CL_SRHINTOPTIONS /AWS1/CL_SRHINTOPTIONS

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

io_doubleoptions TYPE REF TO /AWS1/CL_SRHDOUBLEOPTIONS /AWS1/CL_SRHDOUBLEOPTIONS

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.

io_literaloptions TYPE REF TO /AWS1/CL_SRHLITERALOPTIONS /AWS1/CL_SRHLITERALOPTIONS

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

io_textoptions TYPE REF TO /AWS1/CL_SRHTEXTOPTIONS /AWS1/CL_SRHTEXTOPTIONS

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.

io_dateoptions TYPE REF TO /AWS1/CL_SRHDATEOPTIONS /AWS1/CL_SRHDATEOPTIONS

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.

io_latlonoptions TYPE REF TO /AWS1/CL_SRHLATLONOPTIONS /AWS1/CL_SRHLATLONOPTIONS

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.

io_intarrayoptions TYPE REF TO /AWS1/CL_SRHINTARRAYOPTIONS /AWS1/CL_SRHINTARRAYOPTIONS

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.

io_doublearrayoptions TYPE REF TO /AWS1/CL_SRHDOUBLEARRAYOPTIONS /AWS1/CL_SRHDOUBLEARRAYOPTIONS

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.

io_literalarrayoptions TYPE REF TO /AWS1/CL_SRHLITERALARRAYOPTS /AWS1/CL_SRHLITERALARRAYOPTS

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.

io_textarrayoptions TYPE REF TO /AWS1/CL_SRHTEXTARRAYOPTIONS /AWS1/CL_SRHTEXTARRAYOPTIONS

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.

io_datearrayoptions TYPE REF TO /AWS1/CL_SRHDATEARRAYOPTIONS /AWS1/CL_SRHDATEARRAYOPTIONS

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.

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_INDEXFIELDNAME()	Getter for INDEXFIELDNAME, with configurable default
ASK_INDEXFIELDNAME()	Getter for INDEXFIELDNAME w/ exceptions if field has no valu
HAS_INDEXFIELDNAME()	Determine if INDEXFIELDNAME has a value

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.

Accessible with the following methods

Method	Description
GET_INDEXFIELDTYPE()	Getter for INDEXFIELDTYPE, with configurable default
ASK_INDEXFIELDTYPE()	Getter for INDEXFIELDTYPE w/ exceptions if field has no valu
HAS_INDEXFIELDTYPE()	Determine if INDEXFIELDTYPE has a value

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.

Accessible with the following methods

Method	Description
GET_INTOPTIONS()	Getter for INTOPTIONS

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.

Accessible with the following methods

Method	Description
GET_DOUBLEOPTIONS()	Getter for DOUBLEOPTIONS

LiteralOptions

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

Accessible with the following methods

Method	Description
GET_LITERALOPTIONS()	Getter for LITERALOPTIONS

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.

Accessible with the following methods

Method	Description
GET_TEXTOPTIONS()	Getter for TEXTOPTIONS

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.

Accessible with the following methods

Method	Description
GET_DATEOPTIONS()	Getter for DATEOPTIONS

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.

Accessible with the following methods

Method	Description
GET_LATLONOPTIONS()	Getter for LATLONOPTIONS

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.

Accessible with the following methods

Method	Description
GET_INTARRAYOPTIONS()	Getter for INTARRAYOPTIONS

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.

Accessible with the following methods

Method	Description
GET_DOUBLEARRAYOPTIONS()	Getter for DOUBLEARRAYOPTIONS

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.

Accessible with the following methods

Method	Description
GET_LITERALARRAYOPTIONS()	Getter for LITERALARRAYOPTIONS

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.

Accessible with the following methods

Method	Description
GET_TEXTARRAYOPTIONS()	Getter for TEXTARRAYOPTIONS

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.

Accessible with the following methods

Method	Description
GET_DATEARRAYOPTIONS()	Getter for DATEARRAYOPTIONS