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

appTelemetryDisabled

open fun appTelemetryDisabled(): Boolean

appTelemetryEndpoint

@Nullable

open fun appTelemetryEndpoint(): URI?

clientHash

open fun clientHash(): Optional<String?>?

clientVersion

open fun clientVersion(): Optional<String?>?

open 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(format: 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?

observabilitySemanticConventions

@Stability.Internal

open fun observabilitySemanticConventions(): List<ObservabilitySemanticConvention?>?

orphanReporter

open fun orphanReporter(): OrphanReporter?

preferredServerGroup

@Nullable

open fun preferredServerGroup(): String?

publishOnUserScheduler

open fun <T : Any> publishOnUserScheduler(future: Supplier<CompletableFuture<T>>): Mono<T>

@Stability.Internal

open fun <T : Any?> publishOnUserScheduler(flux: Flux<T>): Flux<T?>

@Stability.Internal

open fun <T : Any?> publishOnUserScheduler(mono: Mono<T>): Mono<T?>

requestCallbacks

@Stability.Internal

open fun requestCallbacks(): List<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(timeout: Duration?)

shutdownAsync

open fun shutdownAsync(): CompletableFuture<Void?>?

open fun shutdownAsync(timeout: Duration?): CompletableFuture<Void?>?

shutdownReactive

open fun shutdownReactive(): Mono<Void?>?

open fun shutdownReactive(timeout: 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?

transactionsConfig

@Stability.Volatile

open fun transactionsConfig(): CoreTransactionsConfig?

transactionsSchedulers

@Stability.Volatile

open fun transactionsSchedulers(): CoreTransactionsSchedulers?

userAgent

open fun userAgent(): UserAgent?

userScheduler

@Stability.Internal

@Nullable

open fun userScheduler(): Supplier<Scheduler?>?

ClusterEnvironment

See also

Types

Functions