Class OsConfigZonalServiceSpringAutoConfiguration

java.lang.Object
com.google.cloud.osconfig.v1.spring.OsConfigZonalServiceSpringAutoConfiguration

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

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
    OsConfigZonalServiceSpringAutoConfiguration(OsConfigZonalServiceSpringProperties clientProperties, com.google.api.gax.core.CredentialsProvider credentialsProvider)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.
    com.google.cloud.osconfig.v1.OsConfigZonalServiceClient
    osConfigZonalServiceClient(com.google.cloud.osconfig.v1.OsConfigZonalServiceSettings osConfigZonalServiceSettings)
    Provides a OsConfigZonalServiceClient bean configured with OsConfigZonalServiceSettings.
    com.google.cloud.osconfig.v1.OsConfigZonalServiceSettings
    osConfigZonalServiceSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a OsConfigZonalServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultOsConfigZonalServiceTransportChannelProvider()).

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • defaultOsConfigZonalServiceTransportChannelProvider

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

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

      @Bean @ConditionalOnMissingBean public com.google.cloud.osconfig.v1.OsConfigZonalServiceClient osConfigZonalServiceClient(com.google.cloud.osconfig.v1.OsConfigZonalServiceSettings osConfigZonalServiceSettings) throws IOException
      Provides a OsConfigZonalServiceClient bean configured with OsConfigZonalServiceSettings.
      Parameters:
      osConfigZonalServiceSettings - settings to configure an instance of client bean.
      Returns:
      a OsConfigZonalServiceClient bean configured with OsConfigZonalServiceSettings
      Throws:
      IOException