pub struct CloudSearchDomainClient { /* private fields */ }
Expand description
A client for the Amazon CloudSearch Domain API.
Implementations
sourceimpl CloudSearchDomainClient
impl CloudSearchDomainClient
sourcepub fn new(region: Region) -> CloudSearchDomainClient
pub fn new(region: Region) -> CloudSearchDomainClient
Creates a client backed by the default tokio event loop.
The client will use the default credentials provider and tls client.
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: Region
) -> CloudSearchDomainClient where
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
pub fn new_with_client(
client: Client,
region: Region
) -> CloudSearchDomainClient
Trait Implementations
sourceimpl Clone for CloudSearchDomainClient
impl Clone for CloudSearchDomainClient
sourcefn clone(&self) -> CloudSearchDomainClient
fn clone(&self) -> CloudSearchDomainClient
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl CloudSearchDomain for CloudSearchDomainClient
impl CloudSearchDomain for CloudSearchDomainClient
sourcefn search<'life0, 'async_trait>(
&'life0 self,
input: SearchRequest
) -> Pin<Box<dyn Future<Output = Result<SearchResponse, RusotoError<SearchError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn search<'life0, 'async_trait>(
&'life0 self,
input: SearchRequest
) -> Pin<Box<dyn Future<Output = Result<SearchResponse, RusotoError<SearchError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn suggest<'life0, 'async_trait>(
&'life0 self,
input: SuggestRequest
) -> Pin<Box<dyn Future<Output = Result<SuggestResponse, RusotoError<SuggestError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn suggest<'life0, 'async_trait>(
&'life0 self,
input: SuggestRequest
) -> Pin<Box<dyn Future<Output = Result<SuggestResponse, RusotoError<SuggestError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn upload_documents<'life0, 'async_trait>(
&'life0 self,
input: UploadDocumentsRequest
) -> Pin<Box<dyn Future<Output = Result<UploadDocumentsResponse, RusotoError<UploadDocumentsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn upload_documents<'life0, 'async_trait>(
&'life0 self,
input: UploadDocumentsRequest
) -> Pin<Box<dyn Future<Output = Result<UploadDocumentsResponse, RusotoError<UploadDocumentsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
Auto Trait Implementations
impl !RefUnwindSafe for CloudSearchDomainClient
impl Send for CloudSearchDomainClient
impl Sync for CloudSearchDomainClient
impl Unpin for CloudSearchDomainClient
impl !UnwindSafe for CloudSearchDomainClient
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more