com.google.cloud.translate.TranslateOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-translate Show documentation
Java idiomatic client for Google Cloud Translate
There is a newer version: 2.54.0
Show newest version
/*
 * Copyright 2016 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.translate;

import static com.google.common.base.MoreObjects.firstNonNull;

import com.google.auth.Credentials;
import com.google.cloud.ServiceDefaults;
import com.google.cloud.ServiceOptions;
import com.google.cloud.ServiceRpc;
import com.google.cloud.TransportOptions;
import com.google.cloud.http.HttpTransportOptions;
import com.google.cloud.translate.Translate.TranslateOption;
import com.google.cloud.translate.spi.TranslateRpcFactory;
import com.google.cloud.translate.spi.v2.HttpTranslateRpc;
import com.google.cloud.translate.spi.v2.TranslateRpc;
import com.google.common.collect.ImmutableSet;
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;

public class TranslateOptions extends ServiceOptions {
  private static final long serialVersionUID = -572597134540398216L;
  private static final Logger logger = Logger.getLogger(TranslateOptions.class.getName());

  public static final String API_KEY_ENV_NAME = "GOOGLE_API_KEY";

  private static final String API_SHORT_NAME = "Translate";
  private static final String DEFAULT_HOST = "https://translation.googleapis.com";
  private static final Set SCOPES =
      ImmutableSet.of("https://www.googleapis.com/auth/cloud-platform");

  private final String apiKey;
  private final String targetLanguage;

  public static class DefaultTranslateFactory implements TranslateFactory {

    private static final TranslateFactory INSTANCE = new DefaultTranslateFactory();

    @Override
    public Translate create(TranslateOptions options) {
      return new TranslateImpl(options);
    }
  }

  public static class DefaultTranslateRpcFactory implements TranslateRpcFactory {

    private static final TranslateRpcFactory INSTANCE = new DefaultTranslateRpcFactory();

    @Override
    public ServiceRpc create(TranslateOptions options) {
      return new HttpTranslateRpc(options);
    }
  }

  public static class Builder extends ServiceOptions.Builder {

    private String apiKey;
    private String targetLanguage;

    private Builder() {}

    private Builder(TranslateOptions options) {
      super(options);
      this.apiKey = options.apiKey;
    }

    /** Returns the authentication credentials. */
    public Credentials getCredentials() {
      return credentials;
    }

    @Override
    public Builder setTransportOptions(TransportOptions transportOptions) {
      if (!(transportOptions instanceof HttpTransportOptions)) {
        throw new IllegalArgumentException(
            "Only http transport is allowed for " + API_SHORT_NAME + ".");
      }
      return super.setTransportOptions(transportOptions);
    }

    /**
     * Sets the project ID. Setting a project ID has no impact on the {@link Translate} service.
     *
     * @return the builder
     */
    @Override
    public Builder setProjectId(String projectId) {
      super.setProjectId(projectId);
      return self();
    }

    /**
     * Sets the API key used to issue requests. This will be ignored if credentials are explicitly
     * set with {@link ServiceOptions.Builder#setCredentials setCredentials}. If neither are set,
     * and no Application Default Credentials are available, an API key is looked for in the {@code
     * GOOGLE_API_KEY} environment variable. For instructions on how to get an API key, see the Translate Quickstart.
     */
    @Deprecated
    public Builder setApiKey(String apiKey) {
      this.apiKey = apiKey;
      return this;
    }

    /**
     * Sets the code for the default target language. If not set, English ({@code en}) is used.
     * Calls to {@link Translate#translate(List, TranslateOption...)} and {@link
     * Translate#translate(String, TranslateOption...)} will use this value unless an option from
     * {@link TranslateOption#targetLanguage(String)} is explicitly provided.
     *
     * @return the builder
     */
    public Builder setTargetLanguage(String targetLanguage) {
      this.targetLanguage = targetLanguage;
      return self();
    }

    @Override
    public TranslateOptions build() {
      return new TranslateOptions(this);
    }
  }

  private TranslateOptions(Builder builder) {
    super(TranslateFactory.class, TranslateRpcFactory.class, builder, new TranslateDefaults());
    // Use following order of precedence for authentication, avoiding backend conflicts (#1405):
    // 1. explicitly set credentials
    // 2. explicitly set API key
    // 3. Application Default Credentials (e.g., through GOOGLE_APPLICATION_CREDENTIALS)
    // 4. default API key (through GOOGLE_API_KEY)
    if (builder.getCredentials() != null) {
      // credentials assigned from builder in superclass constructor
      apiKey = null;
      if (builder.apiKey != null) {
        logger.log(
            Level.WARNING, "Ignoring API key: using explicit setting for credentials instead.");
      } else if (getDefaultApiKey() != null) {
        logger.log(
            Level.WARNING,
            "Ignoring API key set in environment variable {0}: using explicit setting for credentials instead.",
            API_KEY_ENV_NAME);
      }
    } else if (builder.apiKey != null) {
      credentials = null;
      apiKey = builder.apiKey;
      logger.log(
          Level.WARNING,
          "Ignoring Application Default Credentials {0}: using explicit setting for API key instead.",
          ServiceOptions.CREDENTIAL_ENV_NAME);
    } else if (credentials != null) { // credentials assigned from ADC in superclass constructor
      apiKey = null;
      if (getDefaultApiKey() != null) {
        logger.log(
            Level.WARNING,
            "Ignoring API key set in environment variable {0}: using Application Default Credentials instead.",
            API_KEY_ENV_NAME);
      }
    } else {
      apiKey = getDefaultApiKey();
    }
    targetLanguage = firstNonNull(builder.targetLanguage, Locale.ENGLISH.getLanguage());
  }

  private static class TranslateDefaults implements ServiceDefaults {

    @Override
    public TranslateFactory getDefaultServiceFactory() {
      return DefaultTranslateFactory.INSTANCE;
    }

    @Override
    public TranslateRpcFactory getDefaultRpcFactory() {
      return DefaultTranslateRpcFactory.INSTANCE;
    }

    @Override
    public TransportOptions getDefaultTransportOptions() {
      return getDefaultHttpTransportOptions();
    }
  }

  public static HttpTransportOptions getDefaultHttpTransportOptions() {
    return HttpTransportOptions.newBuilder().build();
  }

  public static String getDefaultApiKey() {
    return System.getProperty(API_KEY_ENV_NAME, System.getenv(API_KEY_ENV_NAME));
  }

  @Override
  protected boolean projectIdRequired() {
    return false;
  }

  @Override
  protected Set getScopes() {
    return SCOPES;
  }

  protected TranslateRpc getTranslateRpcV2() {
    return (TranslateRpc) getRpc();
  }

  @Override
  protected String getDefaultHost() {
    return DEFAULT_HOST;
  }

  /** Returns the API key to be used to send requests. */
  public String getApiKey() {
    return apiKey;
  }

  /** Returns the code for the default target language. */
  public String getTargetLanguage() {
    return targetLanguage;
  }

  @SuppressWarnings("unchecked")
  @Override
  public Builder toBuilder() {
    return new Builder(this);
  }

  @Override
  public int hashCode() {
    return baseHashCode();
  }

  @Override
  public boolean equals(Object obj) {
    if (!(obj instanceof TranslateOptions)) {
      return false;
    }
    TranslateOptions options = (TranslateOptions) obj;
    return baseEquals(options)
        && Objects.equals(apiKey, options.apiKey)
        && Objects.equals(targetLanguage, options.targetLanguage);
  }

  /** Returns a default {@code TranslateOptions} instance. */
  public static TranslateOptions getDefaultInstance() {
    return newBuilder().build();
  }

  /** Returns a builder for {@code TranslateOptions} objects. */
  public static Builder newBuilder() {
    return new Builder();
  }
}