libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudSearch.Types.TextArrayOptions

Description

 
Synopsis

Documentation

data TextArrayOptions Source #

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

See: newTextArrayOptions smart constructor.

Constructors

TextArrayOptions' 

Fields

Instances

Instances details
Eq TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

Read TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

Show TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

Generic TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

Associated Types

type Rep TextArrayOptions :: Type -> Type #

NFData TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

Methods

rnf :: TextArrayOptions -> () #

Hashable TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

ToQuery TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

FromXML TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

type Rep TextArrayOptions Source # 
Instance details

Defined in Amazonka.CloudSearch.Types.TextArrayOptions

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

newTextArrayOptions :: TextArrayOptions Source #

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

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

$sel:analysisScheme:TextArrayOptions', textArrayOptions_analysisScheme - The name of an analysis scheme for a text-array field.

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

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

textArrayOptions_sourceFields :: Lens' TextArrayOptions (Maybe Text) Source #

A list of source fields to map to the field.

textArrayOptions_returnEnabled :: Lens' TextArrayOptions (Maybe Bool) Source #

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

textArrayOptions_analysisScheme :: Lens' TextArrayOptions (Maybe Text) Source #

The name of an analysis scheme for a text-array field.

textArrayOptions_highlightEnabled :: Lens' TextArrayOptions (Maybe Bool) Source #

Whether highlights can be returned for the field.

textArrayOptions_defaultValue :: Lens' TextArrayOptions (Maybe Text) Source #

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