com.amazonaws.services.translate.AmazonTranslateAsync Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.translate;
import javax.annotation.Generated;
import com.amazonaws.services.translate.model.*;
/**
* Interface for accessing Amazon Translate asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.translate.AbstractAmazonTranslateAsync} instead.
*
*
*
* Provides translation between one source language and another of the same set of languages.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonTranslateAsync extends AmazonTranslate {
/**
*
* A synchronous action that deletes a custom terminology.
*
*
* @param deleteTerminologyRequest
* @return A Java Future containing the result of the DeleteTerminology operation returned by the service.
* @sample AmazonTranslateAsync.DeleteTerminology
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteTerminologyAsync(DeleteTerminologyRequest deleteTerminologyRequest);
/**
*
* A synchronous action that deletes a custom terminology.
*
*
* @param deleteTerminologyRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteTerminology operation returned by the service.
* @sample AmazonTranslateAsyncHandler.DeleteTerminology
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteTerminologyAsync(DeleteTerminologyRequest deleteTerminologyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and
* target languages, input/output S3 buckets, and so on.
*
*
* @param describeTextTranslationJobRequest
* @return A Java Future containing the result of the DescribeTextTranslationJob operation returned by the service.
* @sample AmazonTranslateAsync.DescribeTextTranslationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTextTranslationJobAsync(
DescribeTextTranslationJobRequest describeTextTranslationJobRequest);
/**
*
* Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and
* target languages, input/output S3 buckets, and so on.
*
*
* @param describeTextTranslationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeTextTranslationJob operation returned by the service.
* @sample AmazonTranslateAsyncHandler.DescribeTextTranslationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeTextTranslationJobAsync(
DescribeTextTranslationJobRequest describeTextTranslationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a custom terminology.
*
*
* @param getTerminologyRequest
* @return A Java Future containing the result of the GetTerminology operation returned by the service.
* @sample AmazonTranslateAsync.GetTerminology
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getTerminologyAsync(GetTerminologyRequest getTerminologyRequest);
/**
*
* Retrieves a custom terminology.
*
*
* @param getTerminologyRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetTerminology operation returned by the service.
* @sample AmazonTranslateAsyncHandler.GetTerminology
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getTerminologyAsync(GetTerminologyRequest getTerminologyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param importTerminologyRequest
* @return A Java Future containing the result of the ImportTerminology operation returned by the service.
* @sample AmazonTranslateAsync.ImportTerminology
* @see AWS
* API Documentation
*/
java.util.concurrent.Future importTerminologyAsync(ImportTerminologyRequest importTerminologyRequest);
/**
*
* 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.
*
*
* @param importTerminologyRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ImportTerminology operation returned by the service.
* @sample AmazonTranslateAsyncHandler.ImportTerminology
* @see AWS
* API Documentation
*/
java.util.concurrent.Future importTerminologyAsync(ImportTerminologyRequest importTerminologyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Provides a list of custom terminologies associated with your account.
*
*
* @param listTerminologiesRequest
* @return A Java Future containing the result of the ListTerminologies operation returned by the service.
* @sample AmazonTranslateAsync.ListTerminologies
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTerminologiesAsync(ListTerminologiesRequest listTerminologiesRequest);
/**
*
* Provides a list of custom terminologies associated with your account.
*
*
* @param listTerminologiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTerminologies operation returned by the service.
* @sample AmazonTranslateAsyncHandler.ListTerminologies
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTerminologiesAsync(ListTerminologiesRequest listTerminologiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of the batch translation jobs that you have submitted.
*
*
* @param listTextTranslationJobsRequest
* @return A Java Future containing the result of the ListTextTranslationJobs operation returned by the service.
* @sample AmazonTranslateAsync.ListTextTranslationJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listTextTranslationJobsAsync(ListTextTranslationJobsRequest listTextTranslationJobsRequest);
/**
*
* Gets a list of the batch translation jobs that you have submitted.
*
*
* @param listTextTranslationJobsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTextTranslationJobs operation returned by the service.
* @sample AmazonTranslateAsyncHandler.ListTextTranslationJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listTextTranslationJobsAsync(ListTextTranslationJobsRequest listTextTranslationJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of
* text across multiple documents at once. For more information, see async.
*
*
* Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the
* ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.
*
*
*
* Amazon Translate does not support batch translation of multiple source languages at once.
*
*
*
* @param startTextTranslationJobRequest
* @return A Java Future containing the result of the StartTextTranslationJob operation returned by the service.
* @sample AmazonTranslateAsync.StartTextTranslationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startTextTranslationJobAsync(StartTextTranslationJobRequest startTextTranslationJobRequest);
/**
*
* Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of
* text across multiple documents at once. For more information, see async.
*
*
* Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the
* ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.
*
*
*
* Amazon Translate does not support batch translation of multiple source languages at once.
*
*
*
* @param startTextTranslationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartTextTranslationJob operation returned by the service.
* @sample AmazonTranslateAsyncHandler.StartTextTranslationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startTextTranslationJobAsync(StartTextTranslationJobRequest startTextTranslationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops an asynchronous batch translation job that is in progress.
*
*
* If the job's state is IN_PROGRESS, the job will be marked for termination and put into the
* STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
* COMPLETED state. Otherwise, the job is put into the STOPPED state.
*
*
* Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use
* the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation
* job's JobId.
*
*
* @param stopTextTranslationJobRequest
* @return A Java Future containing the result of the StopTextTranslationJob operation returned by the service.
* @sample AmazonTranslateAsync.StopTextTranslationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopTextTranslationJobAsync(StopTextTranslationJobRequest stopTextTranslationJobRequest);
/**
*
* Stops an asynchronous batch translation job that is in progress.
*
*
* If the job's state is IN_PROGRESS, the job will be marked for termination and put into the
* STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the
* COMPLETED state. Otherwise, the job is put into the STOPPED state.
*
*
* Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use
* the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation
* job's JobId.
*
*
* @param stopTextTranslationJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopTextTranslationJob operation returned by the service.
* @sample AmazonTranslateAsyncHandler.StopTextTranslationJob
* @see AWS API Documentation
*/
java.util.concurrent.Future stopTextTranslationJobAsync(StopTextTranslationJobRequest stopTextTranslationJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Translates input text from the source language to the target language. For a list of available languages and
* language codes, see what-is-languages.
*
*
* @param translateTextRequest
* @return A Java Future containing the result of the TranslateText operation returned by the service.
* @sample AmazonTranslateAsync.TranslateText
* @see AWS API
* Documentation
*/
java.util.concurrent.Future translateTextAsync(TranslateTextRequest translateTextRequest);
/**
*
* Translates input text from the source language to the target language. For a list of available languages and
* language codes, see what-is-languages.
*
*
* @param translateTextRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TranslateText operation returned by the service.
* @sample AmazonTranslateAsyncHandler.TranslateText
* @see AWS API
* Documentation
*/
java.util.concurrent.Future translateTextAsync(TranslateTextRequest translateTextRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}