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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb

Overview

The collection of documents that match the search request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cursorString

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)


208
209
210
211
212
213
214
215
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 208

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

#foundInteger

The total number of documents that match the search request.

Returns:

  • (Integer)


208
209
210
211
212
213
214
215
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 208

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

#hitArray<Types::Hit>

A document that matches the search request.

Returns:



208
209
210
211
212
213
214
215
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 208

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

#startInteger

The index of the first matching document.

Returns:

  • (Integer)


208
209
210
211
212
213
214
215
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 208

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