Package com.google.cloud.redis.v1.spring

Class CloudRedisSpringAutoConfiguration

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

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.cloud.redis.v1.CloudRedisClient
    cloudRedisClient(com.google.cloud.redis.v1.CloudRedisSettings cloudRedisSettings)
    Provides a CloudRedisClient bean configured with CloudRedisSettings.
    com.google.cloud.redis.v1.CloudRedisSettings
    cloudRedisSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a CloudRedisSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultCloudRedisTransportChannelProvider()).
    com.google.api.gax.rpc.TransportChannelProvider
    defaultCloudRedisTransportChannelProvider()
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • defaultCloudRedisTransportChannelProvider

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

    • cloudRedisSettings

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

    • cloudRedisClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.redis.v1.CloudRedisClient cloudRedisClient(com.google.cloud.redis.v1.CloudRedisSettings cloudRedisSettings) throws IOException
      Provides a CloudRedisClient bean configured with CloudRedisSettings.
      Parameters:
      cloudRedisSettings - settings to configure an instance of client bean.
      Returns:
      a CloudRedisClient bean configured with CloudRedisSettings
      Throws:
      IOException