All Classes

Class	Description
AbstractCompoundQuery	Base class for FTS queries that are composite, compounding several other SearchQuery.
AbstractSearchFacetResult
AllowQueryingSearchIndexOptions
AnalyticsAccessor	Internal helper to map the results from the analytics requests.
AnalyticsDataset
AnalyticsDataType	The indexable data types.
AnalyticsDataverse
AnalyticsIndex
AnalyticsIndexManager
AnalyticsMetaData	Holds associated metadata returned by the server for the performed analytics request.
AnalyticsMetrics	Holds the metrics as returned from an analytics response.
AnalyticsOptions	Allows customizing various analytics query options.
AnalyticsResult	The result of an analytics query, including rows and associated metadata.
AnalyticsScanConsistency	The possible values for scan consistency in an analytics request.
AnalyticsStatus
AnalyticsWarning	Represents a single warning returned from the analytics engine.
AnalyzeDocumentOptions
AppendAccessor
AppendOptions	Modifies properties of the append operation.
ArrayAddUnique	An intention to perform a SubDocument array add-unique operation.
ArrayAppend	An intention to perform a SubDocument array append operation.
ArrayInsert	An intention to perform a SubDocument array insert operation.
ArrayListOptions
ArrayPrepend	An intention to perform a SubDocument array prepend operation.
ArraySetOptions
AsyncAnalyticsIndexManager
AsyncBinaryCollection	Allows to perform certain operations on non-JSON documents.
AsyncBucket	Provides access to a Couchbase bucket in an async fashion.
AsyncBucketManager
AsyncCluster	The AsyncCluster is the main entry point when connecting to a Couchbase cluster using the async API.
AsyncCollection	The AsyncCollection provides basic asynchronous access to all collection APIs.
AsyncCollectionManager	The AsyncCollectionManager provides APIs to manage bucket collections and scopes.
AsyncQueryIndexManager
AsyncScope	The scope identifies a group of collections and allows high application density as a result.
AsyncSearchIndexManager	The AsyncSearchIndexManager allows to manage search index structures in a couchbase cluster.
AsyncUserManager
AsyncUtils
AsyncViewIndexManager
AuthDomain	The possible authentication domains that can be used when managing users with RBAC.
BatchHelper	This helper class provides methods that make performing batch operations easy and comfortable.
BinaryCollection	Allows to perform certain operations on non-JSON documents.
BooleanFieldQuery	A FTS query that queries fields explicitly indexed as boolean.
BooleanQuery	A compound FTS query that allows various combinations of sub-queries.
Bucket	Provides access to a Couchbase bucket in a blocking fashion.
BucketManager
BucketSettings
BucketType
BuildQueryIndexOptions
Cluster	The Cluster is the main entry point when connecting to a Couchbase cluster.
ClusterEnvironment	The Environment is the main place in the SDK where configuration and state lives (i.e.
ClusterEnvironment.Builder
ClusterOptions	Allows to specify custom options when connecting to the cluster.
ClusterPropertyLoader	Marker interface for additional properties that can be loaded via the cluster environment builder.
Collection	The Collection provides blocking, synchronous access to all collection APIs.
CollectionManager	The CollectionManager provides APIs to manage bucket collections and scopes.
CollectionSpec	The CollectionSpec describes properties of a collection that can be managed.
CommonDatastructureOptions<SELF extends CommonDatastructureOptions<SELF>>
CommonDurabilityOptions<SELF extends CommonDurabilityOptions<SELF>>	Extends the CommonOptions to also include the durability requirements.
CommonOptions<SELF extends CommonOptions<SELF>>	Common options that are used by most operations.
CompressionMode
ConflictResolutionType
ConjunctionQuery	A compound FTS query that performs a logical AND between all its sub-queries (conjunction).
ConnectLinkAnalyticsOptions
Coordinate	A coordinate is a tuple of a latitude and a longitude.
CouchbaseArrayList<E>	A CouchbaseArrayList is a List backed by a Couchbase document (more specifically a JSON array).
CouchbaseArraySet<T>	A CouchbaseArraySet is a Set backed by a Couchbase document (more specifically a JSON array).
CouchbaseMap<E>	A CouchbaseMap is a Map backed by a Couchbase document (more specifically a JSON object).
CouchbaseQueue<E>	A CouchbaseQueue is a Queue backed by a Couchbase document (more specifically a JSON array).
CounterAccessor
CounterResult	Result returned from counter (increment, decrement) operations.
CreateBucketOptions
CreateCollectionOptions
CreateDatasetAnalyticsOptions
CreateDataverseAnalyticsOptions
CreateIndexAnalyticsOptions
CreatePrimaryQueryIndexOptions
CreateQueryIndexOptions
CreateScopeOptions
DateRange
DateRangeFacet	A facet that categorizes rows inside date ranges (or buckets) provided by the user.
DateRangeQuery	A FTS query that matches documents on a range of dates.
DateRangeSearchFacetResult	Implementation of a DateRangeSearchFacetResult.
DecrementOptions	Modifies properties of the decrement operation.
DefaultJsonSerializer	The default JSON serializer.
DesignDocument	A collection of named Views.
DesignDocumentNamespace
DiagnosticsOptions	Allows to customize the diagnostics report.
DisallowQueryingSearchIndexOptions
DisconnectLinkAnalyticsOptions
DisjunctionQuery	A compound FTS query that performs a logical OR between all its sub-queries (disjunction).
DocIdQuery	A FTS query that matches on Couchbase document IDs.
DropBucketOptions
DropCollectionOptions
DropDatasetAnalyticsOptions
DropDataverseAnalyticsOptions
DropDesignDocumentOptions
DropGroupOptions
DropIndexAnalyticsOptions
DropPrimaryQueryIndexOptions
DropQueryIndexOptions
DropScopeOptions
DropSearchIndexOptions
DropUserOptions
DurabilityUtils
EjectionPolicy	Deprecated. Please use EvictionPolicyType instead.
EncodedFragment	The EncodedFragment represents a fragment returned from a subdocument lookup.
Encrypted	Indicates the annotated field should be encrypted during serialization and decrypted during deserialization.
EncryptedFieldDeserializationModifier
EncryptedFieldDeserializationModifier
EncryptedFieldDeserializer
EncryptedFieldDeserializer
EncryptedFieldSerializationModifier
EncryptedFieldSerializationModifier
EncryptedFieldSerializer
EncryptedFieldSerializer
EncryptionModule	Can be registered with a Jackson ObjectMapper to activate the Encrypted annotation.
EvictionPolicyType
ExistsAccessor
ExistsOptions
ExistsResult	Result returned from an exists KeyValue operation.
Expiry
FlushBucketOptions
FreezePlanSearchIndexOptions
GeoBoundingBoxQuery	A FTS query which allows to match geo bounding boxes.
GeoDistanceQuery	A FTS query which allows to match on geo distances.
GeoPolygonQuery	A search query which allows to match inside a geo polygon.
GetAccessor
GetAllBucketOptions
GetAllDatasetsAnalyticsOptions
GetAllDataversesAnalyticsOptions
GetAllDesignDocumentsOptions
GetAllGroupsOptions
GetAllIndexesAnalyticsOptions
GetAllQueryIndexesOptions
GetAllReplicasOptions
GetAllScopesOptions
GetAllSearchIndexesOptions
GetAllUsersOptions
GetAndLockOptions
GetAndTouchOptions
GetAnyReplicaOptions
GetBucketOptions
GetDesignDocumentOptions
GetGroupOptions
GetIndexedSearchIndexOptions
GetOptions	Allows to customize a get request.
GetPendingMutationsAnalyticsOptions
GetReplicaResult	Extends GetResult to include additional information for get-from-replica style calls.
GetResult	Returned from all kinds of KeyValue Get operation to fetch a document or a subset of it.
GetRolesOptions
GetScopeOptions
GetSearchIndexOptions
GetUserOptions
Group
HighlightStyle	Enumeration of the highlighting styles recognized by the FTS engine.
Increment	An intention to perform a SubDocument increment operation.
IncrementOptions	Modifies properties of the increment operation.
Insert	An intention to perform a SubDocument insert operation.
InsertAccessor
InsertOptions
JacksonJsonSerializer	A serializer backed by a user-provided Jackson ObjectMapper.
JacksonJsonSerializer.PreflightCheckSubject
JacksonTransformers
JsonArray	Represents a JSON array that can be stored and loaded from Couchbase Server.
JsonNull	Represents the JSON form of "NULL".
JsonObject	Represents a JSON object that can be stored and loaded from Couchbase Server.
JsonObjectCrypto	A view of a Couchbase JsonObject for reading and writing encrypted fields.
JsonSerializer	The JsonSerializer handles the serialization and deserialization of raw json data into java objects.
JsonTranscoder
JsonValue	Represents a JSON value (either a JsonObject or a JsonArray.
JsonValueModule	Can be registered with a Jackson ObjectMapper to add support for Couchbase JsonObject and JsonArray.
JsonValueSerializerWrapper	Wraps another serializer, intercepting and handling requests to [de]serialize JsonObject and JsonArray.
LegacyTranscoder
LookupInAccessor
LookupInMacro	Convenience macros to retrieve document metadata using a lookupIn Sub-Document call.
LookupInOptions
LookupInResult	This result is returned from successful KeyValue subdocument lookup responses.
LookupInSpec	Defines specs to lookup parts in a JSON document.
LookupInSpecStandard
ManagerSupport
MapOptions
MatchAllQuery	A FTS query that matches all indexed documents (usually for debugging purposes).
MatchNoneQuery	A FTS query that matches 0 document (usually for debugging purposes).
MatchPhraseQuery	A FTS query that matches several given terms (a "phrase"), applying further processing like analyzers to them.
MatchQuery	A FTS query that matches a given term, applying further processing to it like analyzers, stemming and even fuzziness.
MutateInAccessor
MutateInMacro
MutateInOptions
MutateInResult	This result is returned from successful KeyValue subdocument mutation responses.
MutateInSpec	Defines specs to mutate parts in a JSON document.
MutateInUtil	Internal utility methods for the MutateIn subdoc operation.
MutationResult	Result returned from all kinds of Key-Value mutation operations.
MutationState	Aggregation of one or more MutationTokens for specifying consistency requirements of N1QL or FTS queries.
NumericRange
NumericRangeFacet	A facet that categorizes rows into numerical ranges (or buckets) provided by the user.
NumericRangeQuery	A FTS query that matches documents on a range of values.
NumericRangeSearchFacetResult	Implementation of a NumericRangeSearchFacetResult.
PauseIngestSearchIndexOptions
PersistTo
PhraseQuery	A FTS query that matches several terms (a "phrase") as is.
PingOptions	Allows to customize a cluster or bucket level ping operation.
PrefixQuery	A FTS query that allows for simple matching on a given prefix.
PrependAccessor
PrependOptions	Modifies properties of the prepend operation.
PublishDesignDocumentOptions
QueryAccessor	Converts requests and responses for N1QL queries.
QueryIndex	Describes a N1QL index.
QueryIndexManager
QueryMetaData	Stores any non-rows results related to the execution of a particular N1QL query.
QueryMetrics	Query Metrics contains the query result metrics containing counts and timings
QueryOptions	Allows customizing various N1QL query options.
QueryProfile	Query profiling information received from the server query engine.
QueryResult	The result of a N1QL query, including rows and associated metadata.
QueryScanConsistency	The possible values for scan consistency in a N1QL request.
QueryStatus
QueryStringQuery	A FTS query that performs a search according to the "query string" syntax.
QueryWarning	Represents a single warning returned from the query engine.
QueueOptions
RawBinaryTranscoder
RawJsonTranscoder
RawManager	This class provides direct access to the various management APIs in a raw (uncommitted) form.
RawManagerOptions
RawManagerRequest
RawManagerResponse
RawStringTranscoder
ReactiveAnalyticsIndexManager
ReactiveAnalyticsResult
ReactiveBatchHelper	This helper class provides methods that make performing batch operations easy and comfortable.
ReactiveBinaryCollection	Allows to perform certain operations on non-JSON documents.
ReactiveBucket	Provides access to a Couchbase bucket in a reactive fashion.
ReactiveBucketManager
ReactiveCluster	The Cluster is the main entry point when connecting to a Couchbase cluster using the reactive APIs.
ReactiveCollection	The ReactiveCollection provides sophisticated asynchronous access to all collection APIs.
ReactiveCollectionManager	The ReactiveCollectionManager provides APIs to manage bucket collections and scopes.
ReactiveQueryIndexManager
ReactiveQueryResult	Reactive result that fetch parts of the N1ql Query responses reactively
ReactiveScope	The scope identifies a group of collections and allows high application density as a result.
ReactiveSearchIndexManager	The ReactiveSearchIndexManager allows to manage search index structures in a couchbase cluster.
ReactiveSearchResult
ReactiveUserManager
ReactiveViewIndexManager
ReactiveViewResult	Holds a the result of a View request operation if successful.
RegexpQuery	A FTS query that allows for simple matching of regular expressions.
Remove	An intention to perform a SubDocument remove operation.
RemoveAccessor
RemoveOptions
RepackagedEncryptionModule	Can be registered with a repackaged Jackson ObjectMapper to activate the Encrypted annotation.
RepackagedJsonValueModule
Replace	An intention to perform a SubDocument replace operation.
ReplaceAccessor
ReplaceOptions
ReplicateTo
ResumeIngestSearchIndexOptions
Role
RoleAndDescription
RoleAndOrigins	Associates a Role with information about why a user has the role.
RoleAndOrigins.Origin	Indicates why a user has the role.
Scope	The scope identifies a group of collections and allows high application density as a result.
ScopeSpec
SearchAccessor	Internal helper to access and convert view requests and responses.
SearchDateRange	A range (or bucket) for a DateRangeSearchFacetResult.
SearchFacet	Base class for all FTS facets in querying.
SearchFacetResult	Base interface for all facet results.
SearchFieldMissing
SearchFieldMode
SearchFieldType
SearchGeoDistanceUnits
SearchIndex	A full text search index definition.
SearchIndexManager	The SearchIndexManager allows to manage search index structures in a couchbase cluster.
SearchMetaData
SearchMetrics
SearchNumericRange	A range (or bucket) for a NumericRangeSearchFacetResult.
SearchOptions
SearchQuery	A base class for all FTS query classes.
SearchResult	The result of an search query, including hits and associated metadata.
SearchRow	An FTS result row (or hit).
SearchRowLocation	A FTS result row location indicates at which position a given term occurs inside a given field.
SearchRowLocations	A default implementation of a SearchRowLocations.
SearchScanConsistency	An enum listing the various consistency levels for FTS searches that don't need additional parameters (like a mutation token vector).
SearchSort	Base class for all FTS sort options in querying.
SearchSortField	Sort by a field in the rows.
SearchSortGeoDistance	Sort by a location and unit in the rows.
SearchSortId	Sort by the document ID.
SearchSortScore	Sort by the hit score.
SearchStatus
SearchTermRange	A range (or bucket) for a TermSearchFacetResult.
SerializableTranscoder	This transcoder allows to serialize and deserialize objects if they implement the Serializable interface.
StoreSemantics	Describes how the outer document store semantics on subdoc should act.
TermFacet	A facet that gives the number of occurrences of the most recurring terms in all rows.
TermQuery	A FTS query that matches terms (without further analysis).
TermRangeQuery	A FTS query that matches documents on a range of values.
TermSearchFacetResult	Implementation of a TermSearchFacetResult.
TouchAccessor
TouchOptions
Transcoder	The transcoder is responsible for transcoding KV binary packages between their binary and their java object representation.
Transcoder.EncodedValue	Represents the tuple of encoded value and flags to be used on the wire.
TypeRef<T>	Conveys generic type information at run time.
UnfreezePlanSearchIndexOptions
UnlockAccessor
UnlockOptions
UpdateBucketOptions
Upsert	An intention to perform a SubDocument upsert operation.
UpsertAccessor
UpsertDesignDocumentOptions
UpsertGroupOptions
UpsertOptions
UpsertSearchIndexOptions
UpsertUserOptions
User
UserAndMetadata	Information sent by the server in response to a "get user(s)" request.
UserManager
View	A view index specification consisting of a 'map' function and optionally a 'reduce' function.
ViewAccessor	Internal helper to access and convert view requests and responses.
ViewErrorMode	Set the behavior on error for a view query.
ViewIndexManager
ViewMetaData	Holds Metadata associated with a ViewResult.
ViewOptions
ViewOrdering	Sets the ordering of the view result rows.
ViewResult	Holds a the result of a View request operation if successful.
ViewRow
ViewScanConsistency	Sets the staleness requirement for the view query.
WaitUntilReadyOptions	Allows to customize the diagnostics report.
WatchQueryIndexesOptions
WildcardQuery	An FTS query that allows for simple matching using wildcard characters (* and ?).