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.Hits

Description

Synopsis

data Hits = Hits' {
- cursor :: Maybe Text
- hit :: Maybe [Hit]
- start :: Maybe Integer
- found :: Maybe Integer
}
newHits :: Hits
hits_cursor :: Lens' Hits (Maybe Text)
hits_hit :: Lens' Hits (Maybe [Hit])
hits_start :: Lens' Hits (Maybe Integer)
hits_found :: Lens' Hits (Maybe Integer)

Documentation

data Hits Source #

The collection of documents that match the search request.

See: newHits smart constructor.

Constructors

Hits'
Fields cursor :: Maybe Text A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set. hit :: Maybe [Hit] A document that matches the search request. start :: Maybe Integer The index of the first matching document. found :: Maybe Integer The total number of documents that match the search request.

Instances

Instances details

Eq Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods (==) :: Hits -> Hits -> Bool # (/=) :: Hits -> Hits -> Bool #
Read Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods readsPrec :: Int -> ReadS Hits # readList :: ReadS [Hits] # readPrec :: ReadPrec Hits # readListPrec :: ReadPrec [Hits] #
Show Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods showsPrec :: Int -> Hits -> ShowS # show :: Hits -> String # showList :: [Hits] -> ShowS #
Generic Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Associated Types type Rep Hits :: Type -> Type # Methods from :: Hits -> Rep Hits x # to :: Rep Hits x -> Hits #
NFData Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods rnf :: Hits -> () #
Hashable Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods hashWithSalt :: Int -> Hits -> Int # hash :: Hits -> Int #
FromJSON Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods parseJSON :: Value -> Parser Hits # parseJSONList :: Value -> Parser [Hits] #
type Rep Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits type Rep Hits = D1 ('MetaData "Hits" "Amazonka.CloudSearchDomains.Types.Hits" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Hits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Hit]))) :: (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "found") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newHits :: Hits Source #

Create a value of Hits 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:cursor:Hits', hits_cursor - A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

$sel:hit:Hits', hits_hit - A document that matches the search request.

$sel:start:Hits', hits_start - The index of the first matching document.

$sel:found:Hits', hits_found - The total number of documents that match the search request.

hits_cursor :: Lens' Hits (Maybe Text) Source #

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

hits_hit :: Lens' Hits (Maybe [Hit]) Source #

A document that matches the search request.

hits_start :: Lens' Hits (Maybe Integer) Source #

The index of the first matching document.

hits_found :: Lens' Hits (Maybe Integer) Source #

The total number of documents that match the search request.