libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains
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.CloudSearchDomains.Types.SuggestModel

Description

 
Synopsis

Documentation

data SuggestModel Source #

Container for the suggestion information returned in a SuggestResponse.

See: newSuggestModel smart constructor.

Constructors

SuggestModel' 

Fields

Instances

Instances details
Eq SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Read SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Show SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Generic SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Associated Types

type Rep SuggestModel :: Type -> Type #

NFData SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

rnf :: SuggestModel -> () #

Hashable SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

FromJSON SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

type Rep SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

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

newSuggestModel :: SuggestModel Source #

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:suggestions:SuggestModel', suggestModel_suggestions - The documents that match the query string.

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

suggestModel_found :: Lens' SuggestModel (Maybe Integer) Source #

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

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

The documents that match the query string.

suggestModel_query :: Lens' SuggestModel (Maybe Text) Source #

The query string specified in the suggest request.