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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-cloudsearchdomain/types.rb

Overview

The collection of documents that match the search request.

Constant Summary

SENSITIVE =

[]

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)

# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 205

class Hits < Struct.new(
  :found,
  :start,
  :cursor,
  :hit)
  SENSITIVE = []
  include Aws::Structure
end

#found ⇒ Integer

The total number of documents that match the search request.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 205

class Hits < Struct.new(
  :found,
  :start,
  :cursor,
  :hit)
  SENSITIVE = []
  include Aws::Structure
end

#hit ⇒ Array<Types::Hit>

A document that matches the search request.

Returns:

• (Array<Types::Hit>)

# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 205

class Hits < Struct.new(
  :found,
  :start,
  :cursor,
  :hit)
  SENSITIVE = []
  include Aws::Structure
end

#start ⇒ Integer

The index of the first matching document.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 205

class Hits < Struct.new(
  :found,
  :start,
  :cursor,
  :hit)
  SENSITIVE = []
  include Aws::Structure
end