Package com.couchbase.client.core.env

Class IoConfig.Builder

java.lang.Object

com.couchbase.client.core.env.IoConfig.Builder

Enclosing class:

IoConfig

public static class IoConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CircuitBreakerConfig.Builder	analyticsCircuitBreakerConfig()
IoConfig.Builder	analyticsCircuitBreakerConfig(CircuitBreakerConfig.Builder analyticsCircuitBreakerConfig)	Deprecated. Please use analyticsCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	analyticsCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the analytics circuit breaker by passing its config builder to the given consumer.
CircuitBreakerConfig.Builder	backupCircuitBreakerConfig()
IoConfig.Builder	backupCircuitBreakerConfig(CircuitBreakerConfig.Builder backupCircuitBreakerConfig)	Deprecated. Please use backupCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	backupCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the backup circuit breaker by passing its config builder to the given consumer.
IoConfig	build()
IoConfig.Builder	captureTraffic(ServiceType... serviceTypes)	Captures and logs network traffic for the specified services (or all services if none are specified).
IoConfig.Builder	configIdleRedialTimeout(Duration configIdleRedialTimeout)
IoConfig.Builder	configPollInterval(Duration configPollInterval)
IoConfig.Builder	enableDnsSrv(boolean dnsSrvEnabled)
IoConfig.Builder	enableMutationTokens(boolean mutationTokensEnabled)	Configures whether mutation tokens will be returned from the server for all mutation operations.
IoConfig.Builder	enableTcpKeepAlives(boolean tcpKeepAlivesEnabled)	Whether to use TCP keepalive probes.
CircuitBreakerConfig.Builder	eventingCircuitBreakerConfig()
IoConfig.Builder	eventingCircuitBreakerConfig(CircuitBreakerConfig.Builder eventingCircuitBreakerConfig)	Deprecated. Please use eventingCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	eventingCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the eventing circuit breaker by passing its config builder to the given consumer.
IoConfig.Builder	idleHttpConnectionTimeout(Duration idleHttpConnectionTimeout)
CircuitBreakerConfig.Builder	kvCircuitBreakerConfig()
IoConfig.Builder	kvCircuitBreakerConfig(CircuitBreakerConfig.Builder kvCircuitBreakerConfig)	Deprecated. Please use kvCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	kvCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the key-value circuit breaker by passing its config builder to the given consumer.
CircuitBreakerConfig.Builder	managerCircuitBreakerConfig()
IoConfig.Builder	managerCircuitBreakerConfig(CircuitBreakerConfig.Builder managerCircuitBreakerConfig)	Deprecated. Please use managerCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	managerCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the manager circuit breaker by passing its config builder to the given consumer.
IoConfig.Builder	maxHttpConnections(int maxHttpConnections)
IoConfig.Builder	memcachedHashingStrategy(MemcachedHashingStrategy memcachedHashingStrategy)	Allows to customize the hashing strategy for memcached buckets.
IoConfig.Builder	networkResolution(NetworkResolution networkResolution)
IoConfig.Builder	numKvConnections(int numKvConnections)
CircuitBreakerConfig.Builder	queryCircuitBreakerConfig()
IoConfig.Builder	queryCircuitBreakerConfig(CircuitBreakerConfig.Builder queryCircuitBreakerConfig)	Deprecated. Please use queryCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	queryCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the query circuit breaker by passing its config builder to the given consumer.
CircuitBreakerConfig.Builder	searchCircuitBreakerConfig()
IoConfig.Builder	searchCircuitBreakerConfig(CircuitBreakerConfig.Builder searchCircuitBreakerConfig)	Deprecated. Please use searchCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	searchCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the search circuit breaker by passing its config builder to the given consumer.
IoConfig.Builder	tcpKeepAliveCount(int tcpKeepAliveCount)	The maximum number of keepalive probes TCP should send before dropping the connection (TCP_KEEPCNT / tcp_keepalive_probes).
IoConfig.Builder	tcpKeepAliveInterval(Duration tcpKeepAliveInterval)	The time between individual keepalive probes.
IoConfig.Builder	tcpKeepAliveTime(Duration tcpKeepAliveTime)	The time the connection needs to remain idle before TCP starts sending keepalive probes, if enableTcpKeepAlives(boolean) is set to true (TCP_KEEPIDLE / tcp_keepalive_time).
IoConfig.Builder	tcpUserTimeout(Duration tcpUserTimeout)	The maximum amount of time that transmitted data may remain unacknowledged, or buffered data may remain untransmitted (due to zero window size) before TCP will forcibly close the corresponding connection and return ETIMEDOUT to the application.
TimerConfig.Builder	timerConfig()
IoConfig.Builder	timerConfig(Consumer<TimerConfig.Builder> builderConsumer)	Configures the backup circuit breaker by passing its config builder to the given consumer.
CircuitBreakerConfig.Builder	viewCircuitBreakerConfig()
IoConfig.Builder	viewCircuitBreakerConfig(CircuitBreakerConfig.Builder viewCircuitBreakerConfig)	Deprecated. Please use viewCircuitBreakerConfig(Consumer) instead.
IoConfig.Builder	viewCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)	Configures the views circuit breaker by passing its config builder to the given consumer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public IoConfig build()

configPollInterval

public IoConfig.Builder configPollInterval(Duration configPollInterval)

enableMutationTokens

public IoConfig.Builder enableMutationTokens(boolean mutationTokensEnabled)

Configures whether mutation tokens will be returned from the server for all mutation operations.

Returns:

this, for chaining

enableDnsSrv

public IoConfig.Builder enableDnsSrv(boolean dnsSrvEnabled)

enableTcpKeepAlives

public IoConfig.Builder enableTcpKeepAlives(boolean tcpKeepAlivesEnabled)

Whether to use TCP keepalive probes.

Defaults to true.

tcpKeepAliveTime

public IoConfig.Builder tcpKeepAliveTime(Duration tcpKeepAliveTime)

The time the connection needs to remain idle before TCP starts sending keepalive probes, if enableTcpKeepAlives(boolean) is set to true (TCP_KEEPIDLE / tcp_keepalive_time).

Resolution: seconds.

Defaults to 1 minute.

Please note that this setting only propagates to the OS on Linux when the epoll transport is used. On all other platforms, the OS-configured time is used (and you need to tune it there if you want to customize the default behavior).

Parameters:

tcpKeepAliveTime - the custom keepalive time.

Returns:

this builder for chaining purposes.

See Also:

• enableTcpKeepAlives(boolean)
• tcpKeepAliveInterval(Duration)
• tcpKeepAliveCount(int)
• tcpUserTimeout(Duration)

tcpKeepAliveInterval

public IoConfig.Builder tcpKeepAliveInterval(Duration tcpKeepAliveInterval)

The time between individual keepalive probes. (TCP_KEEPINTVL / tcp_keepalive_intvl). Used only if enableTcpKeepAlives(boolean) is set to true.

Resolution: seconds.

Defaults to zero, in which case the OS-level default is used.

Please note that this setting only propagates to the OS on Linux when the epoll transport is used. On all other platforms, the OS-configured time is used (and you need to tune it there if you want to customize the default behavior).

Parameters:

tcpKeepAliveInterval - the custom keepalive time.

Returns:

this builder for chaining purposes.

See Also:

• enableTcpKeepAlives(boolean)
• tcpKeepAliveTime(Duration)
• tcpKeepAliveCount(int)
• tcpUserTimeout(Duration)

tcpKeepAliveCount

public IoConfig.Builder tcpKeepAliveCount(int tcpKeepAliveCount)

The maximum number of keepalive probes TCP should send before dropping the connection (TCP_KEEPCNT / tcp_keepalive_probes). Used only if enableTcpKeepAlives(boolean) is set to true.

Defaults to zero, in which case the OS-level default is used.

Please note that this setting only propagates to the OS on Linux when the epoll transport is used. On all other platforms, the OS-configured time is used (and you need to tune it there if you want to customize the default behavior).

Parameters:

tcpKeepAliveCount - The maximum number of probes, or zero for the OS default.

Returns:

this builder for chaining purposes.

See Also:

• enableTcpKeepAlives(boolean)
• tcpKeepAliveTime(Duration)
• tcpKeepAliveInterval(Duration)
• tcpUserTimeout(Duration)

tcpUserTimeout

public IoConfig.Builder tcpUserTimeout(Duration tcpUserTimeout)

The maximum amount of time that transmitted data may remain unacknowledged, or buffered data may remain untransmitted (due to zero window size) before TCP will forcibly close the corresponding connection and return ETIMEDOUT to the application.

This setting will also be used in the Linux kernel's calculation of when idle connections are reset during keepalive transmissions.

Resolution: milliseconds.

Defaults to 20 seconds.

Please note that this setting only propagates to the OS on Linux when the epoll transport is used. On all other platforms, the OS-configured time is used (and you need to tune it there if you want to customize the default behavior).

Parameters:

tcpUserTimeout - The desired timeout, or Duration.zero() for the OS default.

Returns:

this builder for chaining purposes.

See Also:

• enableTcpKeepAlives(boolean)
• tcpKeepAliveTime(Duration)
• tcpKeepAliveInterval(Duration)
• tcpKeepAliveCount(int)

kvCircuitBreakerConfig

public IoConfig.Builder kvCircuitBreakerConfig(CircuitBreakerConfig.Builder kvCircuitBreakerConfig)

Deprecated.

Please use kvCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for key-value operations.

Returns:

this, for chaining

kvCircuitBreakerConfig

public IoConfig.Builder kvCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the key-value circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

kvCircuitBreakerConfig

public CircuitBreakerConfig.Builder kvCircuitBreakerConfig()

queryCircuitBreakerConfig

public IoConfig.Builder queryCircuitBreakerConfig(CircuitBreakerConfig.Builder queryCircuitBreakerConfig)

Deprecated.

Please use queryCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for query operations.

Returns:

this, for chaining

queryCircuitBreakerConfig

public IoConfig.Builder queryCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the query circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

queryCircuitBreakerConfig

public CircuitBreakerConfig.Builder queryCircuitBreakerConfig()

viewCircuitBreakerConfig

public IoConfig.Builder viewCircuitBreakerConfig(CircuitBreakerConfig.Builder viewCircuitBreakerConfig)

Deprecated.

Please use viewCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for view operations.

Returns:

this, for chaining

viewCircuitBreakerConfig

public IoConfig.Builder viewCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the views circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

viewCircuitBreakerConfig

public CircuitBreakerConfig.Builder viewCircuitBreakerConfig()

searchCircuitBreakerConfig

public IoConfig.Builder searchCircuitBreakerConfig(CircuitBreakerConfig.Builder searchCircuitBreakerConfig)

Deprecated.

Please use searchCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for search operations.

Returns:

this, for chaining

searchCircuitBreakerConfig

public IoConfig.Builder searchCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the search circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

searchCircuitBreakerConfig

public CircuitBreakerConfig.Builder searchCircuitBreakerConfig()

analyticsCircuitBreakerConfig

public IoConfig.Builder analyticsCircuitBreakerConfig(CircuitBreakerConfig.Builder analyticsCircuitBreakerConfig)

Deprecated.

Please use analyticsCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for analytics operations.

Returns:

this, for chaining

analyticsCircuitBreakerConfig

public IoConfig.Builder analyticsCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the analytics circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

analyticsCircuitBreakerConfig

public CircuitBreakerConfig.Builder analyticsCircuitBreakerConfig()

managerCircuitBreakerConfig

public IoConfig.Builder managerCircuitBreakerConfig(CircuitBreakerConfig.Builder managerCircuitBreakerConfig)

Deprecated.

Please use managerCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for manager operations.

Returns:

this, for chaining

managerCircuitBreakerConfig

public IoConfig.Builder managerCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the manager circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

managerCircuitBreakerConfig

public CircuitBreakerConfig.Builder managerCircuitBreakerConfig()

eventingCircuitBreakerConfig

public IoConfig.Builder eventingCircuitBreakerConfig(CircuitBreakerConfig.Builder eventingCircuitBreakerConfig)

Deprecated.

Please use eventingCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for eventing operations.

Returns:

this, for chaining

eventingCircuitBreakerConfig

public IoConfig.Builder eventingCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the eventing circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

eventingCircuitBreakerConfig

public CircuitBreakerConfig.Builder eventingCircuitBreakerConfig()

backupCircuitBreakerConfig

@Volatile
public IoConfig.Builder backupCircuitBreakerConfig(CircuitBreakerConfig.Builder backupCircuitBreakerConfig)

Deprecated.

Please use backupCircuitBreakerConfig(Consumer) instead.

Configures a CircuitBreaker to use for backup operations.

Returns:

this, for chaining

backupCircuitBreakerConfig

@Volatile
public IoConfig.Builder backupCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)

Configures the backup circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

backupCircuitBreakerConfig

@Volatile
public CircuitBreakerConfig.Builder backupCircuitBreakerConfig()

captureTraffic

public IoConfig.Builder captureTraffic(ServiceType... serviceTypes)

Captures and logs network traffic for the specified services (or all services if none are specified).

IMPORTANT: Captured traffic is logged to the "com.couchbase.io" category at TRACE level. To see the log messages, make sure your logging library is configured appropriately. For example, if you're using Log4j2 with XML configuration, add this as a child of the <Loggers> element:

 <Logger name="com.couchbase.io" level="trace"/>
 

Traffic capture should only be enabled during development and for debugging purposes. When enabled it will add more overhead due to traffic parsing, logging, and analysis.

Returns:

this IoConfig.Builder for chaining purposes.

networkResolution

public IoConfig.Builder networkResolution(NetworkResolution networkResolution)

numKvConnections

public IoConfig.Builder numKvConnections(int numKvConnections)

maxHttpConnections

public IoConfig.Builder maxHttpConnections(int maxHttpConnections)

idleHttpConnectionTimeout

public IoConfig.Builder idleHttpConnectionTimeout(Duration idleHttpConnectionTimeout)

configIdleRedialTimeout

public IoConfig.Builder configIdleRedialTimeout(Duration configIdleRedialTimeout)

memcachedHashingStrategy

public IoConfig.Builder memcachedHashingStrategy(MemcachedHashingStrategy memcachedHashingStrategy)

Allows to customize the hashing strategy for memcached buckets.

Usually the MemcachedHashingStrategy should only be customized if i.e. the SDK is upgraded from Java SDK 2 and the documents in the bucket must be preserved. In this case, the Sdk2CompatibleMemcachedHashingStrategy must be chosen. If it is used though, keep in mind that it is not compatible with other SDKs, so we always recommend to use the default StandardMemcachedHashingStrategy by default.

Parameters:

memcachedHashingStrategy - the strategy to use.

Returns:

this IoConfig.Builder for chaining purposes.

timerConfig

@Volatile
public IoConfig.Builder timerConfig(Consumer<TimerConfig.Builder> builderConsumer)

Configures the backup circuit breaker by passing its config builder to the given consumer.

Returns:

this, for chaining

timerConfig

@Volatile
public TimerConfig.Builder timerConfig()