Package com.google.cloud.apigateway.v1.spring

Class ApiGatewayServiceSpringAutoConfiguration

java.lang.Object
com.google.cloud.apigateway.v1.spring.ApiGatewayServiceSpringAutoConfiguration
@Generated("by google-cloud-spring-generator") @BetaApi("Autogenerated Spring autoconfiguration is not yet stable") @AutoConfiguration @AutoConfigureAfter(GcpContextAutoConfiguration.class) @ConditionalOnClass(com.google.cloud.apigateway.v1.ApiGatewayServiceClient.class) @ConditionalOnProperty(value="com.google.cloud.apigateway.v1.api-gateway-service.enabled", matchIfMissing=true) @EnableConfigurationProperties(ApiGatewayServiceSpringProperties.class) public class ApiGatewayServiceSpringAutoConfiguration extends Object
Auto-configuration for ApiGatewayServiceClient.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.cloud.apigateway.v1.ApiGatewayServiceClient
    apiGatewayServiceClient(com.google.cloud.apigateway.v1.ApiGatewayServiceSettings apiGatewayServiceSettings)
    Provides a ApiGatewayServiceClient bean configured with ApiGatewayServiceSettings.
    com.google.cloud.apigateway.v1.ApiGatewayServiceSettings
    apiGatewayServiceSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a ApiGatewayServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultApiGatewayServiceTransportChannelProvider()).
    com.google.api.gax.rpc.TransportChannelProvider
    defaultApiGatewayServiceTransportChannelProvider()
    Provides a default transport channel provider bean.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • defaultApiGatewayServiceTransportChannelProvider

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

    • apiGatewayServiceSettings

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

    • apiGatewayServiceClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.apigateway.v1.ApiGatewayServiceClient apiGatewayServiceClient(com.google.cloud.apigateway.v1.ApiGatewayServiceSettings apiGatewayServiceSettings) throws IOException
      Provides a ApiGatewayServiceClient bean configured with ApiGatewayServiceSettings.
      Parameters:
      apiGatewayServiceSettings - settings to configure an instance of client bean.
      Returns:
      a ApiGatewayServiceClient bean configured with ApiGatewayServiceSettings
      Throws:
      IOException