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

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

Overview

Container for the suggestion information returned in a ‘SuggestResponse`.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#foundInteger

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

Returns:

  • (Integer)


691
692
693
694
695
696
697
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 691

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

#queryString

The query string specified in the suggest request.

Returns:

  • (String)


691
692
693
694
695
696
697
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 691

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

#suggestionsArray<Types::SuggestionMatch>

The documents that match the query string.

Returns:



691
692
693
694
695
696
697
# File 'lib/aws-sdk-cloudsearchdomain/types.rb', line 691

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