com.google.cloud.dialogflow.v2.spring.VersionsSpringAutoConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 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
 *
 *      https://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.dialogflow.v2.spring;

import com.google.api.core.BetaApi;
import com.google.api.gax.core.CredentialsProvider;
import com.google.api.gax.core.ExecutorProvider;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.HeaderProvider;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.cloud.dialogflow.v2.VersionsClient;
import com.google.cloud.dialogflow.v2.VersionsSettings;
import com.google.cloud.spring.autoconfigure.core.GcpContextAutoConfiguration;
import com.google.cloud.spring.core.DefaultCredentialsProvider;
import com.google.cloud.spring.core.Retry;
import com.google.cloud.spring.core.util.RetryUtil;
import java.io.IOException;
import java.util.Collections;
import javax.annotation.Generated;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Auto-configuration for {@link VersionsClient}.
 *
 * Provides auto-configuration for Spring Boot
 *
 * 
The default instance has everything set to sensible defaults:
 *
 * 

 *   The default transport provider is used.
 *   
Credentials are acquired automatically through Application Default Credentials.
 *   
Retries are configured for idempotent methods but not for non-idempotent methods.
 * 
 */
@Generated("by google-cloud-spring-generator")
@BetaApi("Autogenerated Spring autoconfiguration is not yet stable")
@AutoConfiguration
@AutoConfigureAfter(GcpContextAutoConfiguration.class)
@ConditionalOnClass(VersionsClient.class)
@ConditionalOnProperty(
    value = "com.google.cloud.dialogflow.v2.versions.enabled",
    matchIfMissing = true)
@EnableConfigurationProperties(VersionsSpringProperties.class)
public class VersionsSpringAutoConfiguration {
  private final VersionsSpringProperties clientProperties;
  private final CredentialsProvider credentialsProvider;
  private static final Log LOGGER = LogFactory.getLog(VersionsSpringAutoConfiguration.class);

  protected VersionsSpringAutoConfiguration(
      VersionsSpringProperties clientProperties, CredentialsProvider credentialsProvider)
      throws IOException {
    this.clientProperties = clientProperties;
    if (this.clientProperties.getCredentials().hasKey()) {
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Using credentials from Versions-specific configuration");
      }
      this.credentialsProvider =
          ((CredentialsProvider) new DefaultCredentialsProvider(this.clientProperties));
    } else {
      this.credentialsProvider = credentialsProvider;
    }
  }

  /**
   * Provides a default transport channel provider bean, corresponding to the client library's
   * default transport channel provider. If the library supports both GRPC and REST transport, and
   * the useRest property is configured, the HTTP/JSON transport provider will be used instead of
   * GRPC.
   *
   * @return a default transport channel provider.
   */
  @Bean
  @ConditionalOnMissingBean(name = "defaultVersionsTransportChannelProvider")
  public TransportChannelProvider defaultVersionsTransportChannelProvider() {
    if (this.clientProperties.getUseRest()) {
      return VersionsSettings.defaultHttpJsonTransportProviderBuilder().build();
    }
    return VersionsSettings.defaultTransportChannelProvider();
  }

  /**
   * Provides a VersionsSettings bean configured to use a DefaultCredentialsProvider and the client
   * library's default transport channel provider (defaultVersionsTransportChannelProvider()). It
   * also configures the quota project ID and executor thread count, if provided through properties.
   *
   * Retry settings are also configured from service-level and method-level properties specified
   * in VersionsSpringProperties. Method-level properties will take precedence over service-level
   * properties if available, and client library defaults will be used if neither are specified.
   *
   * @param defaultTransportChannelProvider TransportChannelProvider to use in the settings.
   * @return a {@link VersionsSettings} bean configured with {@link TransportChannelProvider} bean.
   */
  @Bean
  @ConditionalOnMissingBean
  public VersionsSettings versionsSettings(
      @Qualifier("defaultVersionsTransportChannelProvider")
          TransportChannelProvider defaultTransportChannelProvider)
      throws IOException {
    VersionsSettings.Builder clientSettingsBuilder;
    if (this.clientProperties.getUseRest()) {
      clientSettingsBuilder = VersionsSettings.newHttpJsonBuilder();
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Using REST (HTTP/JSON) transport.");
      }
    } else {
      clientSettingsBuilder = VersionsSettings.newBuilder();
    }
    clientSettingsBuilder
        .setCredentialsProvider(this.credentialsProvider)
        .setTransportChannelProvider(defaultTransportChannelProvider)
        .setEndpoint(VersionsSettings.getDefaultEndpoint())
        .setHeaderProvider(this.userAgentHeaderProvider());
    if (this.clientProperties.getQuotaProjectId() != null) {
      clientSettingsBuilder.setQuotaProjectId(this.clientProperties.getQuotaProjectId());
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace(
            "Quota project id set to "
                + this.clientProperties.getQuotaProjectId()
                + ", this overrides project id from credentials.");
      }
    }
    if (this.clientProperties.getExecutorThreadCount() != null) {
      ExecutorProvider executorProvider =
          VersionsSettings.defaultExecutorProviderBuilder()
              .setExecutorThreadCount(this.clientProperties.getExecutorThreadCount())
              .build();
      clientSettingsBuilder.setBackgroundExecutorProvider(executorProvider);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace(
            "Background executor thread count is "
                + this.clientProperties.getExecutorThreadCount());
      }
    }
    Retry serviceRetry = clientProperties.getRetry();
    if (serviceRetry != null) {
      RetrySettings listVersionsRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.listVersionsSettings().getRetrySettings(), serviceRetry);
      clientSettingsBuilder.listVersionsSettings().setRetrySettings(listVersionsRetrySettings);

      RetrySettings getVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.getVersionSettings().getRetrySettings(), serviceRetry);
      clientSettingsBuilder.getVersionSettings().setRetrySettings(getVersionRetrySettings);

      RetrySettings createVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.createVersionSettings().getRetrySettings(), serviceRetry);
      clientSettingsBuilder.createVersionSettings().setRetrySettings(createVersionRetrySettings);

      RetrySettings updateVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.updateVersionSettings().getRetrySettings(), serviceRetry);
      clientSettingsBuilder.updateVersionSettings().setRetrySettings(updateVersionRetrySettings);

      RetrySettings deleteVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.deleteVersionSettings().getRetrySettings(), serviceRetry);
      clientSettingsBuilder.deleteVersionSettings().setRetrySettings(deleteVersionRetrySettings);

      RetrySettings listLocationsRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.listLocationsSettings().getRetrySettings(), serviceRetry);
      clientSettingsBuilder.listLocationsSettings().setRetrySettings(listLocationsRetrySettings);

      RetrySettings getLocationRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.getLocationSettings().getRetrySettings(), serviceRetry);
      clientSettingsBuilder.getLocationSettings().setRetrySettings(getLocationRetrySettings);

      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured service-level retry settings from properties.");
      }
    }
    Retry listVersionsRetry = clientProperties.getListVersionsRetry();
    if (listVersionsRetry != null) {
      RetrySettings listVersionsRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.listVersionsSettings().getRetrySettings(), listVersionsRetry);
      clientSettingsBuilder.listVersionsSettings().setRetrySettings(listVersionsRetrySettings);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured method-level retry settings for listVersions from properties.");
      }
    }
    Retry getVersionRetry = clientProperties.getGetVersionRetry();
    if (getVersionRetry != null) {
      RetrySettings getVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.getVersionSettings().getRetrySettings(), getVersionRetry);
      clientSettingsBuilder.getVersionSettings().setRetrySettings(getVersionRetrySettings);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured method-level retry settings for getVersion from properties.");
      }
    }
    Retry createVersionRetry = clientProperties.getCreateVersionRetry();
    if (createVersionRetry != null) {
      RetrySettings createVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.createVersionSettings().getRetrySettings(), createVersionRetry);
      clientSettingsBuilder.createVersionSettings().setRetrySettings(createVersionRetrySettings);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured method-level retry settings for createVersion from properties.");
      }
    }
    Retry updateVersionRetry = clientProperties.getUpdateVersionRetry();
    if (updateVersionRetry != null) {
      RetrySettings updateVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.updateVersionSettings().getRetrySettings(), updateVersionRetry);
      clientSettingsBuilder.updateVersionSettings().setRetrySettings(updateVersionRetrySettings);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured method-level retry settings for updateVersion from properties.");
      }
    }
    Retry deleteVersionRetry = clientProperties.getDeleteVersionRetry();
    if (deleteVersionRetry != null) {
      RetrySettings deleteVersionRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.deleteVersionSettings().getRetrySettings(), deleteVersionRetry);
      clientSettingsBuilder.deleteVersionSettings().setRetrySettings(deleteVersionRetrySettings);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured method-level retry settings for deleteVersion from properties.");
      }
    }
    Retry listLocationsRetry = clientProperties.getListLocationsRetry();
    if (listLocationsRetry != null) {
      RetrySettings listLocationsRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.listLocationsSettings().getRetrySettings(), listLocationsRetry);
      clientSettingsBuilder.listLocationsSettings().setRetrySettings(listLocationsRetrySettings);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured method-level retry settings for listLocations from properties.");
      }
    }
    Retry getLocationRetry = clientProperties.getGetLocationRetry();
    if (getLocationRetry != null) {
      RetrySettings getLocationRetrySettings =
          RetryUtil.updateRetrySettings(
              clientSettingsBuilder.getLocationSettings().getRetrySettings(), getLocationRetry);
      clientSettingsBuilder.getLocationSettings().setRetrySettings(getLocationRetrySettings);
      if (LOGGER.isTraceEnabled()) {
        LOGGER.trace("Configured method-level retry settings for getLocation from properties.");
      }
    }
    return clientSettingsBuilder.build();
  }

  /**
   * Provides a VersionsClient bean configured with VersionsSettings.
   *
   * @param versionsSettings settings to configure an instance of client bean.
   * @return a {@link VersionsClient} bean configured with {@link VersionsSettings}
   */
  @Bean
  @ConditionalOnMissingBean
  public VersionsClient versionsClient(VersionsSettings versionsSettings) throws IOException {
    return VersionsClient.create(versionsSettings);
  }

  private HeaderProvider userAgentHeaderProvider() {
    String springLibrary = "spring-autogen-versions";
    String version = this.getClass().getPackage().getImplementationVersion();
    return () -> Collections.singletonMap("user-agent", springLibrary + "/" + version);
  }
}