com.amazonaws.services.cloudsearchdomain

Class AmazonCloudSearchDomainClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomainClient

All Implemented Interfaces:

AmazonCloudSearchDomain

Direct Known Subclasses:

AmazonCloudSearchDomainAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCloudSearchDomainClient
extends AmazonWebServiceClient
implements AmazonCloudSearchDomain

Client for accessing Amazon CloudSearch Domain. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomain

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonCloudSearchDomainClient() Deprecated. use AmazonCloudSearchDomainClientBuilder.defaultClient()
AmazonCloudSearchDomainClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCloudSearchDomainClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonCloudSearchDomainClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonCloudSearchDomainClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AmazonCloudSearchDomainClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
SearchResult	search(SearchRequest request) Retrieves a list of documents that match the specified search criteria.
SuggestResult	suggest(SuggestRequest request) Retrieves autocomplete suggestions for a partial query string.
UploadDocumentsResult	uploadDocuments(UploadDocumentsRequest request) Posts a batch of documents to a search domain for indexing.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomain

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonCloudSearchDomainClient

@Deprecated
public AmazonCloudSearchDomainClient()

Deprecated. use AmazonCloudSearchDomainClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon CloudSearch Domain. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchDomainClient

@Deprecated
public AmazonCloudSearchDomainClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon CloudSearch Domain. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudSearch Domain (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchDomainClient

@Deprecated
public AmazonCloudSearchDomainClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCloudSearchDomainClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon CloudSearch Domain using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCloudSearchDomainClient

@Deprecated
public AmazonCloudSearchDomainClient(AWSCredentials awsCredentials,
                                                 ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon CloudSearch Domain using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudSearch Domain (ex: proxy settings, retry counts, etc.).

AmazonCloudSearchDomainClient

@Deprecated
public AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon CloudSearch Domain using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCloudSearchDomainClient

@Deprecated
public AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider,
                                                 ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon CloudSearch Domain using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudSearch Domain (ex: proxy settings, retry counts, etc.).

AmazonCloudSearchDomainClient

@Deprecated
public AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider,
                                                 ClientConfiguration clientConfiguration,
                                                 RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon CloudSearch Domain using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudSearch Domain (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonCloudSearchDomainClientBuilder builder()

search

public SearchResult search(SearchRequest request)

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.

Specified by:

search in interface AmazonCloudSearchDomain

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.

suggest

public SuggestResult suggest(SuggestRequest request)

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.

Specified by:

suggest in interface AmazonCloudSearchDomain

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.

uploadDocuments

public UploadDocumentsResult uploadDocuments(UploadDocumentsRequest request)

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.

Specified by:

uploadDocuments in interface AmazonCloudSearchDomain

Parameters:

uploadDocumentsRequest - Container for the parameters to the UploadDocuments request.

Returns:

Result of the UploadDocuments operation returned by the service.

Throws:

DocumentServiceException - Information about any problems encountered while processing an upload request.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonCloudSearchDomain

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.