com.amazonaws.services.translate

Class AmazonTranslateAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.translate.AmazonTranslateClient

com.amazonaws.services.translate.AmazonTranslateAsyncClient

All Implemented Interfaces:

AmazonTranslate, AmazonTranslateAsync

public class AmazonTranslateAsyncClient
extends AmazonTranslateClient
implements AmazonTranslateAsync

Interface for accessing Amazon Translate asynchronously.

Provides translation between one source language and another of the same set of languages.

Field Summary

Fields inherited from class com.amazonaws.services.translate.AmazonTranslateClient

jsonErrorUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonTranslateAsyncClient() Deprecated.
AmazonTranslateAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials.
AmazonTranslateAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials, executor service, and client configuration options.
AmazonTranslateAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials and executor service.
AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials provider.
AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials provider and client configuration options.
AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials provider and executor service.
AmazonTranslateAsyncClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
Future<Void>	deleteTerminologyAsync(DeleteTerminologyRequest deleteTerminologyRequest) A synchronous action that deletes a custom terminology.
Future<Void>	deleteTerminologyAsync(DeleteTerminologyRequest deleteTerminologyRequest, AsyncHandler<DeleteTerminologyRequest,Void> asyncHandler) A synchronous action that deletes a custom terminology.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<GetTerminologyResult>	getTerminologyAsync(GetTerminologyRequest getTerminologyRequest) Retrieves a custom terminology.
Future<GetTerminologyResult>	getTerminologyAsync(GetTerminologyRequest getTerminologyRequest, AsyncHandler<GetTerminologyRequest,GetTerminologyResult> asyncHandler) Retrieves a custom terminology.
Future<ImportTerminologyResult>	importTerminologyAsync(ImportTerminologyRequest importTerminologyRequest) Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
Future<ImportTerminologyResult>	importTerminologyAsync(ImportTerminologyRequest importTerminologyRequest, AsyncHandler<ImportTerminologyRequest,ImportTerminologyResult> asyncHandler) Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
Future<ListTerminologiesResult>	listTerminologiesAsync(ListTerminologiesRequest listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
Future<ListTerminologiesResult>	listTerminologiesAsync(ListTerminologiesRequest listTerminologiesRequest, AsyncHandler<ListTerminologiesRequest,ListTerminologiesResult> asyncHandler) Provides a list of custom terminologies associated with your account.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TranslateTextResult>	translateTextAsync(TranslateTextRequest translateTextRequest) Translates input text from the source language to the target language.
Future<TranslateTextResult>	translateTextAsync(TranslateTextRequest translateTextRequest, AsyncHandler<TranslateTextRequest,TranslateTextResult> asyncHandler) Translates input text from the source language to the target language.

Methods inherited from class com.amazonaws.services.translate.AmazonTranslateClient

deleteTerminology, getCachedResponseMetadata, getTerminology, importTerminology, listTerminologies, translateText

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.translate.AmazonTranslate

deleteTerminology, getCachedResponseMetadata, getTerminology, importTerminology, listTerminologies, setEndpoint, setRegion, translateText

Constructor Detail

AmazonTranslateAsyncClient

@Deprecated
public AmazonTranslateAsyncClient()

Deprecated.

Constructs a new asynchronous client to invoke service methods on Amazon Translate. 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

AmazonTranslateAsyncClient

@Deprecated
public AmazonTranslateAsyncClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new asynchronous client to invoke service methods on Amazon Translate. 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 Translate (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonTranslateAsyncClient

public AmazonTranslateAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

AmazonTranslateAsyncClient

public AmazonTranslateAsyncClient(AWSCredentials awsCredentials,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

executorService - The executor service by which all asynchronous requests will be executed.

AmazonTranslateAsyncClient

public AmazonTranslateAsyncClient(AWSCredentials awsCredentials,
                                  ClientConfiguration clientConfiguration,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonTranslateAsyncClient

public AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

AmazonTranslateAsyncClient

public AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

executorService - The executor service by which all asynchronous requests will be executed.

AmazonTranslateAsyncClient

public AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration)

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

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

AmazonTranslateAsyncClient

public AmazonTranslateAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration,
                                  ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Translate using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonTranslate

Overrides:

shutdown in class AmazonWebServiceClient

deleteTerminologyAsync

public Future<Void> deleteTerminologyAsync(DeleteTerminologyRequest deleteTerminologyRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

A synchronous action that deletes a custom terminology.

Specified by:

deleteTerminologyAsync in interface AmazonTranslateAsync

Parameters:

deleteTerminologyRequest -

Returns:

A Java Future object containing the response from the DeleteTerminology service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

deleteTerminologyAsync

public Future<Void> deleteTerminologyAsync(DeleteTerminologyRequest deleteTerminologyRequest,
                                           AsyncHandler<DeleteTerminologyRequest,Void> asyncHandler)
                                    throws AmazonServiceException,
                                           AmazonClientException

A synchronous action that deletes a custom terminology.

Specified by:

deleteTerminologyAsync in interface AmazonTranslateAsync

Parameters:

deleteTerminologyRequest -

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteTerminology service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

getTerminologyAsync

public Future<GetTerminologyResult> getTerminologyAsync(GetTerminologyRequest getTerminologyRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

Retrieves a custom terminology.

Specified by:

getTerminologyAsync in interface AmazonTranslateAsync

Parameters:

getTerminologyRequest -

Returns:

A Java Future object containing the response from the GetTerminology service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

getTerminologyAsync

public Future<GetTerminologyResult> getTerminologyAsync(GetTerminologyRequest getTerminologyRequest,
                                                        AsyncHandler<GetTerminologyRequest,GetTerminologyResult> asyncHandler)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

Retrieves a custom terminology.

Specified by:

getTerminologyAsync in interface AmazonTranslateAsync

Parameters:

getTerminologyRequest -

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetTerminology service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

importTerminologyAsync

public Future<ImportTerminologyResult> importTerminologyAsync(ImportTerminologyRequest importTerminologyRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

Specified by:

importTerminologyAsync in interface AmazonTranslateAsync

Parameters:

importTerminologyRequest -

Returns:

A Java Future object containing the response from the ImportTerminology service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

LimitExceededException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

importTerminologyAsync

public Future<ImportTerminologyResult> importTerminologyAsync(ImportTerminologyRequest importTerminologyRequest,
                                                              AsyncHandler<ImportTerminologyRequest,ImportTerminologyResult> asyncHandler)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

Specified by:

importTerminologyAsync in interface AmazonTranslateAsync

Parameters:

importTerminologyRequest -

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ImportTerminology service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

LimitExceededException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

listTerminologiesAsync

public Future<ListTerminologiesResult> listTerminologiesAsync(ListTerminologiesRequest listTerminologiesRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Provides a list of custom terminologies associated with your account.

Specified by:

listTerminologiesAsync in interface AmazonTranslateAsync

Parameters:

listTerminologiesRequest -

Returns:

A Java Future object containing the response from the ListTerminologies service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

listTerminologiesAsync

public Future<ListTerminologiesResult> listTerminologiesAsync(ListTerminologiesRequest listTerminologiesRequest,
                                                              AsyncHandler<ListTerminologiesRequest,ListTerminologiesResult> asyncHandler)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Provides a list of custom terminologies associated with your account.

Specified by:

listTerminologiesAsync in interface AmazonTranslateAsync

Parameters:

listTerminologiesRequest -

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListTerminologies service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

translateTextAsync

public Future<TranslateTextResult> translateTextAsync(TranslateTextRequest translateTextRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs.

• Arabic (ar)

• Chinese (Simplified) (zh)

• Chinese (Traditional) (zh-TW)

• Czech (cs)

• Danish (da)

• Dutch (nl)

• English (en)

• Finnish (fi)

• French (fr)

• German (de)

• Hebrew (he)

• Indonesian (id)

• Italian (it)

• Japanese (ja)

• Korean (ko)

• Polish (pl)

• Portuguese (pt)

• Russian (ru)

• Spanish (es)

• Swedish (sv)

• Turkish (tr)

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

Specified by:

translateTextAsync in interface AmazonTranslateAsync

Parameters:

translateTextRequest -

Returns:

A Java Future object containing the response from the TranslateText service method, as returned by Amazon Translate.

Throws:

InvalidRequestException

TextSizeLimitExceededException

TooManyRequestsException

UnsupportedLanguagePairException

DetectedLanguageLowConfidenceException

ResourceNotFoundException

InternalServerException

ServiceUnavailableException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

translateTextAsync

public Future<TranslateTextResult> translateTextAsync(TranslateTextRequest translateTextRequest,
                                                      AsyncHandler<TranslateTextRequest,TranslateTextResult> asyncHandler)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs.

• Arabic (ar)

• Chinese (Simplified) (zh)

• Chinese (Traditional) (zh-TW)

• Czech (cs)

• Danish (da)

• Dutch (nl)

• English (en)

• Finnish (fi)

• French (fr)

• German (de)

• Hebrew (he)

• Indonesian (id)

• Italian (it)

• Japanese (ja)

• Korean (ko)

• Polish (pl)

• Portuguese (pt)

• Russian (ru)

• Spanish (es)

• Swedish (sv)

• Turkish (tr)

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

Specified by:

translateTextAsync in interface AmazonTranslateAsync

Parameters:

translateTextRequest -

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the TranslateText service method, as returned by Amazon Translate.

Throws:

InvalidRequestException

TextSizeLimitExceededException

TooManyRequestsException

UnsupportedLanguagePairException

DetectedLanguageLowConfidenceException

ResourceNotFoundException

InternalServerException

ServiceUnavailableException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.