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

Class: Aws::CloudSearchDomain::Types::SearchResponse

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

Overview

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

Instance Attribute Summary collapse

Instance Attribute Details

#facetsHash<String,Types::BucketInfo>

The requested facet information.

Returns:



631
632
633
634
635
636
637
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 631

class SearchResponse < Struct.new(
  :status,
  :hits,
  :facets,
  :stats)
  include Aws::Structure
end

#hitsTypes::Hits

The documents that match the search criteria.

Returns:



631
632
633
634
635
636
637
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 631

class SearchResponse < Struct.new(
  :status,
  :hits,
  :facets,
  :stats)
  include Aws::Structure
end

#statsHash<String,Types::FieldStats>

The requested field statistics information.

Returns:



631
632
633
634
635
636
637
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 631

class SearchResponse < Struct.new(
  :status,
  :hits,
  :facets,
  :stats)
  include Aws::Structure
end

#statusTypes::SearchStatus

The status information returned for the search request.

Returns:



631
632
633
634
635
636
637
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/types.rb', line 631

class SearchResponse < Struct.new(
  :status,
  :hits,
  :facets,
  :stats)
  include Aws::Structure
end