Class: Aws::CloudSearchDomain::Types::Hits

Inherits:

Struct

• Object
• Struct
• Aws::CloudSearchDomain::Types::Hits

Defined in:

(unknown)

Overview

The collection of documents that match the search request.

Returned by:

• SearchResponse#hits

Instance Attribute Summary

• #cursor ⇒ String

  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 ⇒ Integer

  The total number of documents that match the search request.

• #hit ⇒ Array<Types::Hit>

  A document that matches the search request.

• #start ⇒ Integer

  The index of the first matching document.

Instance Attribute Details

#cursor ⇒ String

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

Returns:

• (String) —

  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 ⇒ Integer

The total number of documents that match the search request.

Returns:

• (Integer) —

  The total number of documents that match the search request.

#hit ⇒ Array<Types::Hit>

A document that matches the search request.

Returns:

• (Array<Types::Hit>) —

  A document that matches the search request.

#start ⇒ Integer

The index of the first matching document.

Returns:

• (Integer) —

  The index of the first matching document.