Amazonka.CloudSearchDomains.Types.SuggestionMatch

Documentation

data SuggestionMatch

An autocomplete suggestion that matches the query string specified in a SuggestRequest.

See: newSuggestionMatch smart constructor.

Constructors

SuggestionMatch'

Fields

• id :: Maybe Text

  The document ID of the suggested document.

• score :: Maybe Integer

  The relevance score of a suggested match.

• suggestion :: Maybe Text

  The string that matches the query string specified in the SuggestRequest.

Instances

FromJSON SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Methods

parseJSON :: Value -> Parser SuggestionMatch

parseJSONList :: Value -> Parser [SuggestionMatch]

Generic SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Associated Types

type Rep SuggestionMatch :: Type -> Type

Methods

from :: SuggestionMatch -> Rep SuggestionMatch x

to :: Rep SuggestionMatch x -> SuggestionMatch

Read SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Methods

readsPrec :: Int -> ReadS SuggestionMatch

readList :: ReadS [SuggestionMatch]

readPrec :: ReadPrec SuggestionMatch

readListPrec :: ReadPrec [SuggestionMatch]

Show SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Methods

showsPrec :: Int -> SuggestionMatch -> ShowS

show :: SuggestionMatch -> String

showList :: [SuggestionMatch] -> ShowS

NFData SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Methods

rnf :: SuggestionMatch -> ()

Eq SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Methods

(==) :: SuggestionMatch -> SuggestionMatch -> Bool

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

Hashable SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Methods

hashWithSalt :: Int -> SuggestionMatch -> Int

hash :: SuggestionMatch -> Int

type Rep SuggestionMatch

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

type Rep SuggestionMatch = D1 ('MetaData "SuggestionMatch" "Amazonka.CloudSearchDomains.Types.SuggestionMatch" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "SuggestionMatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "suggestion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSuggestionMatch :: SuggestionMatch

Create a value of SuggestionMatch 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:id:SuggestionMatch', suggestionMatch_id - The document ID of the suggested document.

$sel:score:SuggestionMatch', suggestionMatch_score - The relevance score of a suggested match.

$sel:suggestion:SuggestionMatch', suggestionMatch_suggestion - The string that matches the query string specified in the SuggestRequest.

suggestionMatch_id :: Lens' SuggestionMatch (Maybe Text)

The document ID of the suggested document.

suggestionMatch_score :: Lens' SuggestionMatch (Maybe Integer)

The relevance score of a suggested match.

suggestionMatch_suggestion :: Lens' SuggestionMatch (Maybe Text)

The string that matches the query string specified in the SuggestRequest.