Package com.couchbase.quarkus.extension.runtime

Interface CouchbaseConfig

@ConfigMapping(prefix="quarkus.couchbase") @ConfigRoot(phase=BUILD_AND_RUN_TIME_FIXED) public interface CouchbaseConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    connectionString()
    The connection string, e.g.
    int
    emitInterval()
    The interval in seconds when metrics are emitted.
    boolean
    healthEnabled()
    Whether to enable health checks or not.
    boolean
    metricsEnabled()
    Whether metrics are enabled
    String
    password()
    The password to authenticate with.
    int
    readinessTimeout()
    The timeout for the Ready health check in seconds In other words: "How long you are willing to wait to know whether the cluster is ready or not".
    String
    username()
    The username to authenticate with.
    String
    version()
    The version of the Couchbase server to connect to during the dev/test phase as dev service.

  • Method Details

    • connectionString

      String connectionString()
      The connection string, e.g. "couchbase://10.202.32.32" or "localhost".

    • username

      String username()
      The username to authenticate with.

    • password

      String password()
      The password to authenticate with.

    • version

      @WithDefault("latest") @WithName("devservices.version") String version()
      The version of the Couchbase server to connect to during the dev/test phase as dev service. Default is latest, see the Docker Hub for available versions.

    • healthEnabled

      @WithDefault("true") @WithName("health.enabled") boolean healthEnabled()
      Whether to enable health checks or not.

    • readinessTimeout

      @WithDefault("3") @WithName("health.readiness.timeout") int readinessTimeout()
      The timeout for the Ready health check in seconds In other words: "How long you are willing to wait to know whether the cluster is ready or not".

    • metricsEnabled

      @WithDefault("false") @WithName("metrics.enabled") boolean metricsEnabled()
      Whether metrics are enabled

    • emitInterval

      @WithDefault("600") @WithName("metrics.emit-interval") int emitInterval()
      The interval in seconds when metrics are emitted.