Package software.amazon.awssdk.services.cloudsearchdomain

Interface CloudSearchDomainClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CloudSearchDomainClient
extends AwsClient

Service client for accessing Amazon CloudSearch Domain. This can be created using the static 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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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.
default CloudSearchDomainServiceClientConfiguration	serviceClientConfiguration()
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 sourcePath)	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 sourcePath)	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.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

search

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.

Parameters:

searchRequest - Container for the parameters to the Search request.

Returns:

Result of the Search operation returned by the service.

Throws:

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

search

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()

Parameters:

searchRequest - A Consumer that will call methods on SearchRequest.Builder to create a request. Container for the parameters to the Search request.

Returns:

Result of the Search operation returned by the service.

Throws:

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

suggest

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.

Parameters:

suggestRequest - Container for the parameters to the Suggest request.

Returns:

Result of the Suggest operation returned by the service.

Throws:

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

suggest

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()

Parameters:

suggestRequest - A Consumer that will call methods on SuggestRequest.Builder to create a request. Container for the parameters to the Suggest request.

Returns:

Result of the Suggest operation returned by the service.

Throws:

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

uploadDocuments

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.

Parameters:

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.

'

Returns:

Result of the UploadDocuments operation returned by the service.

Throws:

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

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()

Parameters:

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.

'

Returns:

Result of the UploadDocuments operation returned by the service.

Throws:

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

default UploadDocumentsResponse uploadDocuments(UploadDocumentsRequest uploadDocumentsRequest,
                                                Path sourcePath)
                                         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.

Parameters:

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.

'

Returns:

Result of the UploadDocuments operation returned by the service.

Throws:

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

See Also:

uploadDocuments(UploadDocumentsRequest, RequestBody)

uploadDocuments

default UploadDocumentsResponse uploadDocuments(Consumer<UploadDocumentsRequest.Builder> uploadDocumentsRequest,
                                                Path sourcePath)
                                         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()

Parameters:

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.

'

Returns:

Result of the UploadDocuments operation returned by the service.

Throws:

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

See Also:

uploadDocuments(UploadDocumentsRequest, RequestBody)

create

static CloudSearchDomainClient create()

Create a CloudSearchDomainClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudSearchDomainClientBuilder builder()

Create a builder that can be used to configure and create a CloudSearchDomainClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CloudSearchDomainServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient