All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.cloud.talent.v4.spring.CompletionSpringAutoConfiguration Maven / Gradle / Ivy

The newest version!
/*
 * 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.talent.v4.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.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 com.google.cloud.talent.v4.CompletionClient;
import com.google.cloud.talent.v4.CompletionSettings;
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 CompletionClient}.
 *
 * 

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(CompletionClient.class) @ConditionalOnProperty( value = "com.google.cloud.talent.v4.completion.enabled", matchIfMissing = true) @EnableConfigurationProperties(CompletionSpringProperties.class) public class CompletionSpringAutoConfiguration { private final CompletionSpringProperties clientProperties; private final CredentialsProvider credentialsProvider; private static final Log LOGGER = LogFactory.getLog(CompletionSpringAutoConfiguration.class); protected CompletionSpringAutoConfiguration( CompletionSpringProperties clientProperties, CredentialsProvider credentialsProvider) throws IOException { this.clientProperties = clientProperties; if (this.clientProperties.getCredentials().hasKey()) { if (LOGGER.isTraceEnabled()) { LOGGER.trace("Using credentials from Completion-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 = "defaultCompletionTransportChannelProvider") public TransportChannelProvider defaultCompletionTransportChannelProvider() { if (this.clientProperties.getUseRest()) { return CompletionSettings.defaultHttpJsonTransportProviderBuilder().build(); } return CompletionSettings.defaultTransportChannelProvider(); } /** * Provides a CompletionSettings bean configured to use a DefaultCredentialsProvider and the * client library's default transport channel provider * (defaultCompletionTransportChannelProvider()). 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 CompletionSpringProperties. 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 CompletionSettings} bean configured with {@link TransportChannelProvider} * bean. */ @Bean @ConditionalOnMissingBean public CompletionSettings completionSettings( @Qualifier("defaultCompletionTransportChannelProvider") TransportChannelProvider defaultTransportChannelProvider) throws IOException { CompletionSettings.Builder clientSettingsBuilder; if (this.clientProperties.getUseRest()) { clientSettingsBuilder = CompletionSettings.newHttpJsonBuilder(); if (LOGGER.isTraceEnabled()) { LOGGER.trace("Using REST (HTTP/JSON) transport."); } } else { clientSettingsBuilder = CompletionSettings.newBuilder(); } clientSettingsBuilder .setCredentialsProvider(this.credentialsProvider) .setTransportChannelProvider(defaultTransportChannelProvider) .setEndpoint(CompletionSettings.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 = CompletionSettings.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 completeQueryRetrySettings = RetryUtil.updateRetrySettings( clientSettingsBuilder.completeQuerySettings().getRetrySettings(), serviceRetry); clientSettingsBuilder.completeQuerySettings().setRetrySettings(completeQueryRetrySettings); if (LOGGER.isTraceEnabled()) { LOGGER.trace("Configured service-level retry settings from properties."); } } Retry completeQueryRetry = clientProperties.getCompleteQueryRetry(); if (completeQueryRetry != null) { RetrySettings completeQueryRetrySettings = RetryUtil.updateRetrySettings( clientSettingsBuilder.completeQuerySettings().getRetrySettings(), completeQueryRetry); clientSettingsBuilder.completeQuerySettings().setRetrySettings(completeQueryRetrySettings); if (LOGGER.isTraceEnabled()) { LOGGER.trace("Configured method-level retry settings for completeQuery from properties."); } } return clientSettingsBuilder.build(); } /** * Provides a CompletionClient bean configured with CompletionSettings. * * @param completionSettings settings to configure an instance of client bean. * @return a {@link CompletionClient} bean configured with {@link CompletionSettings} */ @Bean @ConditionalOnMissingBean public CompletionClient completionClient(CompletionSettings completionSettings) throws IOException { return CompletionClient.create(completionSettings); } private HeaderProvider userAgentHeaderProvider() { String springLibrary = "spring-autogen-completion"; String version = this.getClass().getPackage().getImplementationVersion(); return () -> Collections.singletonMap("user-agent", springLibrary + "/" + version); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy