class Aws::CloudSearch::Types::LiteralOptions

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

@note 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,
    }

@!attribute [rw] default_value

A value to use for the field if the field isn't specified for a
document.
@return [String]

@!attribute [rw] source_field

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`.
@return [String]

@!attribute [rw] facet_enabled

Whether facet information can be returned for the field.
@return [Boolean]

@!attribute [rw] search_enabled

Whether the contents of the field are searchable.
@return [Boolean]

@!attribute [rw] return_enabled

Whether the contents of the field can be returned in the search
results.
@return [Boolean]

@!attribute [rw] sort_enabled

Whether the field can be used to sort the search results.
@return [Boolean]

Constants

SENSITIVE