Amazonka.CloudSearchDomains.Types.Hits

Documentation

data Hits

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.

• found :: Maybe Integer

  The total number of documents that match the search request.

• hit :: Maybe [Hit]

  A document that matches the search request.

• start :: Maybe Integer

  The index of the first matching document.

Instances

FromJSON Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

parseJSON :: Value -> Parser Hits

parseJSONList :: Value -> Parser [Hits]

Generic Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

Associated Types

type Rep Hits :: Type -> Type

Methods

from :: Hits -> Rep Hits x

to :: Rep Hits x -> Hits

Read Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

readsPrec :: Int -> ReadS Hits

readList :: ReadS [Hits]

readPrec :: ReadPrec Hits

readListPrec :: ReadPrec [Hits]

Show Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

showsPrec :: Int -> Hits -> ShowS

show :: Hits -> String

showList :: [Hits] -> ShowS

NFData Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

rnf :: Hits -> ()

Eq Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

(==) :: Hits -> Hits -> Bool

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

Hashable Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

hashWithSalt :: Int -> Hits -> Int

hash :: Hits -> Int

type Rep Hits

Defined in Amazonka.CloudSearchDomains.Types.Hits

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

newHits :: Hits

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:found:Hits', hits_found - The total number of documents that match the search request.

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

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

hits_cursor :: Lens' Hits (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.

hits_found :: Lens' Hits (Maybe Integer)

The total number of documents that match the search request.

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

A document that matches the search request.

hits_start :: Lens' Hits (Maybe Integer)

The index of the first matching document.