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

Class: Aws::CloudSearchDomain::Types::SuggestModel

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

Overview

Container for the suggestion information returned in a SuggestResponse.

Instance Attribute Summary collapse

Instance Attribute Details

#foundInteger

The number of documents that were found to match the query string.

Returns:

  • (Integer)


671
672
673
674
675
676
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 671

class SuggestModel < Struct.new(
  :query,
  :found,
  :suggestions)
  include Aws::Structure
end

#queryString

The query string specified in the suggest request.

Returns:

  • (String)


671
672
673
674
675
676
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 671

class SuggestModel < Struct.new(
  :query,
  :found,
  :suggestions)
  include Aws::Structure
end

#suggestionsArray<Types::SuggestionMatch>

The documents that match the query string.

Returns:



671
672
673
674
675
676
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 671

class SuggestModel < Struct.new(
  :query,
  :found,
  :suggestions)
  include Aws::Structure
end