Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudSearch.Types.LiteralOptions

Description

Documentation

data LiteralOptions Source #

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

sourceField :: Maybe Text
returnEnabled :: Maybe Bool
Whether the contents of the field can be returned in the search results.
facetEnabled :: Maybe Bool
Whether facet information can be returned for the field.
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.
defaultValue :: Maybe Text
A value to use for the field if the field isn't specified for a document.

Instances

Instances details

Eq LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Methods (==) :: LiteralOptions -> LiteralOptions -> Bool # (/=) :: LiteralOptions -> LiteralOptions -> Bool #
Read LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Methods readsPrec :: Int -> ReadS LiteralOptions # readList :: ReadS [LiteralOptions] # readPrec :: ReadPrec LiteralOptions # readListPrec :: ReadPrec [LiteralOptions] #
Show LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Methods showsPrec :: Int -> LiteralOptions -> ShowS # show :: LiteralOptions -> String # showList :: [LiteralOptions] -> ShowS #
Generic LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Associated Types type Rep LiteralOptions :: Type -> Type # Methods from :: LiteralOptions -> Rep LiteralOptions x # to :: Rep LiteralOptions x -> LiteralOptions #
NFData LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Methods rnf :: LiteralOptions -> () #
Hashable LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Methods hashWithSalt :: Int -> LiteralOptions -> Int # hash :: LiteralOptions -> Int #
ToQuery LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Methods toQuery :: LiteralOptions -> QueryString #
FromXML LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions Methods parseXML :: [Node] -> Either String LiteralOptions #
type Rep LiteralOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.LiteralOptions type Rep LiteralOptions = D1 ('MetaData "LiteralOptions" "Amazonka.CloudSearch.Types.LiteralOptions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "LiteralOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "returnEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "facetEnabled") '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 "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newLiteralOptions :: LiteralOptions Source #

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:sourceField:LiteralOptions', literalOptions_sourceField - Undocumented member.

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

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

$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:defaultValue:LiteralOptions', literalOptions_defaultValue - A value to use for the field if the field isn't specified for a document.

literalOptions_sourceField :: Lens' LiteralOptions (Maybe Text) Source #

Undocumented member.

literalOptions_returnEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

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

literalOptions_facetEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

literalOptions_searchEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

literalOptions_sortEnabled :: Lens' LiteralOptions (Maybe Bool) Source #

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

literalOptions_defaultValue :: Lens' LiteralOptions (Maybe Text) Source #

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