kotlin-client/com.couchbase.client.kotlin.env/ClusterEnvironment

ClusterEnvironment

class ClusterEnvironment : CoreEnvironment

Resources and configuration for connecting to a Couchbase cluster.

You don't need to worry about creating an environment unless you want to share a single environment between multiple clusters. In that case, create an environment using a builder returned by ClusterEnvironment.builder.

See also

Types

Link copied to clipboard
class Builder : CoreEnvironment.Builder<ClusterEnvironment.Builder>

Used for configuring cluster environment settings, or creating a shared cluster environment.

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
Link copied to clipboard
@Nullable
open fun appTelemetryEndpoint(): URI
Link copied to clipboard
open fun clientHash(): Optional<String>
Link copied to clipboard
Link copied to clipboard
open override fun close()
Link copied to clipboard
open fun compressionConfig(): CompressionConfig
Link copied to clipboard
open fun coreHash(): Optional<String>
Link copied to clipboard
open fun coreVersion(): Optional<String>
Link copied to clipboard
open fun eventBus(): EventBus
Link copied to clipboard
@Stability.Internal
open fun executor(): Executor
Link copied to clipboard
open fun exportAsString(p0: Context.ExportFormat): String
Link copied to clipboard
open fun ioConfig(): IoConfig
Link copied to clipboard
open fun ioEnvironment(): IoEnvironment
Link copied to clipboard
open fun loggerConfig(): LoggerConfig
Link copied to clipboard
Link copied to clipboard
@Stability.Volatile
open fun meter(): Meter
Link copied to clipboard
open fun orphanReporter(): OrphanReporter
Link copied to clipboard
@Nullable
open fun preferredServerGroup(): String
Link copied to clipboard
@Stability.Internal
open override fun <T : Any> publishOnUserScheduler(p0: Flux<T>): Flux<T>
@Stability.Internal
open override fun <T : Any> publishOnUserScheduler(p0: Mono<T>): Mono<T>
open fun <T : Any> publishOnUserScheduler(p0: Supplier<CompletableFuture<T>>): Mono<T>
Link copied to clipboard
@Stability.Internal
open fun requestCallbacks(): MutableList<RequestCallback>
Link copied to clipboard
@Stability.Volatile
open fun requestTracer(): RequestTracer
Link copied to clipboard
open fun retryStrategy(): RetryStrategy
Link copied to clipboard
open fun scheduler(): Scheduler
Link copied to clipboard
open fun securityConfig(): SecurityConfig
Link copied to clipboard
open fun shutdown()
open fun shutdown(p0: Duration)
Link copied to clipboard
Link copied to clipboard
open fun shutdownReactive(): Mono<Void>
open fun shutdownReactive(p0: Duration): Mono<Void>
Link copied to clipboard
suspend fun shutdownSuspend(timeout: Duration = timeoutConfig().disconnectTimeout().toKotlinDuration())

Shuts down this environment. Does the same thing as shutdown, but suspends instead of blocking.

Link copied to clipboard
open fun timeoutConfig(): TimeoutConfig
Link copied to clipboard
open fun timer(): Timer
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
@Stability.Volatile
open fun transactionsConfig(): CoreTransactionsConfig
Link copied to clipboard
@Stability.Volatile
open fun transactionsSchedulers(): CoreTransactionsSchedulers
Link copied to clipboard
open fun userAgent(): UserAgent
Link copied to clipboard
@Stability.Internal
@Nullable
open fun userScheduler(): Supplier<Scheduler>