Class: Aws::CloudSearch::Types::LiteralOptions
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudSearch::Types::LiteralOptions
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudsearch/types.rb
Overview
When making an API call, you may pass LiteralOptions data as a hash:
{
default_value: "FieldValue",
source_field: "FieldName",
facet_enabled: false,
search_enabled: false,
return_enabled: false,
sort_enabled: false,
}
Options for literal field. Present if ‘IndexFieldType` specifies the field is of type `literal`. All options are enabled by default.
Instance Attribute Summary collapse
-
#default_value ⇒ String
A value to use for the field if the field isn’t specified for a document.
-
#facet_enabled ⇒ Boolean
Whether facet information can be returned for the field.
-
#return_enabled ⇒ Boolean
Whether the contents of the field can be returned in the search results.
-
#search_enabled ⇒ Boolean
Whether the contents of the field are searchable.
-
#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
#default_value ⇒ String
A value to use for the field if the field isn’t specified for a document.
2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2026 class LiteralOptions < Struct.new( :default_value, :source_field, :facet_enabled, :search_enabled, :return_enabled, :sort_enabled) include Aws::Structure end |
#facet_enabled ⇒ Boolean
Whether facet information can be returned for the field.
2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2026 class LiteralOptions < Struct.new( :default_value, :source_field, :facet_enabled, :search_enabled, :return_enabled, :sort_enabled) include Aws::Structure end |
#return_enabled ⇒ Boolean
Whether the contents of the field can be returned in the search results.
2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2026 class LiteralOptions < Struct.new( :default_value, :source_field, :facet_enabled, :search_enabled, :return_enabled, :sort_enabled) include Aws::Structure end |
#search_enabled ⇒ Boolean
Whether the contents of the field are searchable.
2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2026 class LiteralOptions < Struct.new( :default_value, :source_field, :facet_enabled, :search_enabled, :return_enabled, :sort_enabled) include Aws::Structure end |
#sort_enabled ⇒ Boolean
Whether the field can be used to sort the search results.
2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2026 class LiteralOptions < Struct.new( :default_value, :source_field, :facet_enabled, :search_enabled, :return_enabled, :sort_enabled) include Aws::Structure end |
#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`.
2026 2027 2028 2029 2030 2031 2032 2033 2034 |
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2026 class LiteralOptions < Struct.new( :default_value, :source_field, :facet_enabled, :search_enabled, :return_enabled, :sort_enabled) include Aws::Structure end |