Package com.google.cloud.discoveryengine.v1.spring

Class RankServiceSpringAutoConfiguration

java.lang.Object
com.google.cloud.discoveryengine.v1.spring.RankServiceSpringAutoConfiguration
@Generated("by google-cloud-spring-generator") @BetaApi("Autogenerated Spring autoconfiguration is not yet stable") @AutoConfiguration @AutoConfigureAfter(GcpContextAutoConfiguration.class) @ConditionalOnClass(com.google.cloud.discoveryengine.v1.RankServiceClient.class) @ConditionalOnProperty(value="com.google.cloud.discoveryengine.v1.rank-service.enabled", matchIfMissing=true) @EnableConfigurationProperties(RankServiceSpringProperties.class) public class RankServiceSpringAutoConfiguration extends Object
Auto-configuration for RankServiceClient.

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
    RankServiceSpringAutoConfiguration(RankServiceSpringProperties clientProperties, com.google.api.gax.core.CredentialsProvider credentialsProvider)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultRankServiceTransportChannelProvider()
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.
    com.google.cloud.discoveryengine.v1.RankServiceClient
    rankServiceClient(com.google.cloud.discoveryengine.v1.RankServiceSettings rankServiceSettings)
    Provides a RankServiceClient bean configured with RankServiceSettings.
    com.google.cloud.discoveryengine.v1.RankServiceSettings
    rankServiceSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a RankServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultRankServiceTransportChannelProvider()).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • defaultRankServiceTransportChannelProvider

      @Bean @ConditionalOnMissingBean(name="defaultRankServiceTransportChannelProvider") public com.google.api.gax.rpc.TransportChannelProvider defaultRankServiceTransportChannelProvider()
      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.

    • rankServiceSettings

      @Bean @ConditionalOnMissingBean public com.google.cloud.discoveryengine.v1.RankServiceSettings rankServiceSettings(@Qualifier("defaultRankServiceTransportChannelProvider") com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider) throws IOException
      Provides a RankServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultRankServiceTransportChannelProvider()). 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 RankServiceSpringProperties. 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 RankServiceSettings bean configured with TransportChannelProvider bean.
      Throws:
      IOException

    • rankServiceClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.discoveryengine.v1.RankServiceClient rankServiceClient(com.google.cloud.discoveryengine.v1.RankServiceSettings rankServiceSettings) throws IOException
      Provides a RankServiceClient bean configured with RankServiceSettings.
      Parameters:
      rankServiceSettings - settings to configure an instance of client bean.
      Returns:
      a RankServiceClient bean configured with RankServiceSettings
      Throws:
      IOException