@ExportPackage @PublicApi
Interface | Description |
---|---|
AsyncSession |
A session for asynchronous access to a document repository.
|
ResponseHandler | |
Session |
Superclass of all document api sessions.
|
SubscriptionSession |
This class provides document subscription - accessing document changes to a
document repository.
|
SyncSession |
A session for synchronous access to a document repository.
|
VisitorControlSession |
Superclass for document visiting functionality - accessing
documents in an order decided by the document repository.
|
VisitorDestinationSession |
A visitor destination session for receiving data from a visitor.
|
VisitorIterator.BucketSource |
Provides an abstract interface to
VisitorIterator for
how pending buckets are acquired, decoupling this from the iteration
itself. |
VisitorSession |
A session for tracking progress for and potentially receiving data from a
visitor.
|
Class | Description |
---|---|
AckToken |
Token to use to acknowledge data for visiting.
|
AsyncParameters |
Parameters for creating an async session
|
BucketListVisitorResponse | |
DocumentAccess |
This is the starting point of the document api.
|
DocumentAccessParams |
Superclass of the classes which contains the parameters for creating or opening a document access.
|
DocumentIdResponse |
The asynchronous response to a document remove operation.
|
DocumentListVisitorResponse |
Visitor response containing a document list.
|
DocumentResponse |
The asynchronous response to a document put or get operation.
|
DocumentUpdateResponse |
The asynchronous response to a document update operation.
|
DocumentVisitor |
Visitor that simply returns documents found in storage.
|
DumpVisitorDataHandler |
Implementation of VisitorDataHandler which invokes onDocument() for each
received document and onRemove() for each document id that was returned as
part of a remove entry.
|
EmptyBucketsVisitorResponse |
Response containing list of empty buckets.
|
Parameters |
Superclass of the classes which contains the parameters for creating or opening a session.
|
ProgressToken |
Token to use to keep track of progress for visiting.
|
ProgressToken.BucketEntry |
When a bucket has its state kept by the progress token, we need to
discern between active buckets (i.e.
|
ProgressToken.BucketKeyWrapper |
For consistent bucket key ordering, we need to ensure that reverse bucket
IDs that have their MSB set actually are compared as being greater than
those that don't.
|
RemoveResponse |
This response is provided for successful document remove operations.
|
Response |
An asynchronous response from the document api.
|
Result |
The synchronous result of submitting an asynchronous operation.
|
SimpleVisitorDocumentQueue |
A simple document queue that queues up all results and automatically acks
them.
|
SubscriptionParameters |
Parameters for creating or opening a visitor session
|
SyncParameters |
Parameters for creating a synchronous session
|
SyncParameters.Builder | |
ThroughputLimitQueue<M> |
Queue that limits it's size based on the throughput.
|
UpdateResponse |
This response is provided for successful document update operations.
|
VisitorControlHandler |
A class for controlling a visitor supplied through visitor parameters when
creating the visitor session.
|
VisitorDataHandler |
A data handler is a class that handles responses from a visitor.
|
VisitorDataQueue |
A visitor data handler that queues up documents in visitor responses and
implements the
getNext methods, thus implementing the polling
API defined in VisitorDataHandler. |
VisitorDestinationParameters |
Parameters for creating or opening a visitor destination session.
|
VisitorIterator |
Enables transparent iteration of super/sub-buckets
|
VisitorIterator.BucketProgress | |
VisitorIterator.DistributionRangeBucketSource |
Provides a bucket source that encompasses the entire range available
through a given value of distribution bits
|
VisitorIterator.ExplicitBucketSource |
Provides an explicit set of bucket IDs to iterate over.
|
VisitorParameters |
Parameters for creating or opening a visitor session
|
VisitorResponse |
Common class for all visitor responses.
|
Enum | Description |
---|---|
ProgressToken.BucketState |
Any bucket kept track of by a
ProgressToken instance may
be in one of two states: pending or active. |
Result.ResultType |
The types that a Result can have.
|
VisitorControlHandler.CompletionCode |
Possible completion codes for visiting.
|
Exception | Description |
---|---|
DocumentAccessException |
General exception thrown from various methods in the Vespa Document API.
|
Copyright © 2018. All rights reserved.