Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudSearchDomains.Types.Hit

Description

Synopsis

data Hit = Hit' {
- exprs :: Maybe (HashMap Text Text)
- id :: Maybe Text
- highlights :: Maybe (HashMap Text Text)
- fields :: Maybe (HashMap Text [Text])
}
newHit :: Hit
hit_exprs :: Lens' Hit (Maybe (HashMap Text Text))
hit_id :: Lens' Hit (Maybe Text)
hit_highlights :: Lens' Hit (Maybe (HashMap Text Text))
hit_fields :: Lens' Hit (Maybe (HashMap Text [Text]))

Documentation

data Hit Source #

Information about a document that matches the search request.

See: newHit smart constructor.

Constructors

Hit'

Fields

exprs :: Maybe (HashMap Text Text)
The expressions returned from a document that matches the search request.
id :: Maybe Text
The document ID of a document that matches the search request.
highlights :: Maybe (HashMap Text Text)
The highlights returned from a document that matches the search request.
fields :: Maybe (HashMap Text [Text])
The fields returned from a document that matches the search request.

Instances

Instances details

Eq Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods (==) :: Hit -> Hit -> Bool # (/=) :: Hit -> Hit -> Bool #
Read Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods readsPrec :: Int -> ReadS Hit # readList :: ReadS [Hit] # readPrec :: ReadPrec Hit # readListPrec :: ReadPrec [Hit] #
Show Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods showsPrec :: Int -> Hit -> ShowS # show :: Hit -> String # showList :: [Hit] -> ShowS #
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 #
NFData Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods rnf :: Hit -> () #
Hashable Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods hashWithSalt :: Int -> Hit -> Int # hash :: Hit -> Int #
FromJSON Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods parseJSON :: Value -> Parser Hit # parseJSONList :: Value -> Parser [Hit] #
type Rep Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit type Rep Hit = D1 ('MetaData "Hit" "Amazonka.CloudSearchDomains.Types.Hit" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Hit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [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:id:Hit', hit_id - The document ID of a document that matches the search request.

$sel:highlights:Hit', hit_highlights - The highlights 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.

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

The expressions 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.

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

The highlights 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.