package env
- Alphabetic
- Public
- Protected
Type Members
- case class CircuitBreakerConfig(enabled: Boolean = core.endpoint.CircuitBreakerConfig.DEFAULT_ENABLED, volumeThreshold: Int = core.endpoint.CircuitBreakerConfig.DEFAULT_VOLUME_THRESHOLD, errorThresholdPercentage: Int = core.endpoint.CircuitBreakerConfig.DEFAULT_ERROR_THRESHOLD_PERCENTAGE, sleepWindow: Duration = core.endpoint.CircuitBreakerConfig.DEFAULT_SLEEP_WINDOW, rollingWindow: Duration = core.endpoint.CircuitBreakerConfig.DEFAULT_ROLLING_WINDOW) extends Product with Serializable
Allows configuring a
com.couchbase.client.core.endpoint.CircuitBreaker
.Allows configuring a
com.couchbase.client.core.endpoint.CircuitBreaker
.- Since
1.0.0
- class ClusterEnvironment extends AnyRef
All configuration options related to a cluster environment, along with some long-lived resources including a thread-pool.
- case class CompressionConfig(enabled: Boolean = core.env.CompressionConfig.DEFAULT_ENABLED, minSize: Int = core.env.CompressionConfig.DEFAULT_MIN_SIZE, minRatio: Double = core.env.CompressionConfig.DEFAULT_MIN_RATIO) extends Product with Serializable
Allows configuring and customizing the compression configuration.
Allows configuring and customizing the compression configuration.
- enabled
If compression is enabled or not.
- minSize
The minimum size when compression should be performed.
- minRatio
The minimum ratio of when a compressed doc should be sent.
- Since
1.0.0
- case class IoConfig(mutationTokensEnabled: Boolean = true, dnsSrvEnabled: Option[Boolean] = None, configPollInterval: Option[Duration] = None, kvCircuitBreakerConfig: Option[CircuitBreakerConfig] = None, queryCircuitBreakerConfig: Option[CircuitBreakerConfig] = None, viewCircuitBreakerConfig: Option[CircuitBreakerConfig] = None, searchCircuitBreakerConfig: Option[CircuitBreakerConfig] = None, analyticsCircuitBreakerConfig: Option[CircuitBreakerConfig] = None, managerCircuitBreakerConfig: Option[CircuitBreakerConfig] = None, captureTraffic: Option[Set[ServiceType]] = None, networkResolution: Option[NetworkResolution] = None, tcpKeepAlivesEnabled: Option[Boolean] = None, tcpKeepAliveTime: Option[Duration] = None, numKvConnections: Option[Int] = None, maxHttpConnections: Option[Int] = None, idleHttpConnectionTimeout: Option[Duration] = None, configIdleRedialTimeout: Option[Duration] = None) extends Product with Serializable
- case class IoEnvironment(managerEventLoopGroup: Option[EventLoopGroup] = None, kvEventLoopGroup: Option[EventLoopGroup] = None, queryEventLoopGroup: Option[EventLoopGroup] = None, analyticsEventLoopGroup: Option[EventLoopGroup] = None, searchEventLoopGroup: Option[EventLoopGroup] = None, viewEventLoopGroup: Option[EventLoopGroup] = None, nativeIoEnabled: Option[Boolean] = None, eventLoopThreadCount: Option[Int] = None) extends Product with Serializable
Holds all IO-related configuration and state.
Holds all IO-related configuration and state.
- Since
1.0.0
- case class LoggerConfig(fallbackToConsole: Option[Boolean] = None, disableSlf4J: Option[Boolean] = None, loggerName: Option[String] = None, diagnosticContextEnabled: Option[Boolean] = None) extends Product with Serializable
- case class LoggingMeterConfig(emitInterval: Duration = core.env.LoggingMeterConfig.Defaults.DEFAULT_EMIT_INTERVAL, enabled: Boolean = core.env.LoggingMeterConfig.Defaults.DEFAULT_ENABLED) extends Product with Serializable
Allows customizing the
LoggingMeter
. - case class OrphanReporterConfig(emitInterval: Option[Duration] = None, sampleSize: Option[Int] = None, queueLength: Option[Int] = None) extends Product with Serializable
- case class PasswordAuthenticator(username: String, password: String) extends Authenticator with Product with Serializable
- case class SecurityConfig(tlsEnabled: Option[Boolean] = None, nativeTlsEnabled: Option[Boolean] = None, trustCertificates: Option[Seq[X509Certificate]] = None, trustManagerFactory: Option[TrustManagerFactory] = None, enableHostnameVerification: Option[Boolean] = None, trustCertificate: Option[Path] = None, ciphers: Option[Seq[String]] = None, trustKeyStore: Option[KeyStore] = None, trustStoreFile: Option[TrustStoreFile] = None) extends Product with Serializable
- case class SeedNode(address: String, kvPort: Option[Int] = None, clusterManagerPort: Option[Int] = None, protostellarPort: Option[Int] = None) extends Product with Serializable
- case class ThresholdRequestTracerConfig(emitInterval: Duration = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_EMIT_INTERVAL, queueLength: Int = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_QUEUE_LENGTH, sampleSize: Int = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_SAMPLE_SIZE, kvThreshold: Duration = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_KV_THRESHOLD, queryThreshold: Duration = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_QUERY_THRESHOLD, viewThreshold: Duration = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_VIEW_THRESHOLD, searchThreshold: Duration = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_SEARCH_THRESHOLD, analyticsThreshold: Duration = core.env.ThresholdRequestTracerConfig.Defaults.DEFAULT_ANALYTICS_THRESHOLD) extends Product with Serializable
Allows customising the threshold request tracer.
- case class TimeoutConfig(kvTimeout: Option[Duration] = None, kvDurableTimeout: Option[Duration] = None, managementTimeout: Option[Duration] = None, queryTimeout: Option[Duration] = None, viewTimeout: Option[Duration] = None, searchTimeout: Option[Duration] = None, analyticsTimeout: Option[Duration] = None, connectTimeout: Option[Duration] = None, disconnectTimeout: Option[Duration] = None, kvScanTimeout: Option[Duration] = None) extends Product with Serializable
Configures all default timeouts.
Configures all default timeouts.
- kvTimeout
the default timeout to use for key-value operations
- managementTimeout
the default timeout to use for management operations
- queryTimeout
the default timeout to use for query operations
- viewTimeout
the default timeout to use for view operations
- searchTimeout
the default timeout to use for search operations
- analyticsTimeout
the default timeout to use for analytics operations
- connectTimeout
the default timeout to use for connection operations
- disconnectTimeout
the default timeout to use for disconnection operations
- case class TrustStoreFile(path: Path, password: String, storeType: Option[String]) extends Product with Serializable
Value Members
- 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.
- object SeedNode extends Serializable