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

Description

Synopsis

Documentation

data TextOptions Source #

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

See: newTextOptions smart constructor.

Constructors

TextOptions'

Fields

sourceField :: Maybe Text
returnEnabled :: Maybe Bool
Whether the contents of the field can be returned in the search results.
analysisScheme :: Maybe Text
The name of an analysis scheme for a text field.
highlightEnabled :: Maybe Bool
Whether highlights can be returned for the field.
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 TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Methods (==) :: TextOptions -> TextOptions -> Bool # (/=) :: TextOptions -> TextOptions -> Bool #
Read TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Methods readsPrec :: Int -> ReadS TextOptions # readList :: ReadS [TextOptions] # readPrec :: ReadPrec TextOptions # readListPrec :: ReadPrec [TextOptions] #
Show TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Methods showsPrec :: Int -> TextOptions -> ShowS # show :: TextOptions -> String # showList :: [TextOptions] -> ShowS #
Generic TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Associated Types type Rep TextOptions :: Type -> Type # Methods from :: TextOptions -> Rep TextOptions x # to :: Rep TextOptions x -> TextOptions #
NFData TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Methods rnf :: TextOptions -> () #
Hashable TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Methods hashWithSalt :: Int -> TextOptions -> Int # hash :: TextOptions -> Int #
ToQuery TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Methods toQuery :: TextOptions -> QueryString #
FromXML TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions Methods parseXML :: [Node] -> Either String TextOptions #
type Rep TextOptions Source #
Instance details Defined in Amazonka.CloudSearch.Types.TextOptions type Rep TextOptions = D1 ('MetaData "TextOptions" "Amazonka.CloudSearch.Types.TextOptions" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "TextOptions'" '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 "analysisScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "highlightEnabled") '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))))))

newTextOptions :: TextOptions Source #

Create a value of TextOptions 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:TextOptions', textOptions_sourceField - Undocumented member.

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

$sel:analysisScheme:TextOptions', textOptions_analysisScheme - The name of an analysis scheme for a text field.

$sel:highlightEnabled:TextOptions', textOptions_highlightEnabled - Whether highlights can be returned for the field.

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

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

textOptions_sourceField :: Lens' TextOptions (Maybe Text) Source #

Undocumented member.

textOptions_returnEnabled :: Lens' TextOptions (Maybe Bool) Source #

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

textOptions_analysisScheme :: Lens' TextOptions (Maybe Text) Source #

The name of an analysis scheme for a text field.

textOptions_highlightEnabled :: Lens' TextOptions (Maybe Bool) Source #

Whether highlights can be returned for the field.

textOptions_sortEnabled :: Lens' TextOptions (Maybe Bool) Source #

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

textOptions_defaultValue :: Lens' TextOptions (Maybe Text) Source #

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