Amazonka.CloudSearch.Types.LiteralOptions

Documentation

data LiteralOptions

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

See: newLiteralOptions smart constructor.

Constructors

LiteralOptions'

Fields

• defaultValue :: Maybe Text

  A value to use for the field if the field isn't specified for a document.

• facetEnabled :: Maybe Bool

  Whether facet information can be returned for the field.

• returnEnabled :: Maybe Bool

  Whether the contents of the field can be returned in the search results.

• searchEnabled :: Maybe Bool

  Whether the contents of the field are searchable.

• sortEnabled :: Maybe Bool

  Whether the field can be used to sort the search results.

• sourceField :: Maybe Text

Instances

ToQuery LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Methods

toQuery :: LiteralOptions -> QueryString

FromXML LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Methods

parseXML :: [Node] -> Either String LiteralOptions

Generic LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Associated Types

type Rep LiteralOptions :: Type -> Type

Methods

from :: LiteralOptions -> Rep LiteralOptions x

to :: Rep LiteralOptions x -> LiteralOptions

Read LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Methods

readsPrec :: Int -> ReadS LiteralOptions

readList :: ReadS [LiteralOptions]

readPrec :: ReadPrec LiteralOptions

readListPrec :: ReadPrec [LiteralOptions]

Show LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Methods

showsPrec :: Int -> LiteralOptions -> ShowS

show :: LiteralOptions -> String

showList :: [LiteralOptions] -> ShowS

NFData LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Methods

rnf :: LiteralOptions -> ()

Eq LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Methods

(==) :: LiteralOptions -> LiteralOptions -> Bool

(/=) :: LiteralOptions -> LiteralOptions -> Bool

Hashable LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

Methods

hashWithSalt :: Int -> LiteralOptions -> Int

hash :: LiteralOptions -> Int

type Rep LiteralOptions

Defined in Amazonka.CloudSearch.Types.LiteralOptions

type Rep LiteralOptions = D1 ('MetaData "LiteralOptions" "Amazonka.CloudSearch.Types.LiteralOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "LiteralOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "facetEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "returnEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "searchEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sortEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sourceField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newLiteralOptions :: LiteralOptions

Create a value of LiteralOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultValue:LiteralOptions', literalOptions_defaultValue - A value to use for the field if the field isn't specified for a document.

$sel:facetEnabled:LiteralOptions', literalOptions_facetEnabled - Whether facet information can be returned for the field.

$sel:returnEnabled:LiteralOptions', literalOptions_returnEnabled - Whether the contents of the field can be returned in the search results.

$sel:searchEnabled:LiteralOptions', literalOptions_searchEnabled - Whether the contents of the field are searchable.

$sel:sortEnabled:LiteralOptions', literalOptions_sortEnabled - Whether the field can be used to sort the search results.

$sel:sourceField:LiteralOptions', literalOptions_sourceField - Undocumented member.

literalOptions_defaultValue :: Lens' LiteralOptions (Maybe Text)

A value to use for the field if the field isn't specified for a document.

literalOptions_facetEnabled :: Lens' LiteralOptions (Maybe Bool)

Whether facet information can be returned for the field.

literalOptions_returnEnabled :: Lens' LiteralOptions (Maybe Bool)

Whether the contents of the field can be returned in the search results.

literalOptions_searchEnabled :: Lens' LiteralOptions (Maybe Bool)

Whether the contents of the field are searchable.

literalOptions_sortEnabled :: Lens' LiteralOptions (Maybe Bool)

Whether the field can be used to sort the search results.

literalOptions_sourceField :: Lens' LiteralOptions (Maybe Text)

Undocumented member.