Uses of Annotation Type
com.couchbase.client.core.annotation.Stability.Internal
Packages that use Stability.Internal
Package
Description
-
Uses of Stability.Internal in com.couchbase.client.core
Classes in com.couchbase.client.core with annotations of type Stability.InternalModifier and TypeClassDescriptionclassTheTimeracts as the main timing facility for various operations, for example to track and time out requests if they run for too long or for rescheduling needs.Methods in com.couchbase.client.core with annotations of type Stability.InternalModifier and TypeMethodDescriptionCoreContext.alternateAddress(Optional<String> alternateAddress) Sets the alternate address on this context.Core.clusterConfig()This API provides access to the current config that is published throughout the core.Core.configurationProvider()Returns the attached configuration provider.Core.diagnostics()Core.ensureServiceAt(NodeIdentifier identifier, ServiceType serviceType, int port, Optional<String> bucket, Optional<String> alternateAddress) This method can be used by a caller to make sure a certain service is enabled at the given target node.Core.httpClient(RequestTarget target) Returns a client for issuing HTTP requests to servers in the cluster.voidCore.initGlobalConfig()Instructs the client to, if possible, load and initialize the global config.voidCore.openBucket(String name) Attempts to open a bucket and fails theMonoif there is a persistent error as the reason.Core.responseMetric(Request<?> request) <R extends Response>
voidSends a command into the core layer and allows to avoid timeout registration.Core.serviceState(NodeIdentifier nodeIdentifier, ServiceType type, Optional<String> bucket) If present, returns a flux that allows to monitor the state changes of a specific service.Core.shutdown()Shuts down this core and all associated, owned resources.Core.transactionsCleanup() -
Uses of Stability.Internal in com.couchbase.client.core.annotation
Classes in com.couchbase.client.core.annotation with annotations of type Stability.InternalModifier and TypeClassDescription@interfaceSpecifies the earliest version of Couchbase Server that supports the annotated feature. -
Uses of Stability.Internal in com.couchbase.client.core.callbacks
Classes in com.couchbase.client.core.callbacks with annotations of type Stability.InternalModifier and TypeInterfaceDescriptioninterfaceThis callback is executed once an operation reaches the core and gets sent to a node. -
Uses of Stability.Internal in com.couchbase.client.core.cnc
Classes in com.couchbase.client.core.cnc with annotations of type Stability.InternalModifier and TypeClassDescriptionclassstatic interfaceGeneric logger interface.classclassThis super simple event bus should be used in testing only to assert certain events got pushed through.classHolds static tracing identifiers throughout the SDK.Methods in com.couchbase.client.core.cnc with annotations of type Stability.InternalModifier and TypeMethodDescriptionvoidRequestSpan.requestContext(RequestContext requestContext) Allows to set a request context to the request span.Constructors in com.couchbase.client.core.cnc with annotations of type Stability.InternalModifierConstructorDescriptionOrphanReporter(EventBus eventBus, OrphanReporterConfig config) Creates a newOrphanReporter. -
Uses of Stability.Internal in com.couchbase.client.core.cnc.events.transaction
Constructors in com.couchbase.client.core.cnc.events.transaction with annotations of type Stability.InternalModifierConstructorDescriptionTransactionLogEvent(long timestamp, long threadId, String threadName, String transactionId, String secondaryId, String fmt, Object[] values, Event.Severity level) -
Uses of Stability.Internal in com.couchbase.client.core.cnc.metrics
Classes in com.couchbase.client.core.cnc.metrics with annotations of type Stability.InternalModifier and TypeClassDescriptionclassHelper class which consolidates names and tags for caching purposes. -
Uses of Stability.Internal in com.couchbase.client.core.config
Classes in com.couchbase.client.core.config with annotations of type Stability.InternalModifier and TypeInterfaceDescriptioninterfaceTheConfigurationProvideris responsible for grabbing, converting and managing bucket and cluster configurations.Methods in com.couchbase.client.core.config with annotations of type Stability.InternalModifier and TypeMethodDescriptionvoidClusterConfig.deleteBucketConfig(String bucketName) voidClusterConfig.deleteGlobalConfig()voidClusterConfig.setBucketConfig(BucketConfig config) voidClusterConfig.setGlobalConfig(GlobalConfig config) -
Uses of Stability.Internal in com.couchbase.client.core.config.refresher
Classes in com.couchbase.client.core.config.refresher with annotations of type Stability.InternalModifier and TypeClassDescriptionclassTheKeyValueBucketRefresherkeeps configs up-to-date through the KV service. -
Uses of Stability.Internal in com.couchbase.client.core.diagnostics
Classes in com.couchbase.client.core.diagnostics with annotations of type Stability.InternalModifier and TypeClassDescriptionclassTheHealthPingerallows to "ping" individual services with real operations for their health.classHelper class to perform the "wait until ready" logic.static classEncapsulates the state of where a wait until ready flow is in.Methods in com.couchbase.client.core.diagnostics with annotations of type Stability.InternalModifier and TypeMethodDescriptionstatic Mono<PingResult>HealthPinger.ping(Core core, Optional<Duration> timeout, RetryStrategy retryStrategy, Set<ServiceType> serviceTypes, Optional<String> reportId, Optional<String> bucketName) Performs a service ping against all or (if given) the services provided.static CompletableFuture<Void>WaitUntilReadyHelper.waitUntilReady(Core core, Set<ServiceType> serviceTypes, Duration timeout, ClusterState desiredState, Optional<String> bucketName) Constructors in com.couchbase.client.core.diagnostics with annotations of type Stability.InternalModifierConstructorDescriptionDiagnosticsResult(Map<ServiceType, List<EndpointDiagnostics>> endpoints, String sdk, String id) Creates the new diagnostics report.EndpointDiagnostics(ServiceType type, EndpointState state, String local, String remote, Optional<String> namespace, Optional<Long> lastActivityUs, Optional<String> id, Optional<Throwable> lastConnectAttemptFailure) EndpointPingReport(ServiceType type, String id, String local, String remote, PingState state, Optional<String> namespace, Duration latency, Optional<String> error) PingResult(Map<ServiceType, List<EndpointPingReport>> endpoints, String sdk, String id) Creates the new ping report. -
Uses of Stability.Internal in com.couchbase.client.core.endpoint
Methods in com.couchbase.client.core.endpoint with annotations of type Stability.InternalModifier and TypeMethodDescriptionvoidBaseEndpoint.decrementOutstandingRequests()Helper method to decrement outstanding requests, even if they haven't finished yet.longBaseEndpoint.lastConnectedAt()voidBaseEndpoint.markRequestCompletion()Called from the event loop handlers to mark a request as being completed.voidBaseEndpoint.notifyChannelInactive()This method is called from inside the channel to tell the endpoint hat it got inactive. -
Uses of Stability.Internal in com.couchbase.client.core.endpoint.http
Classes in com.couchbase.client.core.endpoint.http with annotations of type Stability.InternalModifier and TypeInterfaceDescriptioninterfaceclassclassThe "path" component of a URI, with support for path parameters whose replacement values are automatically url-encoded.classstatic classBuilder for dynamic HTTP requestsclass -
Uses of Stability.Internal in com.couchbase.client.core.env
Classes in com.couchbase.client.core.env with annotations of type Stability.InternalModifier and TypeClassDescriptionstatic classstatic classstatic classclassA special supplier which allows the SDK to distinguish passed in suppliers vs.interfaceMarker interface for different callbacks in the request lifecycle.static classstatic classstatic classstatic classDeprecated.Fields in com.couchbase.client.core.env with annotations of type Stability.InternalMethods in com.couchbase.client.core.env with annotations of type Stability.InternalModifier and TypeMethodDescriptionCoreEnvironment.Builder.addRequestCallback(RequestCallback requestCallback) Allows to configure callbacks across the lifetime of a request.default voidAuthenticator.applyTlsProperties(com.couchbase.client.core.deps.io.netty.handler.ssl.SslContextBuilder sslContextBuilder) The authenticator gets the chance to attach the client certificate to the ssl context if needed.default voidAuthenticator.authHttpRequest(ServiceType serviceType, com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request) Allows to add authentication credentials to the http request for the given service.default voidAuthenticator.authKeyValueConnection(EndpointContext endpointContext, com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline) Allows the authenticator to add KV handlers during connection bootstrap to perform authentication.IoEnvironment.Builder.build()LoggerConfig.Builder.customLogger(LoggingEventConsumer.Logger customLogger) Allows to specify a custom logger.LoggerConfig.customLogger()Returns a custom logger if configured for testing.static LoggerConfig.BuilderLoggerConfig.customLogger(LoggingEventConsumer.Logger customLogger) Allows to specify a custom logger.ThresholdRequestTracerConfig.Builder.fromNewBuilder(ThresholdLoggingTracerConfig.Builder newBuilder) Deprecated.CoreEnvironment.requestCallbacks()default booleanAuthenticator.supportsNonTls()If this authenticator supports non-encrypted connections.default booleanAuthenticator.supportsTls()If this authenticator supports encrypted connections.ThresholdRequestTracerConfig.Builder.toNewBuillder()Deprecated.Converts this deprecated builder into its non-deprecated version.Constructors in com.couchbase.client.core.env with annotations of type Stability.Internal -
Uses of Stability.Internal in com.couchbase.client.core.error
Classes in com.couchbase.client.core.error with annotations of type Stability.InternalModifier and TypeClassDescriptionclassException raised if during config load the bucket is not found (think: http 404).classException raised if during config load the bucket is found, but not deemed ready yet.classclassclassclassMethods in com.couchbase.client.core.error with annotations of type Stability.InternalModifier and TypeMethodDescriptionbyte[]AnalyticsException.content()static List<ErrorCodeAndMessage>ErrorCodeAndMessage.from(byte[] content) static List<ErrorCodeAndMessage>ErrorCodeAndMessage.fromJsonArray(byte[] jsonArray) booleanPreparedStatementFailureException.retryable() -
Uses of Stability.Internal in com.couchbase.client.core.error.subdoc
Classes in com.couchbase.client.core.error.subdoc with annotations of type Stability.InternalModifier and TypeClassDescriptionclassSub-Document exception thrown when ReviveDocument has been used with a document that already exists -
Uses of Stability.Internal in com.couchbase.client.core.error.transaction
Classes in com.couchbase.client.core.error.transaction with annotations of type Stability.InternalModifier and TypeClassDescriptionclassIndicates that this transaction should be retried.classThis operation (such as a replace, get or insert) either failed or ambiguously succeeded.static enumMethods in com.couchbase.client.core.error.transaction with annotations of type Stability.InternalModifier and TypeMethodDescriptionbooleanTransactionOperationFailedException.autoRollbackAttempt()booleanTransactionOperationFailedException.retryTransaction()TransactionOperationFailedException.toRaise() -
Uses of Stability.Internal in com.couchbase.client.core.error.transaction.internal
Classes in com.couchbase.client.core.error.transaction.internal with annotations of type Stability.InternalModifier and TypeClassDescriptionclassThe transaction expired at the point of trying to commit it.classThe transaction could not be fully completed in the configured timeout.classThe transaction failed to reach the Committed point.classclassIndicates that committing the ATR entry should be retried.classIndicates that this operation should be retried.classUsed only in testing: injects an error that will be handled as FAIL_AMBIGUOUS.classUsed only in testing: injects an error that will be handled as FAIL_HARD.classUsed only in testing: injects an error that will be handled as FAIL_OTHER.classUsed only in testing: injects a FAIL_TRANSIENT error.classinterfaceTransactionOperationFailedException is raised as an opaque signal that something went wrong with a transaction operation. -
Uses of Stability.Internal in com.couchbase.client.core.io.netty
Classes in com.couchbase.client.core.io.netty with annotations of type Stability.InternalModifier and TypeClassDescriptionclassThis factory createsSslHandlerbased on a given configuration.classContains various utils to set attributes for tracing spans.Methods in com.couchbase.client.core.io.netty with annotations of type Stability.InternalModifier and TypeMethodDescriptionSslHandlerFactory.defaultCiphers(boolean nativeTlsEnabled) Lists the default ciphers used for this platform.static booleanSslHandlerFactory.opensslAvailable()True if the native ssl transport is available, false otherwise. -
Uses of Stability.Internal in com.couchbase.client.core.io.netty.kv
Classes in com.couchbase.client.core.io.netty.kv with annotations of type Stability.InternalModifier and TypeClassDescriptionclassThis handler tries to load the KV Error Map in a best effort manner.classTheFeatureNegotiatingHandleris responsible for sending the KV "hello" command and to handshake enabled features on both sides.classTheSaslListMechanismsHandlerasks the server KV engine which SASL mechanism it supports.classTheSelectBucketHandleris responsible for, selecting the right bucket on this KV connection.enumTheServerFeatureenum describes all the different negotiation modes between the server and the SDK.Methods in com.couchbase.client.core.io.netty.kv with annotations of type Stability.InternalModifier and TypeMethodDescriptionSaslAuthenticationHandler.allowedMechanisms()Returns the allowed mechanisms for this handler, useful for testing assertions. -
Uses of Stability.Internal in com.couchbase.client.core.json
Classes in com.couchbase.client.core.json with annotations of type Stability.InternalModifier and TypeClassDescriptionclassProvides utilities for encoding and decoding JSON data. -
Uses of Stability.Internal in com.couchbase.client.core.manager
Classes in com.couchbase.client.core.manager with annotations of type Stability.InternalModifier and TypeClassDescriptionclassclassclassclassEncapsulates common functionality around the eventing management APIs.classclass -
Uses of Stability.Internal in com.couchbase.client.core.msg
Classes in com.couchbase.client.core.msg with annotations of type Stability.InternalMethods in com.couchbase.client.core.msg with annotations of type Stability.InternalModifier and TypeMethodDescriptionRequestContext.clientContext(Map<String, Object> clientContext) Allows to set a custom payload for this request.RequestContext.dispatchLatency(long dispatchLatency) Allows to set the dispatch duration of the request.RequestContext.encodeLatency(long encodeLatency) RequestContext.incrementRetryAttempts(Duration lastRetryDuration, RetryReason reason) RequestContext.lastChannelId(String lastChannelId) RequestContext.lastDispatchedFrom(HostAndPort lastDispatchedFrom) RequestContext.lastDispatchedTo(HostAndPort lastDispatchedTo) RequestContext.lastDispatchedToNode()RequestContext.lastDispatchedToNode(NodeIdentifier lastDispatchedToNode) RequestContext.logicallyComplete()Signals that this request is completed fully, including streaming sections or logical sub-requests also being completed (i.e.RequestContext.serverLatency(long serverLatency) Constructors in com.couchbase.client.core.msg with annotations of type Stability.InternalModifierConstructorDescriptionRequestContext(CoreContext ctx, Request<? extends Response> request) Creates a newRequestContext. -
Uses of Stability.Internal in com.couchbase.client.core.msg.kv
Classes in com.couchbase.client.core.msg.kv with annotations of type Stability.InternalModifier and TypeClassDescriptionclassHelper class that language-specific clients may use to implementMutationState.classMethods in com.couchbase.client.core.msg.kv with annotations of type Stability.InternalModifier and TypeMethodDescriptionbyteDurabilityLevel.code()static DurabilityLevelDurabilityLevel.decodeFromManagementApi(String input) Decodes the string representation of the durability level from the management API into an enum.DurabilityLevel.encodeForManagementApi()Encodes theDurabilityLevelso that the management API understands it. -
Uses of Stability.Internal in com.couchbase.client.core.msg.manager
Methods in com.couchbase.client.core.msg.manager with annotations of type Stability.InternalModifier and TypeMethodDescriptionvoidBucketConfigStreamingResponse.completeStream()voidBucketConfigStreamingResponse.failStream(Throwable e) voidBucketConfigStreamingResponse.pushConfig(String config) -
Uses of Stability.Internal in com.couchbase.client.core.msg.query
Classes in com.couchbase.client.core.msg.query with annotations of type Stability.InternalModifier and TypeClassDescriptionclassclassServer remembers query plan; client sends just the prepared statement name.classClient remembers query plan and sends it on every request.classPrepared statement cache entry.classMethods in com.couchbase.client.core.msg.query with annotations of type Stability.InternalModifier and TypeMethodDescriptionQueryRequest.toExecuteRequest(String preparedStatementName, String encodedPlan, RequestTracer requestTracer) Returns a copy of this request tailored to execute a prepared statement.QueryRequest.toPrepareRequest(boolean autoExecute, RequestTracer requestTracer) Returns a new request that creates a prepared statement using this request as a template. -
Uses of Stability.Internal in com.couchbase.client.core.node
Classes in com.couchbase.client.core.node with annotations of type Stability.InternalModifier and TypeInterfaceDescriptioninterfaceThis interface defines different hashing strategies used for ketama hashing in memcached buckets. -
Uses of Stability.Internal in com.couchbase.client.core.retry
Classes in com.couchbase.client.core.retry with annotations of type Stability.InternalModifier and TypeClassDescriptionclassAn internal strategy to fail fast any request that goes through it.classTheRetryOrchestratoris responsible for checking if a request is eligible for retry and if so dispatch it properly and update state.Methods in com.couchbase.client.core.retry with annotations of type Stability.InternalModifier and TypeMethodDescriptionstatic DurationRetryOrchestrator.capDuration(Duration uncappedDuration, Request<? extends Response> request) Calculates the potentially capped retry duration so we do not schedule a longer retry than the actual total timeout. -
Uses of Stability.Internal in com.couchbase.client.core.service.kv
Classes in com.couchbase.client.core.service.kv with annotations of type Stability.Internal -
Uses of Stability.Internal in com.couchbase.client.core.transaction
Classes in com.couchbase.client.core.transaction with annotations of type Stability.InternalModifier and TypeClassDescriptionclassclassProvides methods to allow an application's transaction logic to read, mutate, insert and delete documents, as well as commit or rollback the transaction.static classclassStores some context related to a transaction.classRepresents a value fetched from Couchbase, along with additional transactional metadata.classA keyspace represents a triple of bucket, scope and collection.classclassMethods in com.couchbase.client.core.transaction with annotations of type Stability.InternalModifier and TypeMethodDescriptionstatic CoreTransactionGetResultCoreTransactionGetResult.createFrom(CollectionIdentifier collection, String documentId, SubdocGetResponse doc) static CoreTransactionGetResultCoreTransactionGetResult.createFrom(CoreTransactionGetResult doc, byte[] content) Constructors in com.couchbase.client.core.transaction with annotations of type Stability.InternalModifierConstructorDescriptionCoreTransactionGetResult(String id, byte[] content, long cas, CollectionIdentifier collection, TransactionLinks links, Optional<DocumentMetadata> documentMetadata, Optional<com.couchbase.client.core.deps.com.fasterxml.jackson.databind.JsonNode> txnMeta, Optional<String> crc32OfGet) -
Uses of Stability.Internal in com.couchbase.client.core.transaction.atr
Classes in com.couchbase.client.core.transaction.atr with annotations of type Stability.Internal -
Uses of Stability.Internal in com.couchbase.client.core.transaction.cleanup
Classes in com.couchbase.client.core.transaction.cleanup with annotations of type Stability.InternalModifier and TypeClassDescriptionclassSimple data class, so all fields are public.classUsed for testing/mocking.classclassUsed for testing/mocking.classclassRepresents the ClientRecord doc, a single document that contains an entry for every client (app) current participating in the cleanup of 'lost' transactions.classUtility class to store the result of a client checking/updating the Client Record doc.classUsed for testing/mocking.classUsed for testing/mocking.classOwns cleanup threads.classRuns the algorithm to find 'lost' transactions, distributing the work between clients.classHandles cleaning up expired/lost transactions. -
Uses of Stability.Internal in com.couchbase.client.core.transaction.components
Classes in com.couchbase.client.core.transaction.components with annotations of type Stability.InternalModifier and TypeClassDescriptionclassstatic classclassclassclassenumMetadata related to the CAS.classclassResponsible for doing transaction-aware get()s.classStores some $document metadata from when the document is fetchedclassclassclassStores the transaction links stored on each document in a transactionMethods in com.couchbase.client.core.transaction.components with annotations of type Stability.Internal -
Uses of Stability.Internal in com.couchbase.client.core.transaction.config
Classes in com.couchbase.client.core.transaction.config with annotations of type Stability.InternalModifier and TypeClassDescriptionclassMergesCoreTransactionOptionsandCoreTransactionsConfig.classclassTunables for an individual transaction.classclassMethods in com.couchbase.client.core.transaction.config with annotations of type Stability.InternalModifier and TypeMethodDescriptionCoreTransactionsCleanupConfig.createDefault()static CoreTransactionsConfigCoreTransactionsConfig.createDefault() -
Uses of Stability.Internal in com.couchbase.client.core.transaction.error.internal
Classes in com.couchbase.client.core.transaction.error.internal with annotations of type Stability.Internal -
Uses of Stability.Internal in com.couchbase.client.core.transaction.forwards
Classes in com.couchbase.client.core.transaction.forwards with annotations of type Stability.InternalModifier and TypeClassDescriptionenumAll protocol extensions known about by this implementation.classA mechanism to help ensure that older clients can be prevented from interacting with transactions created by future clients that they do not know how to process.enumPoints in the protocol where forward compatibility can be checked.classDefines what is support by this implementation (extensions and protocol version). -
Uses of Stability.Internal in com.couchbase.client.core.transaction.log
Classes in com.couchbase.client.core.transaction.log with annotations of type Stability.InternalModifier and TypeClassDescriptionclassA logger optimized for logging transactions-specific info.classSimple wrapper around logging to the Couchbase event bus. -
Uses of Stability.Internal in com.couchbase.client.core.transaction.support
Classes in com.couchbase.client.core.transaction.support with annotations of type Stability.InternalModifier and TypeClassDescriptionenumThe possible states for a transaction attempt.classclassWraps a RequestSpan, with the value-add that it automatically records how long the operation took for transaction logging.classclassenumclassclass -
Uses of Stability.Internal in com.couchbase.client.core.transaction.threadlocal
Classes in com.couchbase.client.core.transaction.threadlocal with annotations of type Stability.InternalModifier and TypeClassDescriptionclassUsed to indicate that we are inside a transaction, and placed in ThreadLocalStorage (or reactive context).classUsed to manage ThreadLocalStorage (or reactive context) of TransactionMarker. -
Uses of Stability.Internal in com.couchbase.client.core.transaction.util
Classes in com.couchbase.client.core.transaction.util with annotations of type Stability.InternalModifier and TypeClassDescriptionclassCan be used for testing transactions, but is for internal use only.classMainly to aid debugging, transactions use their own pool of schedulers.classclassclassclassclassMonoBridge<T>Protects against concurrent op cancellation.classclassA mutex pessimistic lock, compatible with reactive.classProvides locking functionality in line with Go's WaitGroups, in a reactive compatible way.classCan be used for testing transactions, but is for internal use only.classTransactions does a lot of KV work from core-io.interfaceTriFunction<T,U, V, R> -
Uses of Stability.Internal in com.couchbase.client.core.util
Classes in com.couchbase.client.core.util with annotations of type Stability.InternalModifier and TypeClassDescriptionclassDefines helpful routines for working with bucket configs.classclassclassclassclassclassstatic enumclassContains various helper methods when dealing with the connection string.final classIntegrates the Couchbase infrastructure withBlockHound.classclassEnumLookupTable<E extends Enum<E>>Provides efficient lookup for enums whose values are associated with small integers.classclassA convenient wrapper class around network primitives in Java.classMethods in com.couchbase.client.core.util with annotations of type Stability.InternalModifier and TypeMethodDescriptionstatic NetworkAddressCreates a newNetworkAddressfrom either a hostname or ip address literal.NetworkAddress.hostname()Returns the hostname for this network address.