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.

Types

Builder

class Builder : CoreEnvironment.Builder<ClusterEnvironment.Builder>

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

Companion

object Companion

Functions

clientHash

open fun clientHash(): Optional<String>

clientVersion

open fun clientVersion(): Optional<String>

open override fun close()

compressionConfig

open fun compressionConfig(): CompressionConfig

coreHash

open fun coreHash(): Optional<String>

coreVersion

open fun coreVersion(): Optional<String>

eventBus

open fun eventBus(): EventBus

executor

@Stability.Internal

open fun executor(): Executor

exportAsString

open fun exportAsString(p0: Context.ExportFormat): String

ioConfig

open fun ioConfig(): IoConfig

ioEnvironment

open fun ioEnvironment(): IoEnvironment

loggerConfig

open fun loggerConfig(): LoggerConfig

maxNumRequestsInRetry

open fun maxNumRequestsInRetry(): Long

meter

@Stability.Volatile

open fun meter(): Meter

orphanReporter

open fun orphanReporter(): OrphanReporter

preferredServerGroup

@Nullable

open fun preferredServerGroup(): String

requestCallbacks

@Stability.Internal

open fun requestCallbacks(): MutableList<RequestCallback>

requestTracer

@Stability.Volatile

open fun requestTracer(): RequestTracer

retryStrategy

open fun retryStrategy(): RetryStrategy

scheduler

open fun scheduler(): Scheduler

securityConfig

open fun securityConfig(): SecurityConfig

shutdown

open fun shutdown()

open fun shutdown(p0: Duration)

shutdownAsync

open fun shutdownAsync(): CompletableFuture<Void>

open fun shutdownAsync(p0: Duration): CompletableFuture<Void>

shutdownReactive

open fun shutdownReactive(): Mono<Void>

open fun shutdownReactive(p0: Duration): Mono<Void>

shutdownSuspend

suspend fun shutdownSuspend(timeout: Duration = timeoutConfig().disconnectTimeout().toKotlinDuration())

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

timeoutConfig

open fun timeoutConfig(): TimeoutConfig

timer

open fun timer(): Timer

toString

open override fun toString(): String

transactionsConfig

@Stability.Volatile

open fun transactionsConfig(): CoreTransactionsConfig

transactionsSchedulers

@Stability.Volatile

open fun transactionsSchedulers(): CoreTransactionsSchedulers

userAgent

open fun userAgent(): UserAgent

ClusterEnvironment

See also

Types

Functions