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

Class IAMCredentialsSpringAutoConfiguration

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

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultIAMCredentialsTransportChannelProvider()
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.
    com.google.cloud.iam.credentials.v1.IamCredentialsClient
    iAMCredentialsClient(com.google.cloud.iam.credentials.v1.IamCredentialsSettings iAMCredentialsSettings)
    Provides a IamCredentialsClient bean configured with IamCredentialsSettings.
    com.google.cloud.iam.credentials.v1.IamCredentialsSettings
    iAMCredentialsSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a IamCredentialsSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultIAMCredentialsTransportChannelProvider()).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • defaultIAMCredentialsTransportChannelProvider

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

    • iAMCredentialsSettings

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

    • iAMCredentialsClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.iam.credentials.v1.IamCredentialsClient iAMCredentialsClient(com.google.cloud.iam.credentials.v1.IamCredentialsSettings iAMCredentialsSettings) throws IOException
      Provides a IamCredentialsClient bean configured with IamCredentialsSettings.
      Parameters:
      iAMCredentialsSettings - settings to configure an instance of client bean.
      Returns:
      a IamCredentialsClient bean configured with IamCredentialsSettings
      Throws:
      IOException