Class: Aws::CloudSearchDomain::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudSearchDomain::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/client.rb
Overview
An API client for CloudSearchDomain. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudSearchDomain::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#search(params = {}) ⇒ Types::SearchResponse
Retrieves a list of documents that match the specified search criteria.
-
#suggest(params = {}) ⇒ Types::SuggestResponse
Retrieves autocomplete suggestions for a partial query string.
-
#upload_documents(params = {}) ⇒ Types::UploadDocumentsResponse
Posts a batch of documents to a search domain for indexing.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
314 315 316 |
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/client.rb', line 314 def initialize(*args) super end |
Instance Method Details
#search(params = {}) ⇒ Types::SearchResponse
Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:
simple
: search alltext
andtext-array
fields for the specified string. Search for phrases, individual terms, and prefixes.structured
: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.lucene
: specify search criteria using the Apache Lucene query parser syntax.dismax
: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.
For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.
The endpoint for submitting Search
requests is domain-specific. You
submit search requests to a domain's search endpoint. To get the
search endpoint for your domain, use the Amazon CloudSearch
configuration service DescribeDomains
action. A domain's endpoints
are also displayed on the domain dashboard in the Amazon CloudSearch
console.
769 770 771 772 |
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/client.rb', line 769 def search(params = {}, = {}) req = build_request(:search, params) req.send_request() end |
#suggest(params = {}) ⇒ Types::SuggestResponse
Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.
For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.
The endpoint for submitting Suggest
requests is domain-specific. You
submit suggest requests to a domain's search endpoint. To get the
search endpoint for your domain, use the Amazon CloudSearch
configuration service DescribeDomains
action. A domain's endpoints
are also displayed on the domain dashboard in the Amazon CloudSearch
console.
832 833 834 835 |
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/client.rb', line 832 def suggest(params = {}, = {}) req = build_request(:suggest, params) req.send_request() end |
#upload_documents(params = {}) ⇒ Types::UploadDocumentsResponse
Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.
The endpoint for submitting UploadDocuments
requests is
domain-specific. To get the document endpoint for your domain, use the
Amazon CloudSearch configuration service DescribeDomains
action. A
domain's endpoints are also displayed on the domain dashboard in the
Amazon CloudSearch console.
For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.
901 902 903 904 |
# File 'gems/aws-sdk-cloudsearchdomain/lib/aws-sdk-cloudsearchdomain/client.rb', line 901 def upload_documents(params = {}, = {}) req = build_request(:upload_documents, params) req.send_request() end |