Package com.google.cloud.osconfig.v1.spring

Class OsConfigServiceSpringAutoConfiguration

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

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultOsConfigServiceTransportChannelProvider()
    Provides a default transport channel provider bean.
    com.google.cloud.osconfig.v1.OsConfigServiceClient
    osConfigServiceClient(com.google.cloud.osconfig.v1.OsConfigServiceSettings osConfigServiceSettings)
    Provides a OsConfigServiceClient bean configured with OsConfigServiceSettings.
    com.google.cloud.osconfig.v1.OsConfigServiceSettings
    osConfigServiceSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a OsConfigServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultOsConfigServiceTransportChannelProvider()).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • defaultOsConfigServiceTransportChannelProvider

      @Bean @ConditionalOnMissingBean(name="defaultOsConfigServiceTransportChannelProvider") public com.google.api.gax.rpc.TransportChannelProvider defaultOsConfigServiceTransportChannelProvider()
      Provides a default transport channel provider bean. The default is gRPC and will default to it unless the useRest option is supported and provided to use HTTP transport instead
      Returns:
      a default transport channel provider.

    • osConfigServiceSettings

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

    • osConfigServiceClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.osconfig.v1.OsConfigServiceClient osConfigServiceClient(com.google.cloud.osconfig.v1.OsConfigServiceSettings osConfigServiceSettings) throws IOException
      Provides a OsConfigServiceClient bean configured with OsConfigServiceSettings.
      Parameters:
      osConfigServiceSettings - settings to configure an instance of client bean.
      Returns:
      a OsConfigServiceClient bean configured with OsConfigServiceSettings
      Throws:
      IOException