Amazonka.CloudSearch.Types.LiteralArrayOptions

Documentation

data LiteralArrayOptions

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

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

• sourceFields :: Maybe Text

  A list of source fields to map to the field.

Instances

ToQuery LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Methods

toQuery :: LiteralArrayOptions -> QueryString

FromXML LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Methods

parseXML :: [Node] -> Either String LiteralArrayOptions

Generic LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Associated Types

type Rep LiteralArrayOptions :: Type -> Type

Methods

from :: LiteralArrayOptions -> Rep LiteralArrayOptions x

to :: Rep LiteralArrayOptions x -> LiteralArrayOptions

Read LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Methods

readsPrec :: Int -> ReadS LiteralArrayOptions

readList :: ReadS [LiteralArrayOptions]

readPrec :: ReadPrec LiteralArrayOptions

readListPrec :: ReadPrec [LiteralArrayOptions]

Show LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Methods

showsPrec :: Int -> LiteralArrayOptions -> ShowS

show :: LiteralArrayOptions -> String

showList :: [LiteralArrayOptions] -> ShowS

NFData LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Methods

rnf :: LiteralArrayOptions -> ()

Eq LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Methods

(==) :: LiteralArrayOptions -> LiteralArrayOptions -> Bool

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

Hashable LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

Methods

hashWithSalt :: Int -> LiteralArrayOptions -> Int

hash :: LiteralArrayOptions -> Int

type Rep LiteralArrayOptions

Defined in Amazonka.CloudSearch.Types.LiteralArrayOptions

type Rep LiteralArrayOptions = D1 ('MetaData "LiteralArrayOptions" "Amazonka.CloudSearch.Types.LiteralArrayOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "LiteralArrayOptions'" '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 "sourceFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newLiteralArrayOptions :: LiteralArrayOptions

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

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

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

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

$sel:sourceFields:LiteralArrayOptions', literalArrayOptions_sourceFields - A list of source fields to map to the field.

literalArrayOptions_defaultValue :: Lens' LiteralArrayOptions (Maybe Text)

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

literalArrayOptions_facetEnabled :: Lens' LiteralArrayOptions (Maybe Bool)

Whether facet information can be returned for the field.

literalArrayOptions_returnEnabled :: Lens' LiteralArrayOptions (Maybe Bool)

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

literalArrayOptions_searchEnabled :: Lens' LiteralArrayOptions (Maybe Bool)

Whether the contents of the field are searchable.

literalArrayOptions_sourceFields :: Lens' LiteralArrayOptions (Maybe Text)

A list of source fields to map to the field.