| Modifier and Type | Class and Description |
|---|---|
class |
Core
The main entry point into the core layer.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Counter
Represents a generic Counter interface for metrics.
|
interface |
Meter
The generic interface for all metric implementations in the client.
|
interface |
RequestSpan
Wrapper interface for all spans flowing through the SDK.
|
interface |
RequestTracer
The
RequestTracer describes the tracing abstraction in the SDK. |
interface |
ValueRecorder
Represents a generic value recorder for the metrics interface.
|
| Modifier and Type | Method and Description |
|---|---|
default void |
RequestSpan.recordException(Throwable err)
Records that an exception happened on the span.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConnectionStringIgnoredEvent
Deprecated.
Instead of publishing this event, the SDK now throws an exception.
Because this class never graduated from "volatile API" status, it will be
removed from the next minor version of the SDK.
|
class |
TlsRequiredButNotEnabledEvent |
| Modifier and Type | Class and Description |
|---|---|
class |
LogEvent |
| Constructor and Description |
|---|
TransactionCleanupEndRunEvent(TransactionCleanupStartRunEvent start,
Map<String,ActiveTransactionRecordStats> atrStats,
Duration timeOfLastRun) |
TransactionCleanupStartRunEvent(String bucketName,
String scopeName,
String collectionName,
String clientUuid,
ClientRecordDetails clientDetails,
Duration cleanupWindow,
int atrsToCheckInNextWindow,
int totalAtrs,
Duration checkAtrEvery) |
| Modifier and Type | Class and Description |
|---|---|
class |
AggregatingCounter
At the moment this is a NOOP implementation because we do not perform any aggregations
on the counters.
|
class |
AggregatingValueRecorder
Aggregates value information in a histogram.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AuthenticationStatus
The last known authentication status for an endpoint.
|
| Modifier and Type | Method and Description |
|---|---|
CircuitBreaker.State |
EndpointDiagnostics.circuitBreakerState()
The current state of the endpoint's circuit breaker
|
Optional<Throwable> |
EndpointDiagnostics.lastConnectAttemptFailure()
If present, returns the last connect failure of this endpoint.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CryptoManager
Provides low-level encryption routines for implementing Field-Level Encryption as specified by
Couchbase RFC-0032.
|
| Modifier and Type | Method and Description |
|---|---|
Map<String,Object> |
CircuitBreakerConfig.exportAsMap() |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ConfigurationProfile |
class |
TimerConfig
Configures the internal Timer, which asynchronous retries and timeouts fire on.
|
class |
WanDevelopmentProfile
The "wan-development" environment profile.
|
| Modifier and Type | Field and Description |
|---|---|
static Duration |
TimeoutConfig.DEFAULT_BACKUP_TIMEOUT |
| Modifier and Type | Method and Description |
|---|---|
SELF |
CoreEnvironment.Builder.applyProfile(String profileName)
Applies custom properties based on a profile name.
|
CircuitBreakerConfig |
IoConfig.backupCircuitBreakerConfig() |
CircuitBreakerConfig.Builder |
IoConfig.Builder.backupCircuitBreakerConfig() |
static IoConfig.Builder |
IoConfig.backupCircuitBreakerConfig(CircuitBreakerConfig.Builder backupCircuitBreakerConfig)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
IoConfig.builder(). |
IoConfig.Builder |
IoConfig.Builder.backupCircuitBreakerConfig(CircuitBreakerConfig.Builder backupCircuitBreakerConfig)
Deprecated.
Please use
IoConfig.Builder.backupCircuitBreakerConfig(Consumer) instead. |
IoConfig.Builder |
IoConfig.Builder.backupCircuitBreakerConfig(Consumer<CircuitBreakerConfig.Builder> builderConsumer)
Configures the backup circuit breaker by passing its config builder to the given consumer.
|
Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup> |
IoEnvironment.backupEventLoopGroup()
Returns the
EventLoopGroup to be used for backup traffic. |
static IoEnvironment.Builder |
IoEnvironment.backupEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup eventLoopGroup)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
IoEnvironment.builder(). |
IoEnvironment.Builder |
IoEnvironment.Builder.backupEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup eventLoopGroup)
Allows to specify a custom event loop group (I/O event loop thread pool) for the backup service.
|
Duration |
TimeoutConfig.backupTimeout() |
static TimeoutConfig.Builder |
TimeoutConfig.backupTimeout(Duration backupTimeout)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
TimeoutConfig.builder(). |
TimeoutConfig.Builder |
TimeoutConfig.Builder.backupTimeout(Duration backupTimeout)
Sets the timeout to use for backup operations.
|
static List<X509Certificate> |
SecurityConfig.capellaCaCertificates()
Returns the Certificate Authority (CA) certificates required for connecting to Couchbase Capella.
|
static List<X509Certificate> |
SecurityConfig.defaultCaCertificates()
Returns the Certificate Authority (CA) certificates that are trusted if
no other certificate (or other trust source) is specified in the security config.
|
SecurityConfig.Builder |
SecurityConfig.Builder.enableCertificateVerification(boolean certificateVerificationEnabled)
Pass false to bypass all TLS certificate verification checks.
|
static List<X509Certificate> |
SecurityConfig.jvmCaCertificates()
Returns the Certificate Authority (CA) certificates trusted by the JVM's default trust manager.
|
static TimeoutConfig.Builder |
TimeoutConfig.kvDurableTimeout(Duration kvDurableTimeout)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
TimeoutConfig.builder(). |
Duration |
TimeoutConfig.kvScanTimeout() |
static TimeoutConfig.Builder |
TimeoutConfig.kvScanTimeout(Duration kvScanTimeout)
Deprecated.
This method creates a new builder. Please see the deprecation notice on
TimeoutConfig.builder(). |
Meter |
CoreEnvironment.meter() |
SELF |
CoreEnvironment.Builder.meter(Meter meter)
Allows to configure a custom metrics implementation.
|
TimerConfig.Builder |
TimerConfig.Builder.numBuckets(int numBuckets)
Internally, each Timer divides time into a number of buckets, which this setting controls.
|
TimerConfig.Builder |
TimerConfig.Builder.numTimers(int numTimers)
Configures multiple parallel Timers, allowing more throughput of retries and timeouts.
|
Optional<Integer> |
SeedNode.protostellarPort()
If present, the Protostellar port.
|
RequestTracer |
CoreEnvironment.requestTracer()
Returns the request tracer for response time observability.
|
SELF |
CoreEnvironment.Builder.requestTracer(RequestTracer requestTracer)
Allows to configure a custom tracer implementation.
|
TimerConfig.Builder |
TimerConfig.Builder.tickDuration(Duration tickDuration)
Configures the time between each 'tick' of the Timer(s).
|
TimerConfig |
IoConfig.timerConfig() |
TimerConfig.Builder |
IoConfig.Builder.timerConfig() |
IoConfig.Builder |
IoConfig.Builder.timerConfig(Consumer<TimerConfig.Builder> builderConsumer)
Configures the timer by passing its config builder to the given consumer.
|
CoreTransactionsConfig |
CoreEnvironment.transactionsConfig() |
CoreTransactionsSchedulers |
CoreEnvironment.transactionsSchedulers()
The schedulers used for any transactional operations.
|
SeedNode |
SeedNode.withProtostellarPort(Integer port)
Returns a copy of this seed node, with the given Protostellar port.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BucketExistsException |
class |
BucketNotFoundException |
class |
CollectionExistsException |
class |
CollectionNotFoundException |
class |
GroupNotFoundException |
class |
ScopeExistsException |
class |
ScopeNotFoundException |
class |
UserNotFoundException |
| Modifier and Type | Class and Description |
|---|---|
class |
GenericErrorContext |
| Modifier and Type | Method and Description |
|---|---|
long |
RequestContext.dispatchLatency()
Returns the duration of the dispatch phase if set.
|
long |
RequestContext.encodeLatency() |
String |
RequestContext.lastChannelId() |
long |
RequestContext.serverLatency() |
| Modifier and Type | Class and Description |
|---|---|
class |
ProtostellarBaseRequest
Where the public API requires a
Request, create one dynamically. |
| Modifier and Type | Class and Description |
|---|---|
class |
ProtostellarCoreQueryResult |
| Modifier and Type | Class and Description |
|---|---|
class |
RetryReason
Provides more insight into why an operation has been retried.
|
| Modifier and Type | Method and Description |
|---|---|
static RetryAction |
RetryAction.noRetry(Function<Throwable,Throwable> exceptionTranslator)
Constructs a new
RetryAction indicating that the request should not be retried,
and a specific exception should be used to fail the request. |
| Modifier and Type | Method and Description |
|---|---|
Map<String,Object> |
CoreTransactionsConfig.exportAsMap() |
Copyright © 2024 Couchbase, Inc.. All rights reserved.