amazonka-cloudsearch-domains-2.0: Amazon CloudSearch Domain SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudSearchDomains.Types.Hit

Description

 
Synopsis

Documentation

data Hit Source #

Information about a document that matches the search request.

See: newHit smart constructor.

Constructors

Hit' 

Fields

Instances

Instances details
FromJSON Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Generic Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Associated Types

type Rep Hit :: Type -> Type #

Methods

from :: Hit -> Rep Hit x #

to :: Rep Hit x -> Hit #

Read Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Show Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

showsPrec :: Int -> Hit -> ShowS #

show :: Hit -> String #

showList :: [Hit] -> ShowS #

NFData Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

rnf :: Hit -> () #

Eq Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

(==) :: Hit -> Hit -> Bool #

(/=) :: Hit -> Hit -> Bool #

Hashable Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

hashWithSalt :: Int -> Hit -> Int #

hash :: Hit -> Int #

type Rep Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

type Rep Hit = D1 ('MetaData "Hit" "Amazonka.CloudSearchDomains.Types.Hit" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "Hit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))) :*: (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newHit :: Hit Source #

Create a value of Hit 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:exprs:Hit', hit_exprs - The expressions returned from a document that matches the search request.

$sel:fields:Hit', hit_fields - The fields returned from a document that matches the search request.

$sel:highlights:Hit', hit_highlights - The highlights returned from a document that matches the search request.

$sel:id:Hit', hit_id - The document ID of a document that matches the search request.

hit_exprs :: Lens' Hit (Maybe (HashMap Text Text)) Source #

The expressions returned from a document that matches the search request.

hit_fields :: Lens' Hit (Maybe (HashMap Text [Text])) Source #

The fields returned from a document that matches the search request.

hit_highlights :: Lens' Hit (Maybe (HashMap Text Text)) Source #

The highlights returned from a document that matches the search request.

hit_id :: Lens' Hit (Maybe Text) Source #

The document ID of a document that matches the search request.