Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package couchbase
    Definition Classes
    com
  • package client
    Definition Classes
    couchbase
  • package scala
    Definition Classes
    client
  • package env
    Definition Classes
    scala
  • object ClusterEnvironment

    Functions to create a ClusterEnvironment, which provides configuration options for connecting to a Couchbase cluster.

    Functions to create a ClusterEnvironment, which provides configuration options for connecting to a Couchbase cluster.

    This environment also contains long-lived resources such as a thread-pool, so the application should take care to only create one of these. The same environment can be shared by multiple cluster connections.

    Definition Classes
    env
  • Builder

case class Builder(owned: Boolean, connectionString: Option[String] = None, ioEnvironment: Option[IoEnvironment] = None, ioConfig: Option[IoConfig] = None, compressionConfig: Option[CompressionConfig] = None, securityConfig: Option[SecurityConfig] = None, timeoutConfig: Option[TimeoutConfig] = None, loggerConfig: Option[LoggerConfig] = None, orphanReporterConfig: Option[OrphanReporterConfig] = None, eventBus: Option[EventBus] = None, scheduler: Option[Scheduler] = None, retryStrategy: Option[RetryStrategy] = None, requestTracer: Option[RequestTracer] = None, meter: Option[Meter] = None, maxNumRequestsInRetry: Option[Int] = None, transcoder: Option[Transcoder] = None, propertyLoaders: Seq[PropertyLoader[core.env.CoreEnvironment.Builder[SELF] forSome {type SELF <: core.env.CoreEnvironment.Builder[SELF]}]] = Seq(), thresholdRequestTracerConfig: Option[ThresholdRequestTracerConfig] = None, loggingMeterConfig: Option[LoggingMeterConfig] = None, error: Option[Throwable] = None) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Builder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Builder(owned: Boolean, connectionString: Option[String] = None, ioEnvironment: Option[IoEnvironment] = None, ioConfig: Option[IoConfig] = None, compressionConfig: Option[CompressionConfig] = None, securityConfig: Option[SecurityConfig] = None, timeoutConfig: Option[TimeoutConfig] = None, loggerConfig: Option[LoggerConfig] = None, orphanReporterConfig: Option[OrphanReporterConfig] = None, eventBus: Option[EventBus] = None, scheduler: Option[Scheduler] = None, retryStrategy: Option[RetryStrategy] = None, requestTracer: Option[RequestTracer] = None, meter: Option[Meter] = None, maxNumRequestsInRetry: Option[Int] = None, transcoder: Option[Transcoder] = None, propertyLoaders: Seq[PropertyLoader[core.env.CoreEnvironment.Builder[SELF] forSome {type SELF <: core.env.CoreEnvironment.Builder[SELF]}]] = Seq(), thresholdRequestTracerConfig: Option[ThresholdRequestTracerConfig] = None, loggingMeterConfig: Option[LoggingMeterConfig] = None, error: Option[Throwable] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def applyProfile(profileName: String): Builder

    Applies custom properties based on a profile name.

    Applies custom properties based on a profile name.

    At the moment only the "wan-development" profile is supported.

    returns

    this, for chaining purposes.

    Annotations
    @Volatile()
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def build: Try[ClusterEnvironment]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def compressionConfig(config: CompressionConfig): Builder

    Sets the CompressionConfig config.

    Sets the CompressionConfig config.

    returns

    this, for chaining

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def eventBus(eventBus: EventBus): Builder

    Sets the EventBus.

    Sets the EventBus.

    returns

    this, for chaining

    Annotations
    @Uncommitted()
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def ioConfig(config: IoConfig): Builder

    Sets the IoConfig config.

    Sets the IoConfig config.

    returns

    this, for chaining

  13. def ioEnvironment(config: IoEnvironment): Builder

    Sets the IoEnvironment config.

    Sets the IoEnvironment config.

    returns

    this, for chaining

  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def loaders(propertyLoaders: Seq[PropertyLoader[core.env.CoreEnvironment.Builder[SELF] forSome {type SELF <: core.env.CoreEnvironment.Builder[SELF]}]]): Builder

    Allows to provide custom property loaders into the environment.

    Allows to provide custom property loaders into the environment.

    propertyLoaders

    the custom property loaders.

    returns

    this, for chaining purposes.

    Annotations
    @Volatile()
  16. def loggerConfig(config: LoggerConfig): Builder

    Sets the IoConfig config.

    Sets the IoConfig config.

    returns

    this, for chaining

  17. def loggingMeterConfig(config: LoggingMeterConfig): Builder

    Allows configuring the logging meter.

    Allows configuring the logging meter.

    returns

    this, for chaining purposes.

  18. def maxNumRequestsInRetry(value: Int): Builder

    Customize the maximum number of requests allowed in the retry timer.

    Customize the maximum number of requests allowed in the retry timer.

    If the limit is reached, each request that would be queued for retry is instead cancelled with a CancellationReason of TOO_MANY_REQUESTS_IN_RETRY. This acts as a form of backpressure.

    returns

    this, for chaining

  19. def meter(meter: Meter): Builder

    Sets the default Meter to use for all operations.

    Sets the default Meter to use for all operations.

    returns

    this, for chaining

    Annotations
    @Volatile()
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def orphanReporterConfig(config: OrphanReporterConfig): Builder

    Sets the OrphanReporterConfig config.

    Sets the OrphanReporterConfig config.

    returns

    this, for chaining

  24. def requestTracer(requestTracer: RequestTracer): Builder

    Sets the default RequestTracer to use for all operations.

    Sets the default RequestTracer to use for all operations.

    returns

    this, for chaining

    Annotations
    @Volatile()
  25. def retryStrategy(value: RetryStrategy): Builder

    Sets the default com.couchbase.client.core.retry.RetryStrategy to use for all operations.

    Sets the default com.couchbase.client.core.retry.RetryStrategy to use for all operations.

    returns

    this, for chaining

  26. def scheduler(scheduler: Scheduler): Builder

    Sets the reactive Scheduler to use for operations.

    Sets the reactive Scheduler to use for operations.

    returns

    this, for chaining

    Annotations
    @Uncommitted()
  27. def securityConfig(config: SecurityConfig): Builder

    Sets the SecurityConfig config.

    Sets the SecurityConfig config.

    returns

    this, for chaining

  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def thresholdRequestTracerConfig(config: ThresholdRequestTracerConfig): Builder

    Allows configuring the threshold request tracer.

    Allows configuring the threshold request tracer.

    returns

    this, for chaining purposes.

  30. def timeoutConfig(config: TimeoutConfig): Builder

    Sets the TimeoutConfig config.

    Sets the TimeoutConfig config.

    returns

    this, for chaining

  31. def transcoder(transcoder: Transcoder): Builder

    Allows to override the default transcoder to be used for all KV operations.

    Allows to override the default transcoder to be used for all KV operations.

    returns

    this, for chaining purposes.

  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped