Package com.google.cloud.retail.v2.spring

Class SearchServiceSpringAutoConfiguration

java.lang.Object
com.google.cloud.retail.v2.spring.SearchServiceSpringAutoConfiguration
@Generated("by google-cloud-spring-generator") @BetaApi("Autogenerated Spring autoconfiguration is not yet stable") @AutoConfiguration @AutoConfigureAfter(GcpContextAutoConfiguration.class) @ConditionalOnClass(com.google.cloud.retail.v2.SearchServiceClient.class) @ConditionalOnProperty(value="com.google.cloud.retail.v2.search-service.enabled", matchIfMissing=true) @EnableConfigurationProperties(SearchServiceSpringProperties.class) public class SearchServiceSpringAutoConfiguration extends Object
Auto-configuration for SearchServiceClient.

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.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SearchServiceSpringAutoConfiguration(SearchServiceSpringProperties clientProperties, com.google.api.gax.core.CredentialsProvider credentialsProvider)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultSearchServiceTransportChannelProvider()
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.
    com.google.cloud.retail.v2.SearchServiceClient
    searchServiceClient(com.google.cloud.retail.v2.SearchServiceSettings searchServiceSettings)
    Provides a SearchServiceClient bean configured with SearchServiceSettings.
    com.google.cloud.retail.v2.SearchServiceSettings
    searchServiceSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a SearchServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultSearchServiceTransportChannelProvider()).

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • defaultSearchServiceTransportChannelProvider

      @Bean @ConditionalOnMissingBean(name="defaultSearchServiceTransportChannelProvider") public com.google.api.gax.rpc.TransportChannelProvider defaultSearchServiceTransportChannelProvider()
      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.
      Returns:
      a default transport channel provider.

    • searchServiceSettings

      @Bean @ConditionalOnMissingBean public com.google.cloud.retail.v2.SearchServiceSettings searchServiceSettings(@Qualifier("defaultSearchServiceTransportChannelProvider") com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider) throws IOException
      Provides a SearchServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultSearchServiceTransportChannelProvider()). 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 SearchServiceSpringProperties. Method-level properties will take precedence over service-level properties if available, and client library defaults will be used if neither are specified.

      Parameters:
      defaultTransportChannelProvider - TransportChannelProvider to use in the settings.
      Returns:
      a SearchServiceSettings bean configured with TransportChannelProvider bean.
      Throws:
      IOException

    • searchServiceClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.retail.v2.SearchServiceClient searchServiceClient(com.google.cloud.retail.v2.SearchServiceSettings searchServiceSettings) throws IOException
      Provides a SearchServiceClient bean configured with SearchServiceSettings.
      Parameters:
      searchServiceSettings - settings to configure an instance of client bean.
      Returns:
      a SearchServiceClient bean configured with SearchServiceSettings
      Throws:
      IOException