C# Class Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient

Inheritance: AmazonServiceClient

Mostra file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method	Description
BeginSearch ( SearchRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the Search operation.
BeginSuggest ( SuggestRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the Suggest operation.
BeginUploadDocuments ( UploadDocumentsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the UploadDocuments operation.
EndSearch ( IAsyncResult asyncResult ) : SearchResponse	Finishes the asynchronous execution of the Search operation.
EndSuggest ( IAsyncResult asyncResult ) : SuggestResponse	Finishes the asynchronous execution of the Suggest operation.
EndUploadDocuments ( IAsyncResult asyncResult ) : UploadDocumentsResponse	Finishes the asynchronous execution of the UploadDocuments operation.
Search ( SearchRequest request ) : 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 all `text` and `text-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.
SearchAsync ( SearchRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the Search operation.
Suggest ( SuggestRequest request ) : 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.
SuggestAsync ( SuggestRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the Suggest operation.
UploadDocuments ( UploadDocumentsRequest request ) : 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.
UploadDocumentsAsync ( UploadDocumentsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the UploadDocuments operation.

Protected Methods

Method	Description
CreateSigner ( ) : AbstractAWSSigner	Creates the signer for the service.
CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void	Customize the pipeline
Dispose ( bool disposing ) : void	Disposes the service client.

Method Details

BeginSearch() public method

Initiates the asynchronous execution of the Search operation.

public BeginSearch ( SearchRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	SearchRequest	Container for the necessary parameters to execute the Search operation on AmazonCloudSearchDomainClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginSuggest() public method

Initiates the asynchronous execution of the Suggest operation.

public BeginSuggest ( SuggestRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	SuggestRequest	Container for the necessary parameters to execute the Suggest operation on AmazonCloudSearchDomainClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginUploadDocuments() public method

Initiates the asynchronous execution of the UploadDocuments operation.

public BeginUploadDocuments ( UploadDocumentsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	UploadDocumentsRequest	Container for the necessary parameters to execute the UploadDocuments operation on AmazonCloudSearchDomainClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

CreateSigner() protected method

Creates the signer for the service.

protected CreateSigner ( ) : AbstractAWSSigner
return	AbstractAWSSigner

CustomizeRuntimePipeline() protected method

Customize the pipeline

protected CustomizeRuntimePipeline ( RuntimePipeline pipeline ) : void
pipeline	RuntimePipeline
return	void

Dispose() protected method

Disposes the service client.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

EndSearch() public method

Finishes the asynchronous execution of the Search operation.

public EndSearch ( IAsyncResult asyncResult ) : SearchResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginSearch.
return	SearchResponse

EndSuggest() public method

Finishes the asynchronous execution of the Suggest operation.

public EndSuggest ( IAsyncResult asyncResult ) : SuggestResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginSuggest.
return	SuggestResponse

EndUploadDocuments() public method

Finishes the asynchronous execution of the UploadDocuments operation.

public EndUploadDocuments ( IAsyncResult asyncResult ) : UploadDocumentsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginUploadDocuments.
return	UploadDocumentsResponse

Search() public method

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 all text and text-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.

/// Information about any problems encountered while processing a search request. ///

public Search ( SearchRequest request ) : SearchResponse
request	SearchRequest	Container for the necessary parameters to execute the Search service method.
return	SearchResponse

SearchAsync() public method

Initiates the asynchronous execution of the Search operation.

public SearchAsync ( SearchRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	SearchRequest	Container for the necessary parameters to execute the Search operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

Suggest() public method

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.

/// Information about any problems encountered while processing a search request. ///

public Suggest ( SuggestRequest request ) : SuggestResponse
request	SuggestRequest	Container for the necessary parameters to execute the Suggest service method.
return	SuggestResponse

SuggestAsync() public method

Initiates the asynchronous execution of the Suggest operation.

public SuggestAsync ( SuggestRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	SuggestRequest	Container for the necessary parameters to execute the Suggest operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

UploadDocuments() public method

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.

/// Information about any problems encountered while processing an upload request. ///

public UploadDocuments ( UploadDocumentsRequest request ) : UploadDocumentsResponse
request	UploadDocumentsRequest	Container for the necessary parameters to execute the UploadDocuments service method.
return	UploadDocumentsResponse

UploadDocumentsAsync() public method

Initiates the asynchronous execution of the UploadDocuments operation.

public UploadDocumentsAsync ( UploadDocumentsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	UploadDocumentsRequest	Container for the necessary parameters to execute the UploadDocuments operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task