You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudSearch::Types::TextArrayOptions
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudSearch::Types::TextArrayOptions
- Defined in:
- (unknown)
Overview
When passing TextArrayOptions as input to an Aws::Client method, you can use a vanilla Hash:
{
default_value: "FieldValue",
source_fields: "FieldNameCommaList",
return_enabled: false,
highlight_enabled: false,
analysis_scheme: "Word",
}
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.
Returned by:
Instance Attribute Summary collapse
-
#analysis_scheme ⇒ String
The name of an analysis scheme for a
text-array
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.
-
#source_fields ⇒ String
A list of source fields to map to the field.
Instance Attribute Details
#analysis_scheme ⇒ String
The name of an analysis scheme for a text-array
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.
#source_fields ⇒ String
A list of source fields to map to the field.