Package com.google.cloud.iam.admin.v1.spring

Class IAMSpringAutoConfiguration

java.lang.Object
com.google.cloud.iam.admin.v1.spring.IAMSpringAutoConfiguration
@Generated("by google-cloud-spring-generator") @BetaApi("Autogenerated Spring autoconfiguration is not yet stable") @AutoConfiguration @AutoConfigureAfter(GcpContextAutoConfiguration.class) @ConditionalOnClass(com.google.cloud.iam.admin.v1.IAMClient.class) @ConditionalOnProperty(value="com.google.cloud.iam.admin.v1.i-a-m.enabled", matchIfMissing=true) @EnableConfigurationProperties(IAMSpringProperties.class) public class IAMSpringAutoConfiguration extends Object
Auto-configuration for IAMClient.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultIAMTransportChannelProvider()
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.
    com.google.cloud.iam.admin.v1.IAMClient
    iAMClient(com.google.cloud.iam.admin.v1.IAMSettings iAMSettings)
    Provides a IAMClient bean configured with IAMSettings.
    com.google.cloud.iam.admin.v1.IAMSettings
    iAMSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a IAMSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultIAMTransportChannelProvider()).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IAMSpringAutoConfiguration

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

  • Method Details

    • defaultIAMTransportChannelProvider

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

    • iAMSettings

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

    • iAMClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.iam.admin.v1.IAMClient iAMClient(com.google.cloud.iam.admin.v1.IAMSettings iAMSettings) throws IOException
      Provides a IAMClient bean configured with IAMSettings.
      Parameters:
      iAMSettings - settings to configure an instance of client bean.
      Returns:
      a IAMClient bean configured with IAMSettings
      Throws:
      IOException