You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudSearch::Types::TextOptions
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudSearch::Types::TextOptions
- Defined in:
- (unknown)
Overview
When passing TextOptions as input to an Aws::Client method, you can use a vanilla Hash:
{
default_value: "FieldValue",
source_field: "FieldName",
return_enabled: false,
sort_enabled: false,
highlight_enabled: false,
analysis_scheme: "Word",
}
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.
Returned by:
Instance Attribute Summary collapse
-
#analysis_scheme ⇒ String
The name of an analysis scheme for a
text
field. -
#default_value ⇒ String
A value to use for the field if the field isn\'t specified for a document.
-
#highlight_enabled ⇒ Boolean
Whether highlights can be returned for the field.
-
#return_enabled ⇒ Boolean
Whether the contents of the field can be returned in the search results.
-
#sort_enabled ⇒ Boolean
Whether the field can be used to sort the search results.
-
#source_field ⇒ String
A string that represents the name of an index field.
Instance Attribute Details
#analysis_scheme ⇒ String
The name of an analysis scheme for a text
field.
#default_value ⇒ String
A value to use for the field if the field isn\'t specified for a document.
#highlight_enabled ⇒ Boolean
Whether highlights can be returned for the field.
#return_enabled ⇒ Boolean
Whether the contents of the field can be returned in the search results.
#sort_enabled ⇒ Boolean
Whether the field can be used to sort the search results.
#source_field ⇒ String
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
.