Package com.google.cloud.oslogin.v1.spring

Class OsLoginServiceSpringAutoConfiguration

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

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultOsLoginServiceTransportChannelProvider()
    Provides a default transport channel provider bean.
    com.google.cloud.oslogin.v1.OsLoginServiceClient
    osLoginServiceClient(com.google.cloud.oslogin.v1.OsLoginServiceSettings osLoginServiceSettings)
    Provides a OsLoginServiceClient bean configured with OsLoginServiceSettings.
    com.google.cloud.oslogin.v1.OsLoginServiceSettings
    osLoginServiceSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a OsLoginServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultOsLoginServiceTransportChannelProvider()).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • defaultOsLoginServiceTransportChannelProvider

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

    • osLoginServiceSettings

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

    • osLoginServiceClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.oslogin.v1.OsLoginServiceClient osLoginServiceClient(com.google.cloud.oslogin.v1.OsLoginServiceSettings osLoginServiceSettings) throws IOException
      Provides a OsLoginServiceClient bean configured with OsLoginServiceSettings.
      Parameters:
      osLoginServiceSettings - settings to configure an instance of client bean.
      Returns:
      a OsLoginServiceClient bean configured with OsLoginServiceSettings
      Throws:
      IOException