Uses of Class
com.couchbase.client.core.annotations.InterfaceAudience.Public
-
Packages that use InterfaceAudience.Public Package Description com.couchbase.client.core Couchbase Core IO - Domain Model and Architecture ================================================= This documentation describes the domain model of the core package, covers important architecture and design decisions and provides a solid introduction on the inner workings.com.couchbase.client.core.annotations com.couchbase.client.core.env com.couchbase.client.core.hooks com.couchbase.client.core.message com.couchbase.client.core.message.analytics com.couchbase.client.core.message.internal com.couchbase.client.core.message.kv.subdoc com.couchbase.client.core.message.kv.subdoc.multi com.couchbase.client.core.message.kv.subdoc.simple com.couchbase.client.core.message.query com.couchbase.client.core.tracing com.couchbase.client.core.utils -
-
Uses of InterfaceAudience.Public in com.couchbase.client.core
Methods in com.couchbase.client.core with annotations of type InterfaceAudience.Public Modifier and Type Method Description ResponseStatusDetails
CouchbaseException. details()
RingBufferDiagnostics
BackpressureException. diagnostics()
Returns aRingBufferDiagnostics
which, if non-null, gives a granular breakdown of the contents of the ringbuffer at the time of this exception<R extends CouchbaseResponse>
rx.Observable<R>ClusterFacade. send(CouchbaseRequest request)
Sends aCouchbaseRequest
into the cluster and eventually returns aCouchbaseResponse
. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.annotations
Classes in com.couchbase.client.core.annotations with annotations of type InterfaceAudience.Public Modifier and Type Class Description class
InterfaceAudience
Defines the intended audience for each entity.class
InterfaceStability
Defines the stability annotations for each public or private class. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.env
Classes in com.couchbase.client.core.env with annotations of type InterfaceAudience.Public Modifier and Type Interface Description interface
WaitStrategyFactory
Factory to create a newWaitStrategy
when called.Methods in com.couchbase.client.core.env with annotations of type InterfaceAudience.Public Modifier and Type Method Description boolean
CoreEnvironment. certAuthEnabled()
True if X.509 client certificate authentication is enabled.SELF
DefaultCoreEnvironment.Builder. certAuthEnabled(boolean certAuthEnabled)
Allows to enable X.509 client certificate authentication.SELF
DefaultCoreEnvironment.Builder. compressionEnabled(boolean compressionEnabled)
Allows to enable/disable compression completely, enabled by default.SELF
DefaultCoreEnvironment.Builder. compressionMinRatio(double compressionMinRatio)
Allows to adjust the ratio over which the document is sent compressed over the wire - in percent.SELF
DefaultCoreEnvironment.Builder. compressionMinSize(int compressionMinSize)
Allows to adjust the minimum size of a document to be considered for compression - in bytes.long
CoreEnvironment. configPollFloorInterval()
Returns the minimum polling interval allowed.SELF
DefaultCoreEnvironment.Builder. configPollFloorInterval(long configPollFloorInterval)
Allows to set the minimum config polling interval.long
DefaultCoreEnvironment. configPollFloorInterval()
long
CoreEnvironment. configPollInterval()
Returns the proactive polling interval for cluster configurations.SELF
DefaultCoreEnvironment.Builder. configPollInterval(long configPollInterval)
Allows to set the configuration poll interval which polls the server cluster configuration proactively.long
DefaultCoreEnvironment. configPollInterval()
boolean
CoreEnvironment. continuousKeepAliveEnabled()
If set to true, KeepAlives will be sent on a regular basis in the interval also if there is traffic on the socket, not only if its idle.SELF
DefaultCoreEnvironment.Builder. continuousKeepAliveEnabled(boolean continuousKeepAliveEnabled)
Allows to enable or disable the continous emitting of keepalive messages.CouchbaseCoreSendHook
CoreEnvironment. couchbaseCoreSendHook()
Returns theCouchbaseCoreSendHook
if set, null otherwise.SELF
DefaultCoreEnvironment.Builder. couchbaseCoreSendHook(CouchbaseCoreSendHook hook)
Allows to configure a custom core send hook, see the javadocs for it for more details.SELF
DefaultCoreEnvironment.Builder. forceSaslPlain(boolean forceSaslPlain)
Allows to forcre the KeyValue SASL authentication method to PLAIN which is used to allow authentication against LDAP-based users.long
CoreEnvironment. keepAliveErrorThreshold()
Specifies the number of times a KeepAlive message on a socket can fail before the connection is recycled.SELF
DefaultCoreEnvironment.Builder. keepAliveErrorThreshold(long keepAliveErrorThreshold)
Allows to customize the errors on keepalive messages threshold after which the connection will be recycled.long
CoreEnvironment. keepAliveTimeout()
Specifies the timeout of a keepalive operation on the socket in milliseconds.SELF
DefaultCoreEnvironment.Builder. keepAliveTimeout(long keepAliveTimeout)
Allows to customize the timeout used for keepalive operations.NetworkResolution
CoreEnvironment. networkResolution()
Allows to configure the network resolution, default being automatic.SELF
DefaultCoreEnvironment.Builder. networkResolution(NetworkResolution networkResolution)
Allows to tune the network resolution setting, pinning it to either internal or external instead of relying on the automatic mechanism.SELF
DefaultCoreEnvironment.Builder. orphanResponseReporter(OrphanResponseReporter orphanResponseReporter)
SELF
DefaultCoreEnvironment.Builder. orphanResponseReportingEnabled(boolean orphanResponseReportingEnabled)
WaitStrategyFactory
CoreEnvironment. requestBufferWaitStrategy()
Waiting strategy used by requestEventProcessor
s to wait for data fromRingBuffer
SELF
DefaultCoreEnvironment.Builder. requestBufferWaitStrategy(WaitStrategyFactory waitStrategy)
Sets a custom waiting strategy for requests. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.hooks
Classes in com.couchbase.client.core.hooks with annotations of type InterfaceAudience.Public Modifier and Type Interface Description interface
CouchbaseCoreSendHook
This hook allows to intercept and modify theCouchbaseRequest
in the path of theCouchbaseCore.send(CouchbaseRequest)
method.Methods in com.couchbase.client.core.hooks with annotations of type InterfaceAudience.Public Modifier and Type Method Description Tuple2<CouchbaseRequest,rx.Observable<CouchbaseResponse>>
CouchbaseCoreSendHook. beforeSend(CouchbaseRequest originalRequest, rx.Observable<CouchbaseResponse> originalResponse)
Allows to hook in before the send method on core, make sure to return either the original tuple or the modified ones from the originals. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.message
Methods in com.couchbase.client.core.message with annotations of type InterfaceAudience.Public Modifier and Type Method Description ResponseStatusDetails
CouchbaseResponse. statusDetails()
If set, provides more detailed information into the response status than the always availableResponseStatus
enum.void
CouchbaseResponse. statusDetails(ResponseStatusDetails statusDetails)
Set the status details if not set previously. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.message.analytics
Classes in com.couchbase.client.core.message.analytics with annotations of type InterfaceAudience.Public Modifier and Type Class Description class
GenericAnalyticsRequest
For the lack of a better name, a analytics request against a analytics server.class
GenericAnalyticsResponse
The base response for Analytics (SQL++) requests.class
RawAnalyticsRequest
AAnalyticsRequest
that can also beprelocated
, but expects a response with the uninterpreted JSON payload returned by the query service.class
RawAnalyticsResponse
The response to aRawAnalyticsRequest
, which only contains the raw JSON payload returned by the Analytics service, as aByteBuf
. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.message.internal
Classes in com.couchbase.client.core.message.internal with annotations of type InterfaceAudience.Public Modifier and Type Class Description class
DiagnosticsReport
Aggregates the health of allEndpoint
s.class
EndpointHealth
Aggregates the health of one specificEndpoint
.class
PingReport
Contains a report for all the internal service health states.class
PingServiceHealth
Represents health for a specific service on ping. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.message.kv.subdoc
Classes in com.couchbase.client.core.message.kv.subdoc with annotations of type InterfaceAudience.Public Modifier and Type Interface Description interface
BinarySubdocMultiLookupRequest
ABinarySubdocRequest
that describes multiple lookup operations on a single document.interface
BinarySubdocMultiMutationRequest
ABinarySubdocRequest
that describes multiple mutations on a single document.interface
BinarySubdocMutationRequest
ABinarySubdocRequest
that describes a mutation operation.interface
BinarySubdocRequest
A type ofBinaryRequest
that deals with getting or mutating parts of a JSON document, aka a Sub-Document. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.message.kv.subdoc.multi
-
Uses of InterfaceAudience.Public in com.couchbase.client.core.message.kv.subdoc.simple
Classes in com.couchbase.client.core.message.kv.subdoc.simple with annotations of type InterfaceAudience.Public Modifier and Type Class Description class
AbstractSubdocMutationRequest
Base class for allBinarySubdocMutationRequest
.class
AbstractSubdocRequest
Base class for allBinarySubdocRequest
.class
SimpleSubdocResponse
A general-purpose response suitable for most "simple" sub-document operations (BinarySubdocRequest
andBinarySubdocMutationRequest
), as opposed to "multi-specification" sub-document operations.class
SubArrayRequest
A request covering all sub-document array operations (seeSubArrayRequest.ArrayOperation
).class
SubCounterRequest
A sub-document counter operation.class
SubDeleteRequest
A sub-document delete operation.class
SubDictAddRequest
A sub-document dictionary add operation.class
SubDictUpsertRequest
A sub-document dictionary upsert operation.class
SubExistRequest
A sub-document exist operation.class
SubGetCountRequest
A sub-document get count operation.class
SubGetRequest
A sub-document get operation.class
SubReplaceRequest
A sub-document replace operation. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.message.query
Classes in com.couchbase.client.core.message.query with annotations of type InterfaceAudience.Public Modifier and Type Class Description class
RawQueryRequest
AQueryRequest
that can also beprelocated
, but expects a response with the uninterpreted JSON payload returned by the query service.class
RawQueryResponse
The response to aRawQueryRequest
, which only contains the raw JSON payload returned by the Query service, as aByteBuf
. -
Uses of InterfaceAudience.Public in com.couchbase.client.core.tracing
Classes in com.couchbase.client.core.tracing with annotations of type InterfaceAudience.Public Modifier and Type Class Description class
RingBufferDiagnostics
Provides a granular breakdown of the queries in the ringbufferMethods in com.couchbase.client.core.tracing with annotations of type InterfaceAudience.Public Modifier and Type Method Description int
RingBufferDiagnostics. countNonService()
Returns the count of all requests not associated with a particular serviceMap<ServiceType,Integer>
RingBufferDiagnostics. counts()
Returns a map of the type of each request, along with the current count of each in the ringbufferint
RingBufferDiagnostics. totalCount()
Returns the count of all requests in the ringbufferConstructors in com.couchbase.client.core.tracing with annotations of type InterfaceAudience.Public Constructor Description RingBufferDiagnostics(Map<ServiceType,Integer> counts, int countNonService)
-
Uses of InterfaceAudience.Public in com.couchbase.client.core.utils
Classes in com.couchbase.client.core.utils with annotations of type InterfaceAudience.Public Modifier and Type Class Description class
DefaultObjectMapper
Provides global access to the services of a JacksonObjectMapper
with default configuration.
-