Amazonka.CloudSearch.Types.TextOptions

Documentation

data TextOptions

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

• analysisScheme :: Maybe Text

  The name of an analysis scheme for a text field.

• defaultValue :: Maybe Text

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

• highlightEnabled :: Maybe Bool

  Whether highlights can be returned for the field.

• returnEnabled :: Maybe Bool

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

• sortEnabled :: Maybe Bool

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

• sourceField :: Maybe Text

Instances

ToQuery TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Methods

toQuery :: TextOptions -> QueryString

FromXML TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Methods

parseXML :: [Node] -> Either String TextOptions

Generic TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Associated Types

type Rep TextOptions :: Type -> Type

Methods

from :: TextOptions -> Rep TextOptions x

to :: Rep TextOptions x -> TextOptions

Read TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Methods

readsPrec :: Int -> ReadS TextOptions

readList :: ReadS [TextOptions]

readPrec :: ReadPrec TextOptions

readListPrec :: ReadPrec [TextOptions]

Show TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Methods

showsPrec :: Int -> TextOptions -> ShowS

show :: TextOptions -> String

showList :: [TextOptions] -> ShowS

NFData TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Methods

rnf :: TextOptions -> ()

Eq TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Methods

(==) :: TextOptions -> TextOptions -> Bool

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

Hashable TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

Methods

hashWithSalt :: Int -> TextOptions -> Int

hash :: TextOptions -> Int

type Rep TextOptions

Defined in Amazonka.CloudSearch.Types.TextOptions

type Rep TextOptions = D1 ('MetaData "TextOptions" "Amazonka.CloudSearch.Types.TextOptions" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "TextOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analysisScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "highlightEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "returnEnabled") '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))))))

newTextOptions :: TextOptions

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:analysisScheme:TextOptions', textOptions_analysisScheme - The name of an analysis scheme for a text field.

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

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

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

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

$sel:sourceField:TextOptions', textOptions_sourceField - Undocumented member.

textOptions_analysisScheme :: Lens' TextOptions (Maybe Text)

The name of an analysis scheme for a text field.

textOptions_defaultValue :: Lens' TextOptions (Maybe Text)

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

textOptions_highlightEnabled :: Lens' TextOptions (Maybe Bool)

Whether highlights can be returned for the field.

textOptions_returnEnabled :: Lens' TextOptions (Maybe Bool)

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

textOptions_sortEnabled :: Lens' TextOptions (Maybe Bool)

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

textOptions_sourceField :: Lens' TextOptions (Maybe Text)

Undocumented member.