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.LiteralArrayOptions

Description

Documentation

data LiteralArrayOptions Source #

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

See: newLiteralArrayOptions smart constructor.

Constructors

LiteralArrayOptions'

Fields

sourceFields :: Maybe Text
A list of source fields to map to the field.
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.
defaultValue :: Maybe Text
A value to use for the field if the field isn't specified for a document.

Instances

Instances details

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

newLiteralArrayOptions :: LiteralArrayOptions Source #

Create a value of LiteralArrayOptions 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:sourceFields:LiteralArrayOptions', literalArrayOptions_sourceFields - A list of source fields to map to the field.

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

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

$sel:searchEnabled:LiteralArrayOptions', literalArrayOptions_searchEnabled - Whether the contents of the field are searchable.

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

literalArrayOptions_sourceFields :: Lens' LiteralArrayOptions (Maybe Text) Source #

A list of source fields to map to the field.

literalArrayOptions_returnEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #

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

literalArrayOptions_facetEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #

Whether facet information can be returned for the field.

literalArrayOptions_searchEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #

Whether the contents of the field are searchable.

literalArrayOptions_defaultValue :: Lens' LiteralArrayOptions (Maybe Text) Source #

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