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

Class: Aws::CloudSearchDomain::Types::SuggestRequest

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

Overview

Note:

When making an API call, you may pass SuggestRequest data as a hash:

{
  query: "Query", # required
  suggester: "Suggester", # required
  size: 1,
}

Container for the parameters to the Suggest request.

Instance Attribute Summary collapse

Instance Attribute Details

#queryString

Specifies the string for which you want to get suggestions.

Returns:

  • (String)


702
703
704
705
706
707
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 702

class SuggestRequest < Struct.new(
  :query,
  :suggester,
  :size)
  include Aws::Structure
end

#sizeInteger

Specifies the maximum number of suggestions to return.

Returns:

  • (Integer)


702
703
704
705
706
707
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 702

class SuggestRequest < Struct.new(
  :query,
  :suggester,
  :size)
  include Aws::Structure
end

#suggesterString

Specifies the name of the suggester to use to find suggested matches.

Returns:

  • (String)


702
703
704
705
706
707
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 702

class SuggestRequest < Struct.new(
  :query,
  :suggester,
  :size)
  include Aws::Structure
end