You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

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)


182
183
184
185
186
187
188
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 182

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

#foundInteger

The total number of documents that match the search request.

Returns:

  • (Integer)


182
183
184
185
186
187
188
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 182

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

#hitArray<Types::Hit>

A document that matches the search request.

Returns:



182
183
184
185
186
187
188
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 182

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

#startInteger

The index of the first matching document.

Returns:

  • (Integer)


182
183
184
185
186
187
188
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 182

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