Class TranslationServiceClient
- java.lang.Object
-
- com.google.cloud.translate.v3.TranslationServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class TranslationServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Provides natural language translation operations.This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String targetLanguageCode = "targetLanguageCode-106414698"; List<String> contents = new ArrayList<>(); TranslateTextResponse response = translationServiceClient.translateText(parent, targetLanguageCode, contents); }
Note: close() needs to be called on the TranslationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of TranslationServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library TranslationServiceSettings translationServiceSettings = TranslationServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); TranslationServiceClient translationServiceClient = TranslationServiceClient.create(translationServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library TranslationServiceSettings translationServiceSettings = TranslationServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); TranslationServiceClient translationServiceClient = TranslationServiceClient.create(translationServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library TranslationServiceSettings translationServiceSettings = TranslationServiceSettings.newHttpJsonBuilder().build(); TranslationServiceClient translationServiceClient = TranslationServiceClient.create(translationServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TranslationServiceClient.ListGlossariesFixedSizeCollection
static class
TranslationServiceClient.ListGlossariesPage
static class
TranslationServiceClient.ListGlossariesPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
TranslationServiceClient(TranslationServiceStub stub)
protected
TranslationServiceClient(TranslationServiceSettings settings)
Constructs an instance of TranslationServiceClient, using the given settings.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
com.google.api.gax.longrunning.OperationFuture<BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata>
batchTranslateDocumentAsync(BatchTranslateDocumentRequest request)
Translates a large volume of document in asynchronous batch mode.com.google.api.gax.longrunning.OperationFuture<BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata>
batchTranslateDocumentAsync(LocationName parent, String sourceLanguageCode, List<String> targetLanguageCodes, List<BatchDocumentInputConfig> inputConfigs, BatchDocumentOutputConfig outputConfig)
Translates a large volume of document in asynchronous batch mode.com.google.api.gax.longrunning.OperationFuture<BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata>
batchTranslateDocumentAsync(String parent, String sourceLanguageCode, List<String> targetLanguageCodes, List<BatchDocumentInputConfig> inputConfigs, BatchDocumentOutputConfig outputConfig)
Translates a large volume of document in asynchronous batch mode.com.google.api.gax.rpc.UnaryCallable<BatchTranslateDocumentRequest,com.google.longrunning.Operation>
batchTranslateDocumentCallable()
Translates a large volume of document in asynchronous batch mode.com.google.api.gax.rpc.OperationCallable<BatchTranslateDocumentRequest,BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata>
batchTranslateDocumentOperationCallable()
Translates a large volume of document in asynchronous batch mode.com.google.api.gax.longrunning.OperationFuture<BatchTranslateResponse,BatchTranslateMetadata>
batchTranslateTextAsync(BatchTranslateTextRequest request)
Translates a large volume of text in asynchronous batch mode.com.google.api.gax.rpc.UnaryCallable<BatchTranslateTextRequest,com.google.longrunning.Operation>
batchTranslateTextCallable()
Translates a large volume of text in asynchronous batch mode.com.google.api.gax.rpc.OperationCallable<BatchTranslateTextRequest,BatchTranslateResponse,BatchTranslateMetadata>
batchTranslateTextOperationCallable()
Translates a large volume of text in asynchronous batch mode.void
close()
static TranslationServiceClient
create()
Constructs an instance of TranslationServiceClient with default settings.static TranslationServiceClient
create(TranslationServiceStub stub)
Constructs an instance of TranslationServiceClient, using the given stub for making calls.static TranslationServiceClient
create(TranslationServiceSettings settings)
Constructs an instance of TranslationServiceClient, using the given settings.com.google.api.gax.longrunning.OperationFuture<Glossary,CreateGlossaryMetadata>
createGlossaryAsync(CreateGlossaryRequest request)
Creates a glossary and returns the long-running operation.com.google.api.gax.longrunning.OperationFuture<Glossary,CreateGlossaryMetadata>
createGlossaryAsync(LocationName parent, Glossary glossary)
Creates a glossary and returns the long-running operation.com.google.api.gax.longrunning.OperationFuture<Glossary,CreateGlossaryMetadata>
createGlossaryAsync(String parent, Glossary glossary)
Creates a glossary and returns the long-running operation.com.google.api.gax.rpc.UnaryCallable<CreateGlossaryRequest,com.google.longrunning.Operation>
createGlossaryCallable()
Creates a glossary and returns the long-running operation.com.google.api.gax.rpc.OperationCallable<CreateGlossaryRequest,Glossary,CreateGlossaryMetadata>
createGlossaryOperationCallable()
Creates a glossary and returns the long-running operation.com.google.api.gax.longrunning.OperationFuture<DeleteGlossaryResponse,DeleteGlossaryMetadata>
deleteGlossaryAsync(DeleteGlossaryRequest request)
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet.com.google.api.gax.longrunning.OperationFuture<DeleteGlossaryResponse,DeleteGlossaryMetadata>
deleteGlossaryAsync(GlossaryName name)
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet.com.google.api.gax.longrunning.OperationFuture<DeleteGlossaryResponse,DeleteGlossaryMetadata>
deleteGlossaryAsync(String name)
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet.com.google.api.gax.rpc.UnaryCallable<DeleteGlossaryRequest,com.google.longrunning.Operation>
deleteGlossaryCallable()
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet.com.google.api.gax.rpc.OperationCallable<DeleteGlossaryRequest,DeleteGlossaryResponse,DeleteGlossaryMetadata>
deleteGlossaryOperationCallable()
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet.DetectLanguageResponse
detectLanguage(DetectLanguageRequest request)
Detects the language of text within a request.DetectLanguageResponse
detectLanguage(LocationName parent, String model, String mimeType, String content)
Detects the language of text within a request.DetectLanguageResponse
detectLanguage(String parent, String model, String mimeType, String content)
Detects the language of text within a request.com.google.api.gax.rpc.UnaryCallable<DetectLanguageRequest,DetectLanguageResponse>
detectLanguageCallable()
Detects the language of text within a request.Glossary
getGlossary(GetGlossaryRequest request)
Gets a glossary.Glossary
getGlossary(GlossaryName name)
Gets a glossary.Glossary
getGlossary(String name)
Gets a glossary.com.google.api.gax.rpc.UnaryCallable<GetGlossaryRequest,Glossary>
getGlossaryCallable()
Gets a glossary.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.TranslationServiceSettings
getSettings()
TranslationServiceStub
getStub()
SupportedLanguages
getSupportedLanguages(GetSupportedLanguagesRequest request)
Returns a list of supported languages for translation.SupportedLanguages
getSupportedLanguages(LocationName parent, String model, String displayLanguageCode)
Returns a list of supported languages for translation.SupportedLanguages
getSupportedLanguages(String parent, String model, String displayLanguageCode)
Returns a list of supported languages for translation.com.google.api.gax.rpc.UnaryCallable<GetSupportedLanguagesRequest,SupportedLanguages>
getSupportedLanguagesCallable()
Returns a list of supported languages for translation.boolean
isShutdown()
boolean
isTerminated()
TranslationServiceClient.ListGlossariesPagedResponse
listGlossaries(ListGlossariesRequest request)
Lists glossaries in a project.TranslationServiceClient.ListGlossariesPagedResponse
listGlossaries(LocationName parent)
Lists glossaries in a project.TranslationServiceClient.ListGlossariesPagedResponse
listGlossaries(String parent)
Lists glossaries in a project.com.google.api.gax.rpc.UnaryCallable<ListGlossariesRequest,ListGlossariesResponse>
listGlossariesCallable()
Lists glossaries in a project.com.google.api.gax.rpc.UnaryCallable<ListGlossariesRequest,TranslationServiceClient.ListGlossariesPagedResponse>
listGlossariesPagedCallable()
Lists glossaries in a project.void
shutdown()
void
shutdownNow()
TranslateDocumentResponse
translateDocument(TranslateDocumentRequest request)
Translates documents in synchronous mode.com.google.api.gax.rpc.UnaryCallable<TranslateDocumentRequest,TranslateDocumentResponse>
translateDocumentCallable()
Translates documents in synchronous mode.TranslateTextResponse
translateText(LocationName parent, String model, String mimeType, String sourceLanguageCode, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.TranslateTextResponse
translateText(LocationName parent, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.TranslateTextResponse
translateText(TranslateTextRequest request)
Translates input text and returns translated text.TranslateTextResponse
translateText(String parent, String model, String mimeType, String sourceLanguageCode, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.TranslateTextResponse
translateText(String parent, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.com.google.api.gax.rpc.UnaryCallable<TranslateTextRequest,TranslateTextResponse>
translateTextCallable()
Translates input text and returns translated text.
-
-
-
Constructor Detail
-
TranslationServiceClient
protected TranslationServiceClient(TranslationServiceSettings settings) throws IOException
Constructs an instance of TranslationServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.- Throws:
IOException
-
TranslationServiceClient
protected TranslationServiceClient(TranslationServiceStub stub)
-
-
Method Detail
-
create
public static final TranslationServiceClient create() throws IOException
Constructs an instance of TranslationServiceClient with default settings.- Throws:
IOException
-
create
public static final TranslationServiceClient create(TranslationServiceSettings settings) throws IOException
Constructs an instance of TranslationServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final TranslationServiceClient create(TranslationServiceStub stub)
Constructs an instance of TranslationServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TranslationServiceSettings).
-
getSettings
public final TranslationServiceSettings getSettings()
-
getStub
public TranslationServiceStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
translateText
public final TranslateTextResponse translateText(LocationName parent, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String targetLanguageCode = "targetLanguageCode-106414698"; List<String> contents = new ArrayList<>(); TranslateTextResponse response = translationServiceClient.translateText(parent, targetLanguageCode, contents); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Non-global location is required for requests using AutoML models or custom glossaries.
Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
targetLanguageCode
- Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.contents
- Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
translateText
public final TranslateTextResponse translateText(String parent, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String targetLanguageCode = "targetLanguageCode-106414698"; List<String> contents = new ArrayList<>(); TranslateTextResponse response = translationServiceClient.translateText(parent, targetLanguageCode, contents); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Non-global location is required for requests using AutoML models or custom glossaries.
Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
targetLanguageCode
- Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.contents
- Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
translateText
public final TranslateTextResponse translateText(LocationName parent, String model, String mimeType, String sourceLanguageCode, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String model = "model104069929"; String mimeType = "mimeType-1392120434"; String sourceLanguageCode = "sourceLanguageCode1645917472"; String targetLanguageCode = "targetLanguageCode-106414698"; List<String> contents = new ArrayList<>(); TranslateTextResponse response = translationServiceClient.translateText( parent, model, mimeType, sourceLanguageCode, targetLanguageCode, contents); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Non-global location is required for requests using AutoML models or custom glossaries.
Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
model
- Optional. The `model` type requested for this translation.The format depends on model type:
- AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
- General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`.
If not provided, the default Google model (NMT) will be used
mimeType
- Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".sourceLanguageCode
- Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.targetLanguageCode
- Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.contents
- Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
translateText
public final TranslateTextResponse translateText(String parent, String model, String mimeType, String sourceLanguageCode, String targetLanguageCode, List<String> contents)
Translates input text and returns translated text.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String model = "model104069929"; String mimeType = "mimeType-1392120434"; String sourceLanguageCode = "sourceLanguageCode1645917472"; String targetLanguageCode = "targetLanguageCode-106414698"; List<String> contents = new ArrayList<>(); TranslateTextResponse response = translationServiceClient.translateText( parent, model, mimeType, sourceLanguageCode, targetLanguageCode, contents); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Non-global location is required for requests using AutoML models or custom glossaries.
Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
model
- Optional. The `model` type requested for this translation.The format depends on model type:
- AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
- General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`.
If not provided, the default Google model (NMT) will be used
mimeType
- Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".sourceLanguageCode
- Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.targetLanguageCode
- Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support.contents
- Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
translateText
public final TranslateTextResponse translateText(TranslateTextRequest request)
Translates input text and returns translated text.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { TranslateTextRequest request = TranslateTextRequest.newBuilder() .addAllContents(new ArrayList<String>()) .setMimeType("mimeType-1392120434") .setSourceLanguageCode("sourceLanguageCode1645917472") .setTargetLanguageCode("targetLanguageCode-106414698") .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setModel("model104069929") .setGlossaryConfig(TranslateTextGlossaryConfig.newBuilder().build()) .putAllLabels(new HashMap<String, String>()) .build(); TranslateTextResponse response = translationServiceClient.translateText(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
translateTextCallable
public final com.google.api.gax.rpc.UnaryCallable<TranslateTextRequest,TranslateTextResponse> translateTextCallable()
Translates input text and returns translated text.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { TranslateTextRequest request = TranslateTextRequest.newBuilder() .addAllContents(new ArrayList<String>()) .setMimeType("mimeType-1392120434") .setSourceLanguageCode("sourceLanguageCode1645917472") .setTargetLanguageCode("targetLanguageCode-106414698") .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setModel("model104069929") .setGlossaryConfig(TranslateTextGlossaryConfig.newBuilder().build()) .putAllLabels(new HashMap<String, String>()) .build(); ApiFuture<TranslateTextResponse> future = translationServiceClient.translateTextCallable().futureCall(request); // Do something. TranslateTextResponse response = future.get(); }
-
detectLanguage
public final DetectLanguageResponse detectLanguage(LocationName parent, String model, String mimeType, String content)
Detects the language of text within a request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String model = "model104069929"; String mimeType = "mimeType-1392120434"; String content = "content951530617"; DetectLanguageResponse response = translationServiceClient.detectLanguage(parent, model, mimeType, content); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
model
- Optional. The language detection model to be used.Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`
Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`.
If not specified, the default model is used.
mimeType
- Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".content
- The content of the input stored as a string.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
detectLanguage
public final DetectLanguageResponse detectLanguage(String parent, String model, String mimeType, String content)
Detects the language of text within a request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String model = "model104069929"; String mimeType = "mimeType-1392120434"; String content = "content951530617"; DetectLanguageResponse response = translationServiceClient.detectLanguage(parent, model, mimeType, content); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
model
- Optional. The language detection model to be used.Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`
Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`.
If not specified, the default model is used.
mimeType
- Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".content
- The content of the input stored as a string.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
detectLanguage
public final DetectLanguageResponse detectLanguage(DetectLanguageRequest request)
Detects the language of text within a request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { DetectLanguageRequest request = DetectLanguageRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setModel("model104069929") .setMimeType("mimeType-1392120434") .putAllLabels(new HashMap<String, String>()) .build(); DetectLanguageResponse response = translationServiceClient.detectLanguage(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
detectLanguageCallable
public final com.google.api.gax.rpc.UnaryCallable<DetectLanguageRequest,DetectLanguageResponse> detectLanguageCallable()
Detects the language of text within a request.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { DetectLanguageRequest request = DetectLanguageRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setModel("model104069929") .setMimeType("mimeType-1392120434") .putAllLabels(new HashMap<String, String>()) .build(); ApiFuture<DetectLanguageResponse> future = translationServiceClient.detectLanguageCallable().futureCall(request); // Do something. DetectLanguageResponse response = future.get(); }
-
getSupportedLanguages
public final SupportedLanguages getSupportedLanguages(LocationName parent, String model, String displayLanguageCode)
Returns a list of supported languages for translation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String model = "model104069929"; String displayLanguageCode = "displayLanguageCode-1457478841"; SupportedLanguages response = translationServiceClient.getSupportedLanguages(parent, model, displayLanguageCode); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Non-global location is required for AutoML models.
Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
model
- Optional. Get supported languages of this model.The format depends on model type:
- AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
- General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.
displayLanguageCode
- Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getSupportedLanguages
public final SupportedLanguages getSupportedLanguages(String parent, String model, String displayLanguageCode)
Returns a list of supported languages for translation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String model = "model104069929"; String displayLanguageCode = "displayLanguageCode-1457478841"; SupportedLanguages response = translationServiceClient.getSupportedLanguages(parent, model, displayLanguageCode); }
- Parameters:
parent
- Required. Project or location to make a call. Must refer to a caller's project.Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`.
For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`.
Non-global location is required for AutoML models.
Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
model
- Optional. Get supported languages of this model.The format depends on model type:
- AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
- General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.
displayLanguageCode
- Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getSupportedLanguages
public final SupportedLanguages getSupportedLanguages(GetSupportedLanguagesRequest request)
Returns a list of supported languages for translation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { GetSupportedLanguagesRequest request = GetSupportedLanguagesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setDisplayLanguageCode("displayLanguageCode-1457478841") .setModel("model104069929") .build(); SupportedLanguages response = translationServiceClient.getSupportedLanguages(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getSupportedLanguagesCallable
public final com.google.api.gax.rpc.UnaryCallable<GetSupportedLanguagesRequest,SupportedLanguages> getSupportedLanguagesCallable()
Returns a list of supported languages for translation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { GetSupportedLanguagesRequest request = GetSupportedLanguagesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setDisplayLanguageCode("displayLanguageCode-1457478841") .setModel("model104069929") .build(); ApiFuture<SupportedLanguages> future = translationServiceClient.getSupportedLanguagesCallable().futureCall(request); // Do something. SupportedLanguages response = future.get(); }
-
translateDocument
public final TranslateDocumentResponse translateDocument(TranslateDocumentRequest request)
Translates documents in synchronous mode.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { TranslateDocumentRequest request = TranslateDocumentRequest.newBuilder() .setParent("parent-995424086") .setSourceLanguageCode("sourceLanguageCode1645917472") .setTargetLanguageCode("targetLanguageCode-106414698") .setDocumentInputConfig(DocumentInputConfig.newBuilder().build()) .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build()) .setModel("model104069929") .setGlossaryConfig(TranslateTextGlossaryConfig.newBuilder().build()) .putAllLabels(new HashMap<String, String>()) .setCustomizedAttribution("customizedAttribution557650238") .setIsTranslateNativePdfOnly(true) .setEnableShadowRemovalNativePdf(true) .setEnableRotationCorrection(true) .build(); TranslateDocumentResponse response = translationServiceClient.translateDocument(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
translateDocumentCallable
public final com.google.api.gax.rpc.UnaryCallable<TranslateDocumentRequest,TranslateDocumentResponse> translateDocumentCallable()
Translates documents in synchronous mode.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { TranslateDocumentRequest request = TranslateDocumentRequest.newBuilder() .setParent("parent-995424086") .setSourceLanguageCode("sourceLanguageCode1645917472") .setTargetLanguageCode("targetLanguageCode-106414698") .setDocumentInputConfig(DocumentInputConfig.newBuilder().build()) .setDocumentOutputConfig(DocumentOutputConfig.newBuilder().build()) .setModel("model104069929") .setGlossaryConfig(TranslateTextGlossaryConfig.newBuilder().build()) .putAllLabels(new HashMap<String, String>()) .setCustomizedAttribution("customizedAttribution557650238") .setIsTranslateNativePdfOnly(true) .setEnableShadowRemovalNativePdf(true) .setEnableRotationCorrection(true) .build(); ApiFuture<TranslateDocumentResponse> future = translationServiceClient.translateDocumentCallable().futureCall(request); // Do something. TranslateDocumentResponse response = future.get(); }
-
batchTranslateTextAsync
public final com.google.api.gax.longrunning.OperationFuture<BatchTranslateResponse,BatchTranslateMetadata> batchTranslateTextAsync(BatchTranslateTextRequest request)
Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { BatchTranslateTextRequest request = BatchTranslateTextRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setSourceLanguageCode("sourceLanguageCode1645917472") .addAllTargetLanguageCodes(new ArrayList<String>()) .putAllModels(new HashMap<String, String>()) .addAllInputConfigs(new ArrayList<InputConfig>()) .setOutputConfig(OutputConfig.newBuilder().build()) .putAllGlossaries(new HashMap<String, TranslateTextGlossaryConfig>()) .putAllLabels(new HashMap<String, String>()) .build(); BatchTranslateResponse response = translationServiceClient.batchTranslateTextAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
batchTranslateTextOperationCallable
public final com.google.api.gax.rpc.OperationCallable<BatchTranslateTextRequest,BatchTranslateResponse,BatchTranslateMetadata> batchTranslateTextOperationCallable()
Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { BatchTranslateTextRequest request = BatchTranslateTextRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setSourceLanguageCode("sourceLanguageCode1645917472") .addAllTargetLanguageCodes(new ArrayList<String>()) .putAllModels(new HashMap<String, String>()) .addAllInputConfigs(new ArrayList<InputConfig>()) .setOutputConfig(OutputConfig.newBuilder().build()) .putAllGlossaries(new HashMap<String, TranslateTextGlossaryConfig>()) .putAllLabels(new HashMap<String, String>()) .build(); OperationFuture<BatchTranslateResponse, BatchTranslateMetadata> future = translationServiceClient.batchTranslateTextOperationCallable().futureCall(request); // Do something. BatchTranslateResponse response = future.get(); }
-
batchTranslateTextCallable
public final com.google.api.gax.rpc.UnaryCallable<BatchTranslateTextRequest,com.google.longrunning.Operation> batchTranslateTextCallable()
Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { BatchTranslateTextRequest request = BatchTranslateTextRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setSourceLanguageCode("sourceLanguageCode1645917472") .addAllTargetLanguageCodes(new ArrayList<String>()) .putAllModels(new HashMap<String, String>()) .addAllInputConfigs(new ArrayList<InputConfig>()) .setOutputConfig(OutputConfig.newBuilder().build()) .putAllGlossaries(new HashMap<String, TranslateTextGlossaryConfig>()) .putAllLabels(new HashMap<String, String>()) .build(); ApiFuture<Operation> future = translationServiceClient.batchTranslateTextCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
batchTranslateDocumentAsync
public final com.google.api.gax.longrunning.OperationFuture<BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata> batchTranslateDocumentAsync(LocationName parent, String sourceLanguageCode, List<String> targetLanguageCodes, List<BatchDocumentInputConfig> inputConfigs, BatchDocumentOutputConfig outputConfig)
Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String sourceLanguageCode = "sourceLanguageCode1645917472"; List<String> targetLanguageCodes = new ArrayList<>(); List<BatchDocumentInputConfig> inputConfigs = new ArrayList<>(); BatchDocumentOutputConfig outputConfig = BatchDocumentOutputConfig.newBuilder().build(); BatchTranslateDocumentResponse response = translationServiceClient .batchTranslateDocumentAsync( parent, sourceLanguageCode, targetLanguageCodes, inputConfigs, outputConfig) .get(); }
- Parameters:
parent
- Required. Location to make a regional call.Format: `projects/{project-number-or-id}/locations/{location-id}`.
The `global` location is not supported for batch translation.
Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
sourceLanguageCode
- Required. The ISO-639 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages).targetLanguageCodes
- Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.inputConfigs
- Required. Input configurations. The total number of files matched should be <= 100. The total content size to translate should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.outputConfig
- Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
batchTranslateDocumentAsync
public final com.google.api.gax.longrunning.OperationFuture<BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata> batchTranslateDocumentAsync(String parent, String sourceLanguageCode, List<String> targetLanguageCodes, List<BatchDocumentInputConfig> inputConfigs, BatchDocumentOutputConfig outputConfig)
Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String sourceLanguageCode = "sourceLanguageCode1645917472"; List<String> targetLanguageCodes = new ArrayList<>(); List<BatchDocumentInputConfig> inputConfigs = new ArrayList<>(); BatchDocumentOutputConfig outputConfig = BatchDocumentOutputConfig.newBuilder().build(); BatchTranslateDocumentResponse response = translationServiceClient .batchTranslateDocumentAsync( parent, sourceLanguageCode, targetLanguageCodes, inputConfigs, outputConfig) .get(); }
- Parameters:
parent
- Required. Location to make a regional call.Format: `projects/{project-number-or-id}/locations/{location-id}`.
The `global` location is not supported for batch translation.
Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
sourceLanguageCode
- Required. The ISO-639 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in [Language Support](https://cloud.google.com/translate/docs/languages).targetLanguageCodes
- Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.inputConfigs
- Required. Input configurations. The total number of files matched should be <= 100. The total content size to translate should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.outputConfig
- Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
batchTranslateDocumentAsync
public final com.google.api.gax.longrunning.OperationFuture<BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata> batchTranslateDocumentAsync(BatchTranslateDocumentRequest request)
Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { BatchTranslateDocumentRequest request = BatchTranslateDocumentRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setSourceLanguageCode("sourceLanguageCode1645917472") .addAllTargetLanguageCodes(new ArrayList<String>()) .addAllInputConfigs(new ArrayList<BatchDocumentInputConfig>()) .setOutputConfig(BatchDocumentOutputConfig.newBuilder().build()) .putAllModels(new HashMap<String, String>()) .putAllGlossaries(new HashMap<String, TranslateTextGlossaryConfig>()) .putAllFormatConversions(new HashMap<String, String>()) .setCustomizedAttribution("customizedAttribution557650238") .setEnableShadowRemovalNativePdf(true) .setEnableRotationCorrection(true) .build(); BatchTranslateDocumentResponse response = translationServiceClient.batchTranslateDocumentAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
batchTranslateDocumentOperationCallable
public final com.google.api.gax.rpc.OperationCallable<BatchTranslateDocumentRequest,BatchTranslateDocumentResponse,BatchTranslateDocumentMetadata> batchTranslateDocumentOperationCallable()
Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { BatchTranslateDocumentRequest request = BatchTranslateDocumentRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setSourceLanguageCode("sourceLanguageCode1645917472") .addAllTargetLanguageCodes(new ArrayList<String>()) .addAllInputConfigs(new ArrayList<BatchDocumentInputConfig>()) .setOutputConfig(BatchDocumentOutputConfig.newBuilder().build()) .putAllModels(new HashMap<String, String>()) .putAllGlossaries(new HashMap<String, TranslateTextGlossaryConfig>()) .putAllFormatConversions(new HashMap<String, String>()) .setCustomizedAttribution("customizedAttribution557650238") .setEnableShadowRemovalNativePdf(true) .setEnableRotationCorrection(true) .build(); OperationFuture<BatchTranslateDocumentResponse, BatchTranslateDocumentMetadata> future = translationServiceClient.batchTranslateDocumentOperationCallable().futureCall(request); // Do something. BatchTranslateDocumentResponse response = future.get(); }
-
batchTranslateDocumentCallable
public final com.google.api.gax.rpc.UnaryCallable<BatchTranslateDocumentRequest,com.google.longrunning.Operation> batchTranslateDocumentCallable()
Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { BatchTranslateDocumentRequest request = BatchTranslateDocumentRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setSourceLanguageCode("sourceLanguageCode1645917472") .addAllTargetLanguageCodes(new ArrayList<String>()) .addAllInputConfigs(new ArrayList<BatchDocumentInputConfig>()) .setOutputConfig(BatchDocumentOutputConfig.newBuilder().build()) .putAllModels(new HashMap<String, String>()) .putAllGlossaries(new HashMap<String, TranslateTextGlossaryConfig>()) .putAllFormatConversions(new HashMap<String, String>()) .setCustomizedAttribution("customizedAttribution557650238") .setEnableShadowRemovalNativePdf(true) .setEnableRotationCorrection(true) .build(); ApiFuture<Operation> future = translationServiceClient.batchTranslateDocumentCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
createGlossaryAsync
public final com.google.api.gax.longrunning.OperationFuture<Glossary,CreateGlossaryMetadata> createGlossaryAsync(LocationName parent, Glossary glossary)
Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); Glossary glossary = Glossary.newBuilder().build(); Glossary response = translationServiceClient.createGlossaryAsync(parent, glossary).get(); }
- Parameters:
parent
- Required. The project name.glossary
- Required. The glossary to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createGlossaryAsync
public final com.google.api.gax.longrunning.OperationFuture<Glossary,CreateGlossaryMetadata> createGlossaryAsync(String parent, Glossary glossary)
Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); Glossary glossary = Glossary.newBuilder().build(); Glossary response = translationServiceClient.createGlossaryAsync(parent, glossary).get(); }
- Parameters:
parent
- Required. The project name.glossary
- Required. The glossary to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createGlossaryAsync
public final com.google.api.gax.longrunning.OperationFuture<Glossary,CreateGlossaryMetadata> createGlossaryAsync(CreateGlossaryRequest request)
Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { CreateGlossaryRequest request = CreateGlossaryRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setGlossary(Glossary.newBuilder().build()) .build(); Glossary response = translationServiceClient.createGlossaryAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createGlossaryOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateGlossaryRequest,Glossary,CreateGlossaryMetadata> createGlossaryOperationCallable()
Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { CreateGlossaryRequest request = CreateGlossaryRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setGlossary(Glossary.newBuilder().build()) .build(); OperationFuture<Glossary, CreateGlossaryMetadata> future = translationServiceClient.createGlossaryOperationCallable().futureCall(request); // Do something. Glossary response = future.get(); }
-
createGlossaryCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateGlossaryRequest,com.google.longrunning.Operation> createGlossaryCallable()
Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { CreateGlossaryRequest request = CreateGlossaryRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setGlossary(Glossary.newBuilder().build()) .build(); ApiFuture<Operation> future = translationServiceClient.createGlossaryCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listGlossaries
public final TranslationServiceClient.ListGlossariesPagedResponse listGlossaries(LocationName parent)
Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Glossary element : translationServiceClient.listGlossaries(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The name of the project from which to list all of the glossaries.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listGlossaries
public final TranslationServiceClient.ListGlossariesPagedResponse listGlossaries(String parent)
Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Glossary element : translationServiceClient.listGlossaries(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The name of the project from which to list all of the glossaries.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listGlossaries
public final TranslationServiceClient.ListGlossariesPagedResponse listGlossaries(ListGlossariesRequest request)
Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { ListGlossariesRequest request = ListGlossariesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (Glossary element : translationServiceClient.listGlossaries(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listGlossariesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListGlossariesRequest,TranslationServiceClient.ListGlossariesPagedResponse> listGlossariesPagedCallable()
Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { ListGlossariesRequest request = ListGlossariesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); ApiFuture<Glossary> future = translationServiceClient.listGlossariesPagedCallable().futureCall(request); // Do something. for (Glossary element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listGlossariesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListGlossariesRequest,ListGlossariesResponse> listGlossariesCallable()
Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { ListGlossariesRequest request = ListGlossariesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); while (true) { ListGlossariesResponse response = translationServiceClient.listGlossariesCallable().call(request); for (Glossary element : response.getGlossariesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getGlossary
public final Glossary getGlossary(GlossaryName name)
Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { GlossaryName name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]"); Glossary response = translationServiceClient.getGlossary(name); }
- Parameters:
name
- Required. The name of the glossary to retrieve.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getGlossary
public final Glossary getGlossary(String name)
Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString(); Glossary response = translationServiceClient.getGlossary(name); }
- Parameters:
name
- Required. The name of the glossary to retrieve.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getGlossary
public final Glossary getGlossary(GetGlossaryRequest request)
Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { GetGlossaryRequest request = GetGlossaryRequest.newBuilder() .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString()) .build(); Glossary response = translationServiceClient.getGlossary(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getGlossaryCallable
public final com.google.api.gax.rpc.UnaryCallable<GetGlossaryRequest,Glossary> getGlossaryCallable()
Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { GetGlossaryRequest request = GetGlossaryRequest.newBuilder() .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString()) .build(); ApiFuture<Glossary> future = translationServiceClient.getGlossaryCallable().futureCall(request); // Do something. Glossary response = future.get(); }
-
deleteGlossaryAsync
public final com.google.api.gax.longrunning.OperationFuture<DeleteGlossaryResponse,DeleteGlossaryMetadata> deleteGlossaryAsync(GlossaryName name)
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { GlossaryName name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]"); DeleteGlossaryResponse response = translationServiceClient.deleteGlossaryAsync(name).get(); }
- Parameters:
name
- Required. The name of the glossary to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteGlossaryAsync
public final com.google.api.gax.longrunning.OperationFuture<DeleteGlossaryResponse,DeleteGlossaryMetadata> deleteGlossaryAsync(String name)
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { String name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString(); DeleteGlossaryResponse response = translationServiceClient.deleteGlossaryAsync(name).get(); }
- Parameters:
name
- Required. The name of the glossary to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteGlossaryAsync
public final com.google.api.gax.longrunning.OperationFuture<DeleteGlossaryResponse,DeleteGlossaryMetadata> deleteGlossaryAsync(DeleteGlossaryRequest request)
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { DeleteGlossaryRequest request = DeleteGlossaryRequest.newBuilder() .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString()) .build(); DeleteGlossaryResponse response = translationServiceClient.deleteGlossaryAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteGlossaryOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteGlossaryRequest,DeleteGlossaryResponse,DeleteGlossaryMetadata> deleteGlossaryOperationCallable()
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { DeleteGlossaryRequest request = DeleteGlossaryRequest.newBuilder() .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString()) .build(); OperationFuture<DeleteGlossaryResponse, DeleteGlossaryMetadata> future = translationServiceClient.deleteGlossaryOperationCallable().futureCall(request); // Do something. DeleteGlossaryResponse response = future.get(); }
-
deleteGlossaryCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteGlossaryRequest,com.google.longrunning.Operation> deleteGlossaryCallable()
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) { DeleteGlossaryRequest request = DeleteGlossaryRequest.newBuilder() .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString()) .build(); ApiFuture<Operation> future = translationServiceClient.deleteGlossaryCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-