@Generated(value="software.amazon.awssdk:codegen") public interface CloudSearchDomainClient extends SdkClient
builder()
method.
You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
The endpoints for submitting UploadDocuments
, Search
, and Suggest
requests are
domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service
DescribeDomains
action. The domain endpoints are also displayed on the domain dashboard in the Amazon
CloudSearch console. You submit suggest requests to the search endpoint.
For more information, see the Amazon CloudSearch Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CloudSearchDomainClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudSearchDomainClient . |
static CloudSearchDomainClient |
create()
Create a
CloudSearchDomainClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default SearchResponse |
search(Consumer<SearchRequest.Builder> searchRequest)
Retrieves a list of documents that match the specified search criteria.
|
default SearchResponse |
search(SearchRequest searchRequest)
Retrieves a list of documents that match the specified search criteria.
|
static ServiceMetadata |
serviceMetadata() |
default SuggestResponse |
suggest(Consumer<SuggestRequest.Builder> suggestRequest)
Retrieves autocomplete suggestions for a partial query string.
|
default SuggestResponse |
suggest(SuggestRequest suggestRequest)
Retrieves autocomplete suggestions for a partial query string.
|
default UploadDocumentsResponse |
uploadDocuments(Consumer<UploadDocumentsRequest.Builder> uploadDocumentsRequest,
Path filePath)
Posts a batch of documents to a search domain for indexing.
|
default UploadDocumentsResponse |
uploadDocuments(Consumer<UploadDocumentsRequest.Builder> uploadDocumentsRequest,
RequestBody requestBody)
Posts a batch of documents to a search domain for indexing.
|
default UploadDocumentsResponse |
uploadDocuments(UploadDocumentsRequest uploadDocumentsRequest,
Path filePath)
Posts a batch of documents to a search domain for indexing.
|
default UploadDocumentsResponse |
uploadDocuments(UploadDocumentsRequest uploadDocumentsRequest,
RequestBody requestBody)
Posts a batch of documents to a search domain for indexing.
|
serviceName
close
static final String SERVICE_NAME
static CloudSearchDomainClient create()
CloudSearchDomainClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudSearchDomainClientBuilder builder()
CloudSearchDomainClient
.default SearchResponse search(SearchRequest searchRequest) throws SearchException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
searchRequest
- Container for the parameters to the Search
request.SearchException
- Information about any problems encountered while processing a search request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchResponse search(Consumer<SearchRequest.Builder> searchRequest) throws SearchException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
This is a convenience which creates an instance of the SearchRequest.Builder
avoiding the need to create
one manually via SearchRequest.builder()
searchRequest
- A Consumer
that will call methods on SearchRequest.Builder
to create a request. Container
for the parameters to the Search
request.SearchException
- Information about any problems encountered while processing a search request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SuggestResponse suggest(SuggestRequest suggestRequest) throws SearchException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
suggestRequest
- Container for the parameters to the Suggest
request.SearchException
- Information about any problems encountered while processing a search request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SuggestResponse suggest(Consumer<SuggestRequest.Builder> suggestRequest) throws SearchException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
This is a convenience which creates an instance of the SuggestRequest.Builder
avoiding the need to create
one manually via SuggestRequest.builder()
suggestRequest
- A Consumer
that will call methods on SuggestRequest.Builder
to create a request. Container
for the parameters to the Suggest
request.SearchException
- Information about any problems encountered while processing a search request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadDocumentsResponse uploadDocuments(UploadDocumentsRequest uploadDocumentsRequest, RequestBody requestBody) throws DocumentServiceException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
uploadDocumentsRequest
- Container for the parameters to the UploadDocuments
request.requestBody
- The content to send to the service. A RequestBody
can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody
for additional details and which sources of data are supported.
The service documentation for the request content is as follows '
A batch of documents formatted in JSON or HTML.
'DocumentServiceException
- Information about any problems encountered while processing an upload request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadDocumentsResponse uploadDocuments(Consumer<UploadDocumentsRequest.Builder> uploadDocumentsRequest, RequestBody requestBody) throws DocumentServiceException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
This is a convenience which creates an instance of the UploadDocumentsRequest.Builder
avoiding the need
to create one manually via UploadDocumentsRequest.builder()
uploadDocumentsRequest
- A Consumer
that will call methods on UploadDocumentsRequest.Builder
to create a request.
Container for the parameters to the UploadDocuments
request.requestBody
- The content to send to the service. A RequestBody
can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody
for additional details and which sources of data are supported.
The service documentation for the request content is as follows '
A batch of documents formatted in JSON or HTML.
'DocumentServiceException
- Information about any problems encountered while processing an upload request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadDocumentsResponse uploadDocuments(UploadDocumentsRequest uploadDocumentsRequest, Path filePath) throws DocumentServiceException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
uploadDocumentsRequest
- Container for the parameters to the UploadDocuments
request.sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
A batch of documents formatted in JSON or HTML.
'DocumentServiceException
- Information about any problems encountered while processing an upload request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
uploadDocuments(UploadDocumentsRequest, RequestBody)
default UploadDocumentsResponse uploadDocuments(Consumer<UploadDocumentsRequest.Builder> uploadDocumentsRequest, Path filePath) throws DocumentServiceException, AwsServiceException, SdkClientException, CloudSearchDomainException
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.
This is a convenience which creates an instance of the UploadDocumentsRequest.Builder
avoiding the need
to create one manually via UploadDocumentsRequest.builder()
uploadDocumentsRequest
- A Consumer
that will call methods on UploadDocumentsRequest.Builder
to create a request.
Container for the parameters to the UploadDocuments
request.sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
A batch of documents formatted in JSON or HTML.
'DocumentServiceException
- Information about any problems encountered while processing an upload request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudSearchDomainException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
uploadDocuments(UploadDocumentsRequest, RequestBody)
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.