Amazonka.CloudSearchDomains.Types.SuggestModel

Documentation

data SuggestModel

Container for the suggestion information returned in a SuggestResponse.

See: newSuggestModel smart constructor.

Constructors

SuggestModel'

Fields

• found :: Maybe Integer

  The number of documents that were found to match the query string.

• query :: Maybe Text

  The query string specified in the suggest request.

• suggestions :: Maybe [SuggestionMatch]

  The documents that match the query string.

Instances

FromJSON SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

parseJSON :: Value -> Parser SuggestModel

parseJSONList :: Value -> Parser [SuggestModel]

Generic SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Associated Types

type Rep SuggestModel :: Type -> Type

Methods

from :: SuggestModel -> Rep SuggestModel x

to :: Rep SuggestModel x -> SuggestModel

Read SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

readsPrec :: Int -> ReadS SuggestModel

readList :: ReadS [SuggestModel]

readPrec :: ReadPrec SuggestModel

readListPrec :: ReadPrec [SuggestModel]

Show SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

showsPrec :: Int -> SuggestModel -> ShowS

show :: SuggestModel -> String

showList :: [SuggestModel] -> ShowS

NFData SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

rnf :: SuggestModel -> ()

Eq SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

(==) :: SuggestModel -> SuggestModel -> Bool

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

Hashable SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

hashWithSalt :: Int -> SuggestModel -> Int

hash :: SuggestModel -> Int

type Rep SuggestModel

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

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

newSuggestModel :: SuggestModel

Create a value of SuggestModel 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:found:SuggestModel', suggestModel_found - The number of documents that were found to match the query string.

$sel:query:SuggestModel', suggestModel_query - The query string specified in the suggest request.

$sel:suggestions:SuggestModel', suggestModel_suggestions - The documents that match the query string.

suggestModel_found :: Lens' SuggestModel (Maybe Integer)

The number of documents that were found to match the query string.

suggestModel_query :: Lens' SuggestModel (Maybe Text)

The query string specified in the suggest request.

suggestModel_suggestions :: Lens' SuggestModel (Maybe [SuggestionMatch])

The documents that match the query string.