/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.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_defaultvalue TYPE /AWS1/SRHFIELDVALUE /AWS1/SRHFIELDVALUE¶
A value to use for the field if the field isn't specified for a document.
iv_sourcefield TYPE /AWS1/SRHFIELDNAME /AWS1/SRHFIELDNAME¶
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
scoreis reserved and cannot be used as a field name. To reference a document's ID, you can use the name_id.
iv_returnenabled TYPE /AWS1/SRHBOOLEAN /AWS1/SRHBOOLEAN¶
Whether the contents of the field can be returned in the search results.
iv_sortenabled TYPE /AWS1/SRHBOOLEAN /AWS1/SRHBOOLEAN¶
Whether the field can be used to sort the search results.
iv_highlightenabled TYPE /AWS1/SRHBOOLEAN /AWS1/SRHBOOLEAN¶
Whether highlights can be returned for the field.
iv_analysisscheme TYPE /AWS1/SRHWORD /AWS1/SRHWORD¶
The name of an analysis scheme for a
textfield.
Queryable Attributes¶
DefaultValue¶
A value to use for the field if the field isn't specified for a document.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTVALUE() |
Getter for DEFAULTVALUE, with configurable default |
ASK_DEFAULTVALUE() |
Getter for DEFAULTVALUE w/ exceptions if field has no value |
HAS_DEFAULTVALUE() |
Determine if DEFAULTVALUE has a value |
SourceField¶
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
scoreis 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_SOURCEFIELD() |
Getter for SOURCEFIELD, with configurable default |
ASK_SOURCEFIELD() |
Getter for SOURCEFIELD w/ exceptions if field has no value |
HAS_SOURCEFIELD() |
Determine if SOURCEFIELD has a value |
ReturnEnabled¶
Whether the contents of the field can be returned in the search results.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETURNENABLED() |
Getter for RETURNENABLED, with configurable default |
ASK_RETURNENABLED() |
Getter for RETURNENABLED w/ exceptions if field has no value |
HAS_RETURNENABLED() |
Determine if RETURNENABLED has a value |
SortEnabled¶
Whether the field can be used to sort the search results.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SORTENABLED() |
Getter for SORTENABLED, with configurable default |
ASK_SORTENABLED() |
Getter for SORTENABLED w/ exceptions if field has no value |
HAS_SORTENABLED() |
Determine if SORTENABLED has a value |
HighlightEnabled¶
Whether highlights can be returned for the field.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HIGHLIGHTENABLED() |
Getter for HIGHLIGHTENABLED, with configurable default |
ASK_HIGHLIGHTENABLED() |
Getter for HIGHLIGHTENABLED w/ exceptions if field has no va |
HAS_HIGHLIGHTENABLED() |
Determine if HIGHLIGHTENABLED has a value |
AnalysisScheme¶
The name of an analysis scheme for a
textfield.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ANALYSISSCHEME() |
Getter for ANALYSISSCHEME, with configurable default |
ASK_ANALYSISSCHEME() |
Getter for ANALYSISSCHEME w/ exceptions if field has no valu |
HAS_ANALYSISSCHEME() |
Determine if ANALYSISSCHEME has a value |