com.google.cloud.retail.v2.spring.ServingConfigServiceSpringAutoConfiguration Maven / Gradle / Ivy
Show all versions of google-cloud-retail-spring-starter Show documentation
/*
* Copyright 2023 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.retail.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.retail.v2.ServingConfigServiceClient;
import com.google.cloud.retail.v2.ServingConfigServiceSettings;
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 ServingConfigServiceClient}.
*
* 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(ServingConfigServiceClient.class)
@ConditionalOnProperty(
value = "com.google.cloud.retail.v2.serving-config-service.enabled",
matchIfMissing = true)
@EnableConfigurationProperties(ServingConfigServiceSpringProperties.class)
public class ServingConfigServiceSpringAutoConfiguration {
private final ServingConfigServiceSpringProperties clientProperties;
private final CredentialsProvider credentialsProvider;
private static final Log LOGGER =
LogFactory.getLog(ServingConfigServiceSpringAutoConfiguration.class);
protected ServingConfigServiceSpringAutoConfiguration(
ServingConfigServiceSpringProperties clientProperties,
CredentialsProvider credentialsProvider)
throws IOException {
this.clientProperties = clientProperties;
if (this.clientProperties.getCredentials().hasKey()) {
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Using credentials from ServingConfigService-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 = "defaultServingConfigServiceTransportChannelProvider")
public TransportChannelProvider defaultServingConfigServiceTransportChannelProvider() {
if (this.clientProperties.getUseRest()) {
return ServingConfigServiceSettings.defaultHttpJsonTransportProviderBuilder().build();
}
return ServingConfigServiceSettings.defaultTransportChannelProvider();
}
/**
* Provides a ServingConfigServiceSettings bean configured to use a DefaultCredentialsProvider and
* the client library's default transport channel provider
* (defaultServingConfigServiceTransportChannelProvider()). 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 ServingConfigServiceSpringProperties. 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 ServingConfigServiceSettings} bean configured with {@link
* TransportChannelProvider} bean.
*/
@Bean
@ConditionalOnMissingBean
public ServingConfigServiceSettings servingConfigServiceSettings(
@Qualifier("defaultServingConfigServiceTransportChannelProvider")
TransportChannelProvider defaultTransportChannelProvider)
throws IOException {
ServingConfigServiceSettings.Builder clientSettingsBuilder;
if (this.clientProperties.getUseRest()) {
clientSettingsBuilder = ServingConfigServiceSettings.newHttpJsonBuilder();
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Using REST (HTTP/JSON) transport.");
}
} else {
clientSettingsBuilder = ServingConfigServiceSettings.newBuilder();
}
clientSettingsBuilder
.setCredentialsProvider(this.credentialsProvider)
.setTransportChannelProvider(defaultTransportChannelProvider)
.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 =
ServingConfigServiceSettings.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 createServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.createServingConfigSettings().getRetrySettings(), serviceRetry);
clientSettingsBuilder
.createServingConfigSettings()
.setRetrySettings(createServingConfigRetrySettings);
RetrySettings deleteServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.deleteServingConfigSettings().getRetrySettings(), serviceRetry);
clientSettingsBuilder
.deleteServingConfigSettings()
.setRetrySettings(deleteServingConfigRetrySettings);
RetrySettings updateServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.updateServingConfigSettings().getRetrySettings(), serviceRetry);
clientSettingsBuilder
.updateServingConfigSettings()
.setRetrySettings(updateServingConfigRetrySettings);
RetrySettings getServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.getServingConfigSettings().getRetrySettings(), serviceRetry);
clientSettingsBuilder
.getServingConfigSettings()
.setRetrySettings(getServingConfigRetrySettings);
RetrySettings listServingConfigsRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.listServingConfigsSettings().getRetrySettings(), serviceRetry);
clientSettingsBuilder
.listServingConfigsSettings()
.setRetrySettings(listServingConfigsRetrySettings);
RetrySettings addControlRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.addControlSettings().getRetrySettings(), serviceRetry);
clientSettingsBuilder.addControlSettings().setRetrySettings(addControlRetrySettings);
RetrySettings removeControlRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.removeControlSettings().getRetrySettings(), serviceRetry);
clientSettingsBuilder.removeControlSettings().setRetrySettings(removeControlRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Configured service-level retry settings from properties.");
}
}
Retry createServingConfigRetry = clientProperties.getCreateServingConfigRetry();
if (createServingConfigRetry != null) {
RetrySettings createServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.createServingConfigSettings().getRetrySettings(),
createServingConfigRetry);
clientSettingsBuilder
.createServingConfigSettings()
.setRetrySettings(createServingConfigRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace(
"Configured method-level retry settings for createServingConfig from properties.");
}
}
Retry deleteServingConfigRetry = clientProperties.getDeleteServingConfigRetry();
if (deleteServingConfigRetry != null) {
RetrySettings deleteServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.deleteServingConfigSettings().getRetrySettings(),
deleteServingConfigRetry);
clientSettingsBuilder
.deleteServingConfigSettings()
.setRetrySettings(deleteServingConfigRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace(
"Configured method-level retry settings for deleteServingConfig from properties.");
}
}
Retry updateServingConfigRetry = clientProperties.getUpdateServingConfigRetry();
if (updateServingConfigRetry != null) {
RetrySettings updateServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.updateServingConfigSettings().getRetrySettings(),
updateServingConfigRetry);
clientSettingsBuilder
.updateServingConfigSettings()
.setRetrySettings(updateServingConfigRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace(
"Configured method-level retry settings for updateServingConfig from properties.");
}
}
Retry getServingConfigRetry = clientProperties.getGetServingConfigRetry();
if (getServingConfigRetry != null) {
RetrySettings getServingConfigRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.getServingConfigSettings().getRetrySettings(),
getServingConfigRetry);
clientSettingsBuilder
.getServingConfigSettings()
.setRetrySettings(getServingConfigRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace(
"Configured method-level retry settings for getServingConfig from properties.");
}
}
Retry listServingConfigsRetry = clientProperties.getListServingConfigsRetry();
if (listServingConfigsRetry != null) {
RetrySettings listServingConfigsRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.listServingConfigsSettings().getRetrySettings(),
listServingConfigsRetry);
clientSettingsBuilder
.listServingConfigsSettings()
.setRetrySettings(listServingConfigsRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace(
"Configured method-level retry settings for listServingConfigs from properties.");
}
}
Retry addControlRetry = clientProperties.getAddControlRetry();
if (addControlRetry != null) {
RetrySettings addControlRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.addControlSettings().getRetrySettings(), addControlRetry);
clientSettingsBuilder.addControlSettings().setRetrySettings(addControlRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Configured method-level retry settings for addControl from properties.");
}
}
Retry removeControlRetry = clientProperties.getRemoveControlRetry();
if (removeControlRetry != null) {
RetrySettings removeControlRetrySettings =
RetryUtil.updateRetrySettings(
clientSettingsBuilder.removeControlSettings().getRetrySettings(), removeControlRetry);
clientSettingsBuilder.removeControlSettings().setRetrySettings(removeControlRetrySettings);
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Configured method-level retry settings for removeControl from properties.");
}
}
return clientSettingsBuilder.build();
}
/**
* Provides a ServingConfigServiceClient bean configured with ServingConfigServiceSettings.
*
* @param servingConfigServiceSettings settings to configure an instance of client bean.
* @return a {@link ServingConfigServiceClient} bean configured with {@link
* ServingConfigServiceSettings}
*/
@Bean
@ConditionalOnMissingBean
public ServingConfigServiceClient servingConfigServiceClient(
ServingConfigServiceSettings servingConfigServiceSettings) throws IOException {
return ServingConfigServiceClient.create(servingConfigServiceSettings);
}
private HeaderProvider userAgentHeaderProvider() {
String springLibrary = "spring-autogen-serving-config-service";
String version = this.getClass().getPackage().getImplementationVersion();
return () -> Collections.singletonMap("user-agent", springLibrary + "/" + version);
}
}