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

Builder

class Builder : CoreEnvironment.Builder<ClusterEnvironment.Builder>

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

Call ClusterEnvironment.builder to create a new instance.

Functions

addRequestCallback

@Stability.Internal

open fun addRequestCallback(requestCallback: RequestCallback?): ClusterEnvironment.Builder?

applyProfile

@Stability.Volatile

open fun applyProfile(profileName: String?): ClusterEnvironment.Builder?

appTelemetryEndpoint

open fun appTelemetryEndpoint(@Nullable appTelemetryEndpoint: String?): ClusterEnvironment.Builder?

build

open override fun build(): ClusterEnvironment

Creates a ClusterEnvironment from the values of this builder.

compressionConfig

open fun compressionConfig(): CompressionConfig.Builder?

open fun ~~compressionConfig~~(compressionConfig: CompressionConfig.Builder?): ClusterEnvironment.Builder?

open fun compressionConfig(builderConsumer: Consumer<CompressionConfig.Builder?>?): ClusterEnvironment.Builder?

cryptoManager

fun cryptoManager(cryptoManager: CryptoManager?): ClusterEnvironment.Builder

Sets the cryptography manager for Field-Level Encryption (reading and writing encrypted document fields).

disableAppTelemetry

open fun disableAppTelemetry(disable: Boolean): ClusterEnvironment.Builder?

eventBus

@Stability.Uncommitted

open override fun eventBus(eventBus: EventBus?): ClusterEnvironment.Builder

ioConfig

open fun ioConfig(): IoConfig.Builder?

open fun ~~ioConfig~~(ioConfig: IoConfig.Builder?): ClusterEnvironment.Builder?

open fun ioConfig(builderConsumer: Consumer<IoConfig.Builder?>?): ClusterEnvironment.Builder?

ioEnvironment

open fun ~~ioEnvironment~~(): IoEnvironment.Builder?

open fun ~~ioEnvironment~~(ioEnvironment: IoEnvironment.Builder?): ClusterEnvironment.Builder?

open fun ioEnvironment(builderConsumer: Consumer<IoEnvironment.Builder?>?): ClusterEnvironment.Builder?

ioEnvironmentConfig

open fun ioEnvironmentConfig(): IoEnvironment.Builder?

jsonSerializer

fun jsonSerializer(jsonSerializer: JsonSerializer?): ClusterEnvironment.Builder

Sets the default serializer for converting between JSON and Java objects.

load

open fun load(loader: PropertyLoader<CoreEnvironment.Builder<*>?>?): ClusterEnvironment.Builder?

fun load(loader: ClusterPropertyLoader): ClusterEnvironment.Builder

Immediately loads the properties from the given loader into the environment.

loadSystemProperties

@Stability.Internal

open fun loadSystemProperties(): ClusterEnvironment.Builder?

loggerConfig

open fun loggerConfig(): LoggerConfig.Builder?

open fun ~~loggerConfig~~(loggerConfig: LoggerConfig.Builder?): ClusterEnvironment.Builder?

open fun loggerConfig(builderConsumer: Consumer<LoggerConfig.Builder?>?): ClusterEnvironment.Builder?

loggingMeterConfig

open fun loggingMeterConfig(): LoggingMeterConfig.Builder?

open fun ~~loggingMeterConfig~~(loggingMeterConfig: LoggingMeterConfig.Builder?): ClusterEnvironment.Builder?

open fun loggingMeterConfig(builderConsumer: Consumer<LoggingMeterConfig.Builder?>?): ClusterEnvironment.Builder?

maxNumRequestsInRetry

open fun maxNumRequestsInRetry(maxNumRequestsInRetry: Long): ClusterEnvironment.Builder?

meter

@Stability.Uncommitted

open override fun meter(meter: Meter?): ClusterEnvironment.Builder

observabilitySemanticConventions

open fun observabilitySemanticConventions(conventions: List<ObservabilitySemanticConvention?>?): ClusterEnvironment.Builder?

orphanReporterConfig

open fun orphanReporterConfig(): OrphanReporterConfig.Builder?

open fun ~~orphanReporterConfig~~(orphanReporterConfig: OrphanReporterConfig.Builder?): ClusterEnvironment.Builder?

open fun orphanReporterConfig(builderConsumer: Consumer<OrphanReporterConfig.Builder?>?): ClusterEnvironment.Builder?

preferredServerGroup

open fun preferredServerGroup(@Nullable preferredServerGroup: String?): ClusterEnvironment.Builder?

publishOnScheduler

@Stability.Volatile

open fun publishOnScheduler(@Nullable publishOnScheduler: Supplier<Scheduler?>?): ClusterEnvironment.Builder?

requestTracer

@Stability.Uncommitted

open override fun requestTracer(requestTracer: RequestTracer?): ClusterEnvironment.Builder

retryStrategy

open fun retryStrategy(retryStrategy: RetryStrategy?): ClusterEnvironment.Builder?

scheduler

@Stability.Uncommitted

open override fun scheduler(scheduler: Scheduler?): ClusterEnvironment.Builder

schedulerThreadCount

@Stability.Uncommitted

open override fun schedulerThreadCount(schedulerThreadCount: Int): ClusterEnvironment.Builder

securityConfig

open fun securityConfig(): SecurityConfig.Builder?

open fun ~~securityConfig~~(securityConfig: SecurityConfig.Builder?): ClusterEnvironment.Builder?

open fun securityConfig(builderConsumer: Consumer<SecurityConfig.Builder?>?): ClusterEnvironment.Builder?

thresholdLoggingTracerConfig

open fun thresholdLoggingTracerConfig(): ThresholdLoggingTracerConfig.Builder?

open fun ~~thresholdLoggingTracerConfig~~(thresholdLoggingTracerConfig: ThresholdLoggingTracerConfig.Builder?): ClusterEnvironment.Builder?

open fun thresholdLoggingTracerConfig(builderConsumer: Consumer<ThresholdLoggingTracerConfig.Builder?>?): ClusterEnvironment.Builder?

thresholdRequestTracerConfig

open fun ~~thresholdRequestTracerConfig~~(): ThresholdRequestTracerConfig.Builder?

open fun ~~thresholdRequestTracerConfig~~(thresholdRequestTracerConfig: ThresholdRequestTracerConfig.Builder?): ClusterEnvironment.Builder?

timeoutConfig

open fun timeoutConfig(): TimeoutConfig.Builder?

open fun ~~timeoutConfig~~(timeoutConfig: TimeoutConfig.Builder?): ClusterEnvironment.Builder?

open fun timeoutConfig(builderConsumer: Consumer<TimeoutConfig.Builder?>?): ClusterEnvironment.Builder?

transactionsConfig

@Stability.Internal

open fun transactionsConfig(transactionsConfig: CoreTransactionsConfig?): ClusterEnvironment.Builder?

transcoder

fun transcoder(transcoder: Transcoder?): ClusterEnvironment.Builder

Specifies the default transcoder for all KV operations.