Package com.google.cloud.aiplatform.v1.spring

Class IndexServiceSpringAutoConfiguration

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

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.gax.rpc.TransportChannelProvider
    defaultIndexServiceTransportChannelProvider()
    Provides a default transport channel provider bean, corresponding to the client library's default transport channel provider.
    com.google.cloud.aiplatform.v1.IndexServiceClient
    indexServiceClient(com.google.cloud.aiplatform.v1.IndexServiceSettings indexServiceSettings)
    Provides a IndexServiceClient bean configured with IndexServiceSettings.
    com.google.cloud.aiplatform.v1.IndexServiceSettings
    indexServiceSettings(com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider)
    Provides a IndexServiceSettings bean configured to use a DefaultCredentialsProvider and the client library's default transport channel provider (defaultIndexServiceTransportChannelProvider()).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • defaultIndexServiceTransportChannelProvider

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

    • indexServiceSettings

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

    • indexServiceClient

      @Bean @ConditionalOnMissingBean public com.google.cloud.aiplatform.v1.IndexServiceClient indexServiceClient(com.google.cloud.aiplatform.v1.IndexServiceSettings indexServiceSettings) throws IOException
      Provides a IndexServiceClient bean configured with IndexServiceSettings.
      Parameters:
      indexServiceSettings - settings to configure an instance of client bean.
      Returns:
      a IndexServiceClient bean configured with IndexServiceSettings
      Throws:
      IOException