public class IoConfig extends Object
Modifier and Type | Class and Description |
---|---|
static class |
IoConfig.Builder |
Modifier and Type | Field and Description |
---|---|
static Duration |
DEFAULT_CONFIG_IDLE_REDIAL_TIMEOUT |
static Duration |
DEFAULT_CONFIG_POLL_INTERVAL |
static boolean |
DEFAULT_DNS_SRV_ENABLED |
static Duration |
DEFAULT_IDLE_HTTP_CONNECTION_TIMEOUT |
static int |
DEFAULT_MAX_HTTP_CONNECTIONS |
static MemcachedHashingStrategy |
DEFAULT_MEMCACHED_HASHING_STRATEGY |
static boolean |
DEFAULT_MUTATION_TOKENS_ENABLED |
static NetworkResolution |
DEFAULT_NETWORK_RESOLUTION |
static int |
DEFAULT_NUM_KV_CONNECTIONS |
static boolean |
DEFAULT_TCP_KEEPALIVE_ENABLED |
static Duration |
DEFAULT_TCP_KEEPALIVE_TIME |
Modifier and Type | Method and Description |
---|---|
CircuitBreakerConfig |
analyticsCircuitBreakerConfig() |
static IoConfig.Builder |
analyticsCircuitBreakerConfig(CircuitBreakerConfig.Builder analyticsCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
CircuitBreakerConfig |
backupCircuitBreakerConfig() |
static IoConfig.Builder |
backupCircuitBreakerConfig(CircuitBreakerConfig.Builder backupCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
static IoConfig.Builder |
builder()
Deprecated.
Instead of creating a new builder, please use
CoreEnvironment.Builder.ioConfig(Consumer)
and configure the builder passed to the consumer.
Note: CoreEnvironment is a base class; you'll
probably call that method via a subclass named
ClusterEnvironment . |
static IoConfig.Builder |
captureTraffic(ServiceType... serviceTypes)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
Duration |
configIdleRedialTimeout() |
static IoConfig.Builder |
configIdleRedialTimeout(Duration configIdleRedialTimeout)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
Duration |
configPollInterval() |
static IoConfig.Builder |
configPollInterval(Duration configPollInterval)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
static IoConfig |
create()
Deprecated.
Instead, please use
CoreEnvironment.Builder.ioConfig(Consumer)
and configure the builder passed to the consumer.
Note: CoreEnvironment is a base class; you'll
probably call that method via a subclass named
ClusterEnvironment . |
boolean |
dnsSrvEnabled() |
static IoConfig.Builder |
enableDnsSrv(boolean dnsSrvEnabled)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
static IoConfig.Builder |
enableMutationTokens(boolean mutationTokensEnabled)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
static IoConfig.Builder |
enableTcpKeepAlives(boolean tcpKeepAliveEnabled)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
CircuitBreakerConfig |
eventingCircuitBreakerConfig() |
static IoConfig.Builder |
eventingCircuitBreakerConfig(CircuitBreakerConfig.Builder eventingCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
Duration |
idleHttpConnectionTimeout() |
static IoConfig.Builder |
idleHttpConnectionTimeout(Duration idleHttpConnectionTimeout)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
CircuitBreakerConfig |
kvCircuitBreakerConfig() |
static IoConfig.Builder |
kvCircuitBreakerConfig(CircuitBreakerConfig.Builder kvCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
CircuitBreakerConfig |
managerCircuitBreakerConfig() |
static IoConfig.Builder |
managerCircuitBreakerConfig(CircuitBreakerConfig.Builder managerCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
int |
maxHttpConnections() |
static IoConfig.Builder |
maxHttpConnections(int maxHttpConnections)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
MemcachedHashingStrategy |
memcachedHashingStrategy() |
static IoConfig.Builder |
memcachedHashingStrategy(MemcachedHashingStrategy memcachedHashingStrategy)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
boolean |
mutationTokensEnabled() |
NetworkResolution |
networkResolution() |
static IoConfig.Builder |
networkResolution(NetworkResolution networkResolution)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
int |
numKvConnections() |
static IoConfig.Builder |
numKvConnections(int numKvConnections)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
CircuitBreakerConfig |
queryCircuitBreakerConfig() |
static IoConfig.Builder |
queryCircuitBreakerConfig(CircuitBreakerConfig.Builder queryCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
CircuitBreakerConfig |
searchCircuitBreakerConfig() |
static IoConfig.Builder |
searchCircuitBreakerConfig(CircuitBreakerConfig.Builder searchCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
Set<ServiceType> |
servicesToCapture()
Lists the services on which traffic should be captured.
|
boolean |
tcpKeepAlivesEnabled() |
Duration |
tcpKeepAliveTime() |
static IoConfig.Builder |
tcpKeepAliveTime(Duration tcpKeepAliveTime)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
TimerConfig |
timerConfig() |
CircuitBreakerConfig |
viewCircuitBreakerConfig() |
static IoConfig.Builder |
viewCircuitBreakerConfig(CircuitBreakerConfig.Builder viewCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
builder() . |
public static final boolean DEFAULT_MUTATION_TOKENS_ENABLED
public static final boolean DEFAULT_DNS_SRV_ENABLED
public static final boolean DEFAULT_TCP_KEEPALIVE_ENABLED
public static final Duration DEFAULT_TCP_KEEPALIVE_TIME
public static final Duration DEFAULT_CONFIG_POLL_INTERVAL
public static final NetworkResolution DEFAULT_NETWORK_RESOLUTION
public static final int DEFAULT_NUM_KV_CONNECTIONS
public static final int DEFAULT_MAX_HTTP_CONNECTIONS
public static final Duration DEFAULT_IDLE_HTTP_CONNECTION_TIMEOUT
public static final Duration DEFAULT_CONFIG_IDLE_REDIAL_TIMEOUT
public static final MemcachedHashingStrategy DEFAULT_MEMCACHED_HASHING_STRATEGY
@Deprecated public static IoConfig create()
CoreEnvironment.Builder.ioConfig(Consumer)
and configure the builder passed to the consumer.
Note: CoreEnvironment is a base class; you'll
probably call that method via a subclass named
ClusterEnvironment
.@Deprecated public static IoConfig.Builder builder()
CoreEnvironment.Builder.ioConfig(Consumer)
and configure the builder passed to the consumer.
Note: CoreEnvironment is a base class; you'll
probably call that method via a subclass named
ClusterEnvironment
.@Deprecated public static IoConfig.Builder enableMutationTokens(boolean mutationTokensEnabled)
builder()
.@Deprecated public static IoConfig.Builder enableDnsSrv(boolean dnsSrvEnabled)
builder()
.@Deprecated public static IoConfig.Builder configPollInterval(Duration configPollInterval)
builder()
.@Deprecated public static IoConfig.Builder kvCircuitBreakerConfig(CircuitBreakerConfig.Builder kvCircuitBreakerConfig)
builder()
.@Deprecated public static IoConfig.Builder queryCircuitBreakerConfig(CircuitBreakerConfig.Builder queryCircuitBreakerConfig)
builder()
.@Deprecated public static IoConfig.Builder viewCircuitBreakerConfig(CircuitBreakerConfig.Builder viewCircuitBreakerConfig)
builder()
.@Deprecated public static IoConfig.Builder searchCircuitBreakerConfig(CircuitBreakerConfig.Builder searchCircuitBreakerConfig)
builder()
.@Deprecated public static IoConfig.Builder analyticsCircuitBreakerConfig(CircuitBreakerConfig.Builder analyticsCircuitBreakerConfig)
builder()
.@Deprecated public static IoConfig.Builder managerCircuitBreakerConfig(CircuitBreakerConfig.Builder managerCircuitBreakerConfig)
builder()
.@Deprecated public static IoConfig.Builder eventingCircuitBreakerConfig(CircuitBreakerConfig.Builder eventingCircuitBreakerConfig)
builder()
.@Deprecated @Stability.Volatile public static IoConfig.Builder backupCircuitBreakerConfig(CircuitBreakerConfig.Builder backupCircuitBreakerConfig)
builder()
.@Deprecated public static IoConfig.Builder captureTraffic(ServiceType... serviceTypes)
builder()
.IMPORTANT: It is not enough to just enable traffic capturing, also TRACE level logging needs to be enabled for the couchbase namespace in your logger implementation.
Note that this flag should only be enabled during development and for debugging purposes. When enabled it will add more overhead due to traffic parsing, logging and analysis.
IoConfig.Builder
for chaining purposes.@Deprecated public static IoConfig.Builder networkResolution(NetworkResolution networkResolution)
builder()
.@Deprecated public static IoConfig.Builder enableTcpKeepAlives(boolean tcpKeepAliveEnabled)
builder()
.@Deprecated public static IoConfig.Builder tcpKeepAliveTime(Duration tcpKeepAliveTime)
builder()
.@Deprecated public static IoConfig.Builder numKvConnections(int numKvConnections)
builder()
.@Deprecated public static IoConfig.Builder maxHttpConnections(int maxHttpConnections)
builder()
.@Deprecated public static IoConfig.Builder idleHttpConnectionTimeout(Duration idleHttpConnectionTimeout)
builder()
.@Deprecated public static IoConfig.Builder configIdleRedialTimeout(Duration configIdleRedialTimeout)
builder()
.@Deprecated public static IoConfig.Builder memcachedHashingStrategy(MemcachedHashingStrategy memcachedHashingStrategy)
builder()
.
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.
memcachedHashingStrategy
- the strategy to use.IoConfig.Builder
for chaining purposes.public CircuitBreakerConfig kvCircuitBreakerConfig()
public CircuitBreakerConfig queryCircuitBreakerConfig()
public CircuitBreakerConfig viewCircuitBreakerConfig()
public CircuitBreakerConfig searchCircuitBreakerConfig()
public CircuitBreakerConfig analyticsCircuitBreakerConfig()
public CircuitBreakerConfig managerCircuitBreakerConfig()
public CircuitBreakerConfig eventingCircuitBreakerConfig()
@Stability.Volatile public CircuitBreakerConfig backupCircuitBreakerConfig()
public boolean mutationTokensEnabled()
public boolean dnsSrvEnabled()
public Duration configPollInterval()
public Set<ServiceType> servicesToCapture()
public NetworkResolution networkResolution()
public boolean tcpKeepAlivesEnabled()
public Duration tcpKeepAliveTime()
public int numKvConnections()
public int maxHttpConnections()
public Duration idleHttpConnectionTimeout()
public Duration configIdleRedialTimeout()
public MemcachedHashingStrategy memcachedHashingStrategy()
@Stability.Volatile public TimerConfig timerConfig()
Copyright © 2024 Couchbase, Inc.. All rights reserved.