Google Cloud Translation Client for Java

Java idiomatic client for Cloud Translation.

• Product Documentation
• Client Library Documentation

🚌 In October 2022, this library has moved to google-cloud-java/java-translate. This repository will be archived in the future. Future releases will appear in the new repository (https://github.com/googleapis/google-cloud-java/releases). The Maven artifact coordinates (com.google.cloud:google-cloud-translate) remain the same.

Quickstart

If you are using Maven with BOM, add this to your pom.xml file:

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.1.3</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-translate</artifactId>
  </dependency>
</dependencies>

If you are using Maven without BOM, add this to your dependencies:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-translate</artifactId>
  <version>2.3.5</version>
</dependency>

If you are using Gradle 5.x or later, add this to your dependencies:

implementation platform('com.google.cloud:libraries-bom:26.1.4')

implementation 'com.google.cloud:google-cloud-translate'

If you are using Gradle without BOM, add this to your dependencies:

implementation 'com.google.cloud:google-cloud-translate:2.6.0'

If you are using SBT, add this to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-translate" % "2.6.0"

Authentication

See the Authentication section in the base directory's README.

Authorization

The client application making API calls must be granted authorization scopes required for the desired Cloud Translation APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Cloud Translation API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Cloud Translation API enabled. You will need to enable billing to use Google Cloud Translation. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google Cloud SDK and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the google-cloud-translate library. See the Quickstart section to add google-cloud-translate as a dependency in your code.

About Cloud Translation

Cloud Translation can dynamically translate text between thousands of language pairs. Translation lets websites and programs programmatically integrate with the translation service.

See the Cloud Translation client library docs to learn how to use this Cloud Translation Client Library.

Example Application

TranslateExample is a simple command line interface that provides some of Google Translation's functionality.

Creating an authorized service object

To make authenticated requests to Google Translation, you must create a service object with credentials or use an API key. The simplest way to authenticate is to use Application Default Credentials. These credentials are automatically inferred from your environment, so you only need the following code to create your service object:

import com.google.cloud.translate.Translate;
import com.google.cloud.translate.TranslateOptions;

Translate translate = TranslateOptions.getDefaultInstance().getService();

Notice that this code can be also used with an API key. By default, an API key is looked for in the GOOGLE_API_KEY environment variable. Once the API key is set, you can make API calls by invoking methods on the Translation service created via TranslateOptions.getDefaultInstance().getService().

You can also explicitly set the API key as follows:

Translate translate = TranslateOptions.newBuilder().setApiKey("myKey").build().getService();

Detecting language

With Google Translation you can detect the language of some text. The service will provide you with the code of the detected language and a level of confidence.

Add the following import at the top of your file:

import com.google.cloud.translate.Detection;

Then pick a text sample:

final String mysteriousText = "Hola Mundo";

Then add the following code to detect the text's language:

Detection detection = translate.detect(mysteriousText);
String detectedLanguage = detection.getLanguage();

Translating text

Google translation allows you to translate some text. When translating one or more texts you can either provide the source language or let the service detect it for you.

Add the following imports at the top of your file:

import com.google.cloud.translate.Translate.TranslateOption;
import com.google.cloud.translate.Translation;

Then add the following code to translate the text, specifying the previously detected language (detectedLanguage) as its source language and English as the target language (providing the source language is optional, if it is not specified the service will try to detect it automatically):

Translation translation = translate.translate(
    mysteriousText,
    TranslateOption.sourceLanguage(detectedLanguage),
    TranslateOption.targetLanguage("en"));

Complete source code

In DetectLanguageAndTranslate.java we put together all the code shown above into one program. The program assumes that either Application Default Credentials or a valid API key are available.

Samples

Samples are in the samples/ directory.

Sample	Source Code	Try it
Quickstart Sample	source code
Translate Text With Glossary And Model	source code
Batch Translate Document	source code
Translate Document	source code

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Cloud Translation uses both gRPC and HTTP/JSON for the transport layer.

Supported Java Versions

Java 8 or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

For new development

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Keeping production systems current

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Legacy support

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

Where to find specific information

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

Versioning

This library follows Semantic Versioning.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.

CI Status

Java Version	Status
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.