Package com.google.cloud.ids.v1.spring

Class IDSSpringAutoConfiguration

java.lang.Object
com.google.cloud.ids.v1.spring.IDSSpringAutoConfiguration
@Generated("by google-cloud-spring-generator") @BetaApi("Autogenerated Spring autoconfiguration is not yet stable") @AutoConfiguration @AutoConfigureAfter(GcpContextAutoConfiguration.class) @ConditionalOnClass(com.google.cloud.ids.v1.IDSClient.class) @ConditionalOnProperty(value="com.google.cloud.ids.v1.i-d-s.enabled", matchIfMissing=true) @EnableConfigurationProperties(IDSSpringProperties.class) public class IDSSpringAutoConfiguration extends Object
Auto-configuration for IDSClient.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultIDSTransportChannelProvider()
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.
    com.google.cloud.ids.v1.IDSClient
    iDSClient(com.google.cloud.ids.v1.IDSSettings iDSSettings)
    Provides a IDSClient bean configured with IDSSettings.
    com.google.cloud.ids.v1.IDSSettings
    iDSSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a IDSSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultIDSTransportChannelProvider()).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IDSSpringAutoConfiguration

      protected IDSSpringAutoConfiguration(IDSSpringProperties clientProperties, com.google.api.gax.core.CredentialsProvider credentialsProvider) throws IOException
      Throws:
      IOException

  • Method Details

    • defaultIDSTransportChannelProvider

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

    • iDSSettings

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

    • iDSClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.ids.v1.IDSClient iDSClient(com.google.cloud.ids.v1.IDSSettings iDSSettings) throws IOException
      Provides a IDSClient bean configured with IDSSettings.
      Parameters:
      iDSSettings - settings to configure an instance of client bean.
      Returns:
      a IDSClient bean configured with IDSSettings
      Throws:
      IOException