Skip navigation links
A B C D E F G H I K L M N O P Q R S T U V W 

A

addAttachment(String, Attachment) - Method in class com.cloudant.client.api.model.Document
 
addAttachment(String, Attachment) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
addIndexField(String, IndexField.SortOrder) - Method in class com.cloudant.client.api.model.Index
 
addParam(String, String) - Method in class com.cloudant.client.api.model.Params
 
ApiKey - Class in com.cloudant.client.api.model
Encapsulates a ApiKey response from Cloudant
ApiKey() - Constructor for class com.cloudant.client.api.model.ApiKey
 
Attachment - Class in com.cloudant.client.api.model
Represents an in-line document attachment.
Attachment() - Constructor for class com.cloudant.client.api.model.Attachment
 
Attachment(String, String) - Constructor for class com.cloudant.client.api.model.Attachment
 
attachments() - Method in class com.cloudant.client.api.model.Params
 

B

batch(Object) - Method in class com.cloudant.client.api.Database
Saves a document with batch=ok query param.
bookmark(String) - Method in class com.cloudant.client.api.Search
Control which page of results to get.
bulk(List<?>) - Method in class com.cloudant.client.api.Database
Performs a Bulk Documents insert request.

C

cancel(Boolean) - Method in class com.cloudant.client.api.Replication
 
Changes - Class in com.cloudant.client.api
Contains the Change Notifications API, supports normal and continuous feed Changes.
changes() - Method in class com.cloudant.client.api.Database
Provides access to Change Notifications API.
ChangesResult - Class in com.cloudant.client.api.model
Represents Changes feed result of type normal.
ChangesResult() - Constructor for class com.cloudant.client.api.model.ChangesResult
 
ChangesResult(ChangesResult) - Constructor for class com.cloudant.client.api.model.ChangesResult
 
ChangesResult.Row - Class in com.cloudant.client.api.model
Represent a row in Changes result.
ChangesResult.Row.Rev - Class in com.cloudant.client.api.model
Represent a Change rev.
CloudantClient - Class in com.cloudant.client.api
Exposes the Cloudant client API
CloudantClient(String, String, String) - Constructor for class com.cloudant.client.api.CloudantClient
Constructs a new instance of this class and connects to the cloudant server with the specified credentials
CloudantClient(String, String, String, ConnectOptions) - Constructor for class com.cloudant.client.api.CloudantClient
Constructs a new instance of this class and connects to the cloudant account with the specified credentials
CloudantClient(String, String) - Constructor for class com.cloudant.client.api.CloudantClient
Constructs a new instance of this class and connects to the cloudant account with the specified credentials
CloudantClient(String, String, ConnectOptions) - Constructor for class com.cloudant.client.api.CloudantClient
Constructs a new instance of this class and connects to the cloudant account with the specified credentials
com.cloudant.client.api - package com.cloudant.client.api
 
com.cloudant.client.api.model - package com.cloudant.client.api.model
 
conflicts() - Method in class com.cloudant.client.api.model.Params
 
connectionTimeout(long) - Method in class com.cloudant.client.api.Replicator
 
ConnectOptions - Class in com.cloudant.client.api.model
Represents optional configuration properties for connecting to CloudantDB.
ConnectOptions() - Constructor for class com.cloudant.client.api.model.ConnectOptions
 
contains(String) - Method in class com.cloudant.client.api.Database
Checks if a document exist in the database.
continuous(Boolean) - Method in class com.cloudant.client.api.Replication
 
continuous(boolean) - Method in class com.cloudant.client.api.Replicator
 
continuousChanges() - Method in class com.cloudant.client.api.Changes
Requests Change notifications of feed type continuous.
CouchDbException - Exception in org.lightcouch
Base runtime exception class.
CouchDbException(String) - Constructor for exception org.lightcouch.CouchDbException
 
CouchDbException(Throwable) - Constructor for exception org.lightcouch.CouchDbException
 
CouchDbException(String, Throwable) - Constructor for exception org.lightcouch.CouchDbException
 
counts(String[]) - Method in class com.cloudant.client.api.Search
Array of fieldNames for which counts should be produced
createDB(String) - Method in class com.cloudant.client.api.CloudantClient
Request to create a new database; if one doesn't exist.
createIndex(String, String, String, IndexField[]) - Method in class com.cloudant.client.api.Database
Create a new index
createIndex(String) - Method in class com.cloudant.client.api.Database
create a new Index
createTarget(Boolean) - Method in class com.cloudant.client.api.Replication
 
createTarget(Boolean) - Method in class com.cloudant.client.api.Replicator
 

D

database(String, boolean) - Method in class com.cloudant.client.api.CloudantClient
Get a database
Database - Class in com.cloudant.client.api
Contains a Database Public API implementation.
DbDesign - Class in com.cloudant.client.api
 
DbInfo - Class in com.cloudant.client.api.model
Holds information about a CouchDB database instance.
DbInfo() - Constructor for class com.cloudant.client.api.model.DbInfo
 
deleteDB(String, String) - Method in class com.cloudant.client.api.CloudantClient
deleteDB(String) - Method in class com.cloudant.client.api.CloudantClient
Request to delete a database.
deleteIndex(String, String) - Method in class com.cloudant.client.api.Database
Delete an index
descending(Boolean) - Method in class com.cloudant.client.api.View
Reverses the reading direction, not the sort order.
design() - Method in class com.cloudant.client.api.Database
Provides access to CouchDB Design Documents.
DesignDocument - Class in com.cloudant.client.api.model
Represents a design document.
DesignDocument() - Constructor for class com.cloudant.client.api.model.DesignDocument
 
DesignDocument.MapReduce - Class in com.cloudant.client.api.model
 
docIds(String...) - Method in class com.cloudant.client.api.Replication
 
docIds(String...) - Method in class com.cloudant.client.api.Replicator
 
Document - Class in com.cloudant.client.api.model
Convenient base class for Cloudant documents, defines the basic id, revision properties, and attachments.
Document() - Constructor for class com.cloudant.client.api.model.Document
 
DocumentConflictException - Exception in org.lightcouch
Thrown when a conflict is detected during save or update.
DocumentConflictException(String) - Constructor for exception org.lightcouch.DocumentConflictException
 
DocumentConflictException(Throwable) - Constructor for exception org.lightcouch.DocumentConflictException
 
DocumentConflictException(String, Throwable) - Constructor for exception org.lightcouch.DocumentConflictException
 
drillDown(String, String) - Method in class com.cloudant.client.api.Search
 

E

endKey(Object...) - Method in class com.cloudant.client.api.View
 
endKeyDocId(String) - Method in class com.cloudant.client.api.View
 
ensureFullCommit() - Method in class com.cloudant.client.api.Database
Requests the database commits any recent changes to disk.
equals(Object) - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce
 
equals(Object) - Method in class com.cloudant.client.api.model.Params
 
equals(Object) - Method in class com.cloudant.client.api.model.ViewResult
 
executeRequest(HttpRequestBase) - Method in class com.cloudant.client.api.CloudantClient
Executes a HTTP request.

F

fields(String) - Method in class com.cloudant.client.api.model.FindByIndexOptions
Can be called multiple times to set the list of return fields
filter(String) - Method in class com.cloudant.client.api.Changes
 
filter(String) - Method in class com.cloudant.client.api.Replication
 
filter(String) - Method in class com.cloudant.client.api.Replicator
 
find(Class<T>, String) - Method in class com.cloudant.client.api.Database
Finds an Object of the specified type.
find(Class<T>, String, Params) - Method in class com.cloudant.client.api.Database
Finds an Object of the specified type.
find(Class<T>, String, String) - Method in class com.cloudant.client.api.Database
Finds an Object of the specified type.
find(String) - Method in class com.cloudant.client.api.Database
Finds a document and return the result as InputStream.
find(String, String) - Method in class com.cloudant.client.api.Database
Finds a document given id and revision and returns the result as InputStream.
find() - Method in class com.cloudant.client.api.Replicator
Finds a document in the replicator database.
findAll() - Method in class com.cloudant.client.api.Replicator
Finds all documents in the replicator database.
findAny(Class<T>, String) - Method in class com.cloudant.client.api.Database
This method finds any document given a URI.
findByIndex(String, Class<T>) - Method in class com.cloudant.client.api.Database
Find documents using an index
findByIndex(String, Class<T>, FindByIndexOptions) - Method in class com.cloudant.client.api.Database
Find documents using an index
FindByIndexOptions - Class in com.cloudant.client.api.model
Options to set on findByIndex() request.
FindByIndexOptions() - Constructor for class com.cloudant.client.api.model.FindByIndexOptions
 

G

generateApiKey() - Method in class com.cloudant.client.api.CloudantClient
Generate an API key
getActiveTasks() - Method in class com.cloudant.client.api.CloudantClient
Get all active tasks
getAllDbs() - Method in class com.cloudant.client.api.CloudantClient
 
getAllFromDesk() - Method in class com.cloudant.client.api.DbDesign
Gets all design documents from desk.
getAllNodes() - Method in class com.cloudant.client.api.model.Membership
 
getAttachments() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getAuthenticatedModeSSLSocketFactory() - Method in class com.cloudant.client.api.model.ConnectOptions
Returns the SSLSocketFactory that gets used when connecting to CloudantDB over a https URL, when SSL authentication is enabled.
getBaseUri() - Method in class com.cloudant.client.api.CloudantClient
 
getBookmark() - Method in class com.cloudant.client.api.model.SearchResult
 
getBy() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroups
 
getChanges() - Method in class com.cloudant.client.api.Changes
Requests Change notifications of feed type normal.
getChanges() - Method in class com.cloudant.client.api.model.ChangesResult.Row
 
getChanges_done() - Method in class com.cloudant.client.api.model.Task
 
getChanges_pending() - Method in class com.cloudant.client.api.model.Task
 
getCheckpointed_source_seq() - Method in class com.cloudant.client.api.model.Task
 
getClusterNodes() - Method in class com.cloudant.client.api.model.Membership
 
getConnectionTimeout() - Method in class com.cloudant.client.api.model.ConnectOptions
 
getConnectionTimeout() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getContentType() - Method in class com.cloudant.client.api.model.Attachment
 
getContinuous() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getCookie() - Method in class com.cloudant.client.api.CloudantClient
Get the cookieStore
getCounts() - Method in class com.cloudant.client.api.model.SearchResult
 
getCreateTarget() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getData() - Method in class com.cloudant.client.api.model.Attachment
 
getDatabase() - Method in class com.cloudant.client.api.model.Task
 
getDbName() - Method in class com.cloudant.client.api.model.DbInfo
 
getDBUri() - Method in class com.cloudant.client.api.Database
 
getDesign_document() - Method in class com.cloudant.client.api.model.Task
 
getDesignDocId() - Method in class com.cloudant.client.api.model.Index
 
getDigest() - Method in class com.cloudant.client.api.model.Attachment
 
getDiskFormatVersion() - Method in class com.cloudant.client.api.model.DbInfo
 
getDiskSize() - Method in class com.cloudant.client.api.model.DbInfo
 
getDoc() - Method in class com.cloudant.client.api.model.ChangesResult.Row
 
getDoc() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
getDoc() - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
getDoc_id() - Method in class com.cloudant.client.api.model.Task
 
getDoc_write_failures() - Method in class com.cloudant.client.api.model.Task
 
getDocCount() - Method in class com.cloudant.client.api.model.DbInfo
 
getDocDelCount() - Method in class com.cloudant.client.api.model.DbInfo
 
getDocIds() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getDocs_read() - Method in class com.cloudant.client.api.model.Task
 
getDocs_written() - Method in class com.cloudant.client.api.model.Task
 
getDocsRead() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getDocsWritten() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getDocWriteFailures() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getEndLastSeq() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getEndTime() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getError() - Method in class com.cloudant.client.api.model.Response
 
getFields() - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
getFields() - Method in class com.cloudant.client.api.model.Index
 
getFields() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
getFilter() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getFromDb(String) - Method in class com.cloudant.client.api.DbDesign
Gets a design document from the database.
getFromDb(String, String) - Method in class com.cloudant.client.api.DbDesign
Gets a design document from the database.
getFromDesk(String) - Method in class com.cloudant.client.api.DbDesign
Gets a design document from desk.
getGroups() - Method in class com.cloudant.client.api.model.SearchResult
 
getGson() - Method in class com.cloudant.client.api.CloudantClient
 
getHistories() - Method in class com.cloudant.client.api.model.ReplicationResult
 
getHttpConnections() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getId() - Method in class com.cloudant.client.api.model.ChangesResult.Row
 
getId() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getId() - Method in class com.cloudant.client.api.model.Response
 
getId() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
getId() - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
getIndex() - Method in class com.cloudant.client.api.model.Task
 
getInstanceStartTime() - Method in class com.cloudant.client.api.model.DbInfo
 
getInternalParams() - Method in class com.cloudant.client.api.model.Params
 
getKey() - Method in class com.cloudant.client.api.model.ApiKey
Return the Apikey
getKey() - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
getLastSeq() - Method in class com.cloudant.client.api.model.ChangesResult
 
getLength() - Method in class com.cloudant.client.api.model.Attachment
 
getLimit() - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
getLocalId() - Method in class com.cloudant.client.api.model.ReplicationResult
 
getMap() - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce
 
getMaxConnections() - Method in class com.cloudant.client.api.model.ConnectOptions
 
getMembership() - Method in class com.cloudant.client.api.CloudantClient
Get the list of nodes in a cluster
getMissing_revisions_found() - Method in class com.cloudant.client.api.model.Task
 
getMissingChecked() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getMissingFound() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getName() - Method in class com.cloudant.client.api.model.Index
 
getName() - Method in class com.cloudant.client.api.model.IndexField
 
getName() - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx
 
getNextParam() - Method in class com.cloudant.client.api.model.Page
 
getNode() - Method in class com.cloudant.client.api.model.Task
 
getNodes() - Method in class com.cloudant.client.api.model.Shard
 
getOffset() - Method in class com.cloudant.client.api.model.ViewResult
Deprecated.
getOrder() - Method in class com.cloudant.client.api.model.IndexField
 
getOrder() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
getPageNumber() - Method in class com.cloudant.client.api.model.Page
 
getParams() - Method in class com.cloudant.client.api.model.Params
 
getPassword() - Method in class com.cloudant.client.api.model.ApiKey
Return the password associated with the ApiKey
getPermissions() - Method in class com.cloudant.client.api.Database
Returns the Permissions of this database.
getPhase() - Method in class com.cloudant.client.api.model.Task
 
getPid() - Method in class com.cloudant.client.api.model.Task
 
getPreviousParam() - Method in class com.cloudant.client.api.model.Page
 
getProxy() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getProxyHost() - Method in class com.cloudant.client.api.model.ConnectOptions
 
getProxyPort() - Method in class com.cloudant.client.api.model.ConnectOptions
 
getPurgeSeq() - Method in class com.cloudant.client.api.model.DbInfo
 
getQueryParams() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getRange() - Method in class com.cloudant.client.api.model.Shard
 
getRanges() - Method in class com.cloudant.client.api.model.SearchResult
 
getReadQuorum() - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
getReason() - Method in class com.cloudant.client.api.model.Response
 
getRecordedSeq() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getReduce() - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce
 
getReplication_id() - Method in class com.cloudant.client.api.model.Task
 
getReplicationId() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getReplicationState() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getReplicationStateTime() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getResultFrom() - Method in class com.cloudant.client.api.model.Page
 
getResultList() - Method in class com.cloudant.client.api.model.Page
 
getResults() - Method in class com.cloudant.client.api.model.ChangesResult
 
getResultTo() - Method in class com.cloudant.client.api.model.Page
 
getRetriesPerRequest() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getRev() - Method in class com.cloudant.client.api.model.ChangesResult.Row.Rev
 
getRev() - Method in class com.cloudant.client.api.model.Response
 
getRevision() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getRevisions_checked() - Method in class com.cloudant.client.api.model.Task
 
getRevpos() - Method in class com.cloudant.client.api.model.Attachment
 
getRoles() - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx
 
getRows() - Method in class com.cloudant.client.api.model.SearchResult
 
getRows() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroups
 
getRows() - Method in class com.cloudant.client.api.model.ViewResult
 
getRows() - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
getSeq() - Method in class com.cloudant.client.api.model.ChangesResult.Row
 
getSessionId() - Method in class com.cloudant.client.api.model.ReplicationResult
 
getSessionId() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getShard(String) - Method in class com.cloudant.client.api.Database
Get info about the shard a document belongs to
getShards() - Method in class com.cloudant.client.api.Database
Get info about the shards in the database
getSinceSeq() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getSkip() - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
getSocketTimeout() - Method in class com.cloudant.client.api.model.ConnectOptions
 
getSort() - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
getSource() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getSource() - Method in class com.cloudant.client.api.model.Task
 
getSource_seq() - Method in class com.cloudant.client.api.model.Task
 
getSourceLastSeq() - Method in class com.cloudant.client.api.model.ReplicationResult
 
getStarted_on() - Method in class com.cloudant.client.api.model.Task
 
getStartLastSeq() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getStartTime() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
getTarget() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getTarget() - Method in class com.cloudant.client.api.model.Task
 
getTotal_changes() - Method in class com.cloudant.client.api.model.Task
 
getTotalResults() - Method in class com.cloudant.client.api.model.Page
 
getTotalRows() - Method in class com.cloudant.client.api.model.SearchResult
 
getTotalRows() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroups
 
getTotalRows() - Method in class com.cloudant.client.api.model.ViewResult
 
getType() - Method in class com.cloudant.client.api.model.Index
 
getType() - Method in class com.cloudant.client.api.model.Task
 
getUpdated_on() - Method in class com.cloudant.client.api.model.Task
 
getUpdateSeq() - Method in class com.cloudant.client.api.model.DbInfo
 
getUpdateSeq() - Method in class com.cloudant.client.api.model.ViewResult
 
getUseIndex() - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
getUser() - Method in class com.cloudant.client.api.model.Task
 
getUserCtx() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getUserCtx() - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx
 
getValue() - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
getView() - Method in class com.cloudant.client.api.model.Task
 
getWorkerBatchSize() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
getWorkerProcesses() - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
group(Boolean) - Method in class com.cloudant.client.api.View
 
groupField(String, boolean) - Method in class com.cloudant.client.api.Search
field by which to group results.
groupLevel(Integer) - Method in class com.cloudant.client.api.View
 
groupLimit(int) - Method in class com.cloudant.client.api.Search
Maximum group count when groupField is set
groupSort(String) - Method in class com.cloudant.client.api.Search
the sort order of the groups when groupField is set

H

hashCode() - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce
 
hashCode() - Method in class com.cloudant.client.api.model.Params
 
hasNext() - Method in class com.cloudant.client.api.Changes
Checks whether a feed is available in the continuous stream, blocking until a feed is received.
heartBeat(long) - Method in class com.cloudant.client.api.Changes
 
httpConnections(int) - Method in class com.cloudant.client.api.Replicator
 

I

includeDocs(boolean) - Method in class com.cloudant.client.api.Changes
 
includeDocs(Boolean) - Method in class com.cloudant.client.api.Search
 
includeDocs(Boolean) - Method in class com.cloudant.client.api.View
 
inclusiveEnd(Boolean) - Method in class com.cloudant.client.api.View
 
Index - Class in com.cloudant.client.api.model
Encapsulates a Cloudant Index definition
Index(String, String, String) - Constructor for class com.cloudant.client.api.model.Index
 
IndexField - Class in com.cloudant.client.api.model
Encapsulates a Cloudant IndexField definition
IndexField(String, IndexField.SortOrder) - Constructor for class com.cloudant.client.api.model.IndexField
Represents a Cloudant Sort Syntax for a json field.
IndexField.SortOrder - Enum in com.cloudant.client.api.model
 
info() - Method in class com.cloudant.client.api.Database
 
invokeUpdateHandler(String, String, String) - Method in class com.cloudant.client.api.Database
invokeUpdateHandler(String, String, Params) - Method in class com.cloudant.client.api.Database
Invokes an Update Handler.
isCompactRunning() - Method in class com.cloudant.client.api.model.DbInfo
 
isContinuous() - Method in class com.cloudant.client.api.model.Task
 
isDeleted() - Method in class com.cloudant.client.api.model.ChangesResult.Row
 
isHasNext() - Method in class com.cloudant.client.api.model.Page
 
isHasPrevious() - Method in class com.cloudant.client.api.model.Page
 
isOk() - Method in class com.cloudant.client.api.model.ReplicationResult
 
isSSLAuthenticationDisabled() - Method in class com.cloudant.client.api.model.ConnectOptions
 
isStub() - Method in class com.cloudant.client.api.model.Attachment
 

K

key(Object...) - Method in class com.cloudant.client.api.View
 
keys(Object...) - Method in class com.cloudant.client.api.View
Supplies a key list when calling _all_docs View.

L

limit(int) - Method in class com.cloudant.client.api.Changes
 
limit(Integer) - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
limit(Integer) - Method in class com.cloudant.client.api.Search
 
limit(Integer) - Method in class com.cloudant.client.api.View
 
listIndices() - Method in class com.cloudant.client.api.Database
List all indices
localSeq() - Method in class com.cloudant.client.api.model.Params
 

M

MapReduce() - Constructor for class com.cloudant.client.api.model.DesignDocument.MapReduce
 
Membership - Class in com.cloudant.client.api.model
Encapsulates the list of nodes in a Cloudant cluster

N

next() - Method in class com.cloudant.client.api.Changes
 
NoDocumentException - Exception in org.lightcouch
Thrown when a requested document is not found.
NoDocumentException(String) - Constructor for exception org.lightcouch.NoDocumentException
 
NoDocumentException(Throwable) - Constructor for exception org.lightcouch.NoDocumentException
 
NoDocumentException(String, Throwable) - Constructor for exception org.lightcouch.NoDocumentException
 

O

org.lightcouch - package org.lightcouch
 

P

Page<T> - Class in com.cloudant.client.api.model
Holds data of a page as result of a view pagination query.
Page(Page<T>) - Constructor for class com.cloudant.client.api.model.Page
 
Params - Class in com.cloudant.client.api.model
Query parameters to append to find requests.
Params() - Constructor for class com.cloudant.client.api.model.Params
 
Permissions - Enum in com.cloudant.client.api.model
 
post(Object) - Method in class com.cloudant.client.api.Database
Saves an object in the database using HTTP POST request.
post(Object, int) - Method in class com.cloudant.client.api.Database
Saves an object in the database using HTTP POST request with specificied write quorum
PreconditionFailedException - Exception in org.lightcouch
CouchDbException class for HTTP 412 precondition failed status codes
PreconditionFailedException(String) - Constructor for exception org.lightcouch.PreconditionFailedException
 
PreconditionFailedException(Throwable) - Constructor for exception org.lightcouch.PreconditionFailedException
 
PreconditionFailedException(String, Throwable) - Constructor for exception org.lightcouch.PreconditionFailedException
 
proxy(String) - Method in class com.cloudant.client.api.Replication
 
proxy(String) - Method in class com.cloudant.client.api.Replicator
 

Q

query(String, Class<T>) - Method in class com.cloudant.client.api.Search
Queries a Search Index and returns ungrouped results.
query(Class<T>) - Method in class com.cloudant.client.api.View
Queries a view.
queryForBoolean() - Method in class com.cloudant.client.api.View
 
queryForInt() - Method in class com.cloudant.client.api.View
 
queryForLong() - Method in class com.cloudant.client.api.View
 
queryForStream(String) - Method in class com.cloudant.client.api.Search
Performs a Cloudant Search and returns the result as an InputStream
queryForStream() - Method in class com.cloudant.client.api.View
Queries a view as an InputStream
queryForString() - Method in class com.cloudant.client.api.View
 
queryGroups(String, Class<T>) - Method in class com.cloudant.client.api.Search
Queries a Search Index and returns grouped results in a map where key of the map is the groupName.
queryPage(int, String, Class<T>) - Method in class com.cloudant.client.api.View
Queries a view for pagination, returns a next or a previous page, this method figures out which page to return based on the given param that is generated by an earlier call to this method, quering the first page is done by passing a null param.
queryParams(String) - Method in class com.cloudant.client.api.Replication
 
queryParams(Map<String, Object>) - Method in class com.cloudant.client.api.Replication
 
queryParams(String) - Method in class com.cloudant.client.api.Replicator
 
queryParams(Map<String, Object>) - Method in class com.cloudant.client.api.Replicator
 
querySearchResult(String, Class<T>) - Method in class com.cloudant.client.api.Search
Performs a Cloudant Search and returns the result as an SearchResult
queryView(Class<K>, Class<V>, Class<T>) - Method in class com.cloudant.client.api.View
Returns the queried view's results containing JSON entries.

R

ranges(String) - Method in class com.cloudant.client.api.Search
Ranges for faceted searches.
readContent(List<String>, String, String) - Method in class com.cloudant.client.api.DbDesign
 
readQuorum(Integer) - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
readQuorum(int) - Method in class com.cloudant.client.api.model.Params
 
reduce(Boolean) - Method in class com.cloudant.client.api.View
 
remove(Object) - Method in class com.cloudant.client.api.Database
Removes a document from the database.
remove(String, String) - Method in class com.cloudant.client.api.Database
Removes a document from the database given both a document _id and _rev values.
remove() - Method in class com.cloudant.client.api.Replicator
Removes a document from the replicator database.
replication() - Method in class com.cloudant.client.api.CloudantClient
Provides access to Cloudant replication APIs.
Replication - Class in com.cloudant.client.api
This class provides access to the database replication API; a replication request is sent via HTTP POST to _replicate URI.
ReplicationHistory() - Constructor for class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
ReplicationHistory(ReplicationResult.ReplicationHistory) - Constructor for class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory
 
ReplicationResult - Class in com.cloudant.client.api.model
Holds the result of a replication request, along with previous sessions history.
ReplicationResult() - Constructor for class com.cloudant.client.api.model.ReplicationResult
 
ReplicationResult(ReplicationResult) - Constructor for class com.cloudant.client.api.model.ReplicationResult
 
ReplicationResult.ReplicationHistory - Class in com.cloudant.client.api.model
Represents a replication session history.
replicator() - Method in class com.cloudant.client.api.CloudantClient
Provides access to Cloudant replication APIs.
Replicator - Class in com.cloudant.client.api
This class provides access to the _replicator database introduced in CouchDB version 1.1.0
replicatorDB(String) - Method in class com.cloudant.client.api.Replicator
 
replicatorDocId(String) - Method in class com.cloudant.client.api.Replicator
 
replicatorDocRev(String) - Method in class com.cloudant.client.api.Replicator
 
ReplicatorDocument - Class in com.cloudant.client.api.model
Represents a replication document in the _replicator database.
ReplicatorDocument() - Constructor for class com.cloudant.client.api.model.ReplicatorDocument
 
ReplicatorDocument(ReplicatorDocument) - Constructor for class com.cloudant.client.api.model.ReplicatorDocument
 
ReplicatorDocument.UserCtx - Class in com.cloudant.client.api.model
 
Response - Class in com.cloudant.client.api.model
Contains the response returned from CouchDB.
Response() - Constructor for class com.cloudant.client.api.model.Response
 
Response(Response) - Constructor for class com.cloudant.client.api.model.Response
 
retriesPerRequest(int) - Method in class com.cloudant.client.api.Replicator
 
Rev(ChangesResult.Row.Rev) - Constructor for class com.cloudant.client.api.model.ChangesResult.Row.Rev
 
rev(String) - Method in class com.cloudant.client.api.model.Params
 
revisions() - Method in class com.cloudant.client.api.model.Params
 
revsInfo() - Method in class com.cloudant.client.api.model.Params
 
Row(ChangesResult.Row) - Constructor for class com.cloudant.client.api.model.ChangesResult.Row
 
Rows() - Constructor for class com.cloudant.client.api.model.ViewResult.Rows
 

S

save(Object) - Method in class com.cloudant.client.api.Database
Saves an object in the database, using HTTP PUT request.
save(Object, int) - Method in class com.cloudant.client.api.Database
Saves an object in the database, using HTTP PUT request.
save() - Method in class com.cloudant.client.api.Replicator
Adds a new document to the replicator database.
saveAttachment(InputStream, String, String) - Method in class com.cloudant.client.api.Database
Saves an attachment to a new document with a generated UUID as the document id.
saveAttachment(InputStream, String, String, String, String) - Method in class com.cloudant.client.api.Database
Saves an attachment to an existing document given both a document id and revision, or save to a new document given only the id, and rev as null.
search(String) - Method in class com.cloudant.client.api.Database
Provides access to Cloudant Search APIs.
Search - Class in com.cloudant.client.api
This class provides access to the Cloudant Search APIs.
SearchResult<T> - Class in com.cloudant.client.api.model
Holds a search result entries
SearchResult() - Constructor for class com.cloudant.client.api.model.SearchResult
 
SearchResult.SearchResultGroups - Class in com.cloudant.client.api.model
Inner class holding the SearchResult Groups.
SearchResult.SearchResultRows - Class in com.cloudant.client.api.model
Inner class holding the SearchResult rows.
SearchResultGroups() - Constructor for class com.cloudant.client.api.model.SearchResult.SearchResultGroups
 
SearchResultRows() - Constructor for class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
serverVersion() - Method in class com.cloudant.client.api.CloudantClient
 
setAttachments(Map<String, Attachment>) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setAuthenticatedModeSSLSocketFactory(SSLSocketFactory) - Method in class com.cloudant.client.api.model.ConnectOptions
Specifies the SSLSocketFactory to use when connecting to CloudantDB over a https URL, when SSL authentication is enabled.
setBookmark(String) - Method in class com.cloudant.client.api.model.SearchResult
 
setBy(String) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroups
 
setConnectionTimeout(int) - Method in class com.cloudant.client.api.model.ConnectOptions
 
setConnectionTimeout(Long) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setContentType(String) - Method in class com.cloudant.client.api.model.Attachment
 
setContinuous(Boolean) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setCounts(Map<String, Map<String, Long>>) - Method in class com.cloudant.client.api.model.SearchResult
 
setCreateTarget(Boolean) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setData(String) - Method in class com.cloudant.client.api.model.Attachment
 
setDoc(T) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
setDoc(T) - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
setDocIds(String[]) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setFields(T) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
setFilter(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setGsonBuilder(GsonBuilder) - Method in class com.cloudant.client.api.CloudantClient
Sets a GsonBuilder to create Gson instance.
setHasNext(boolean) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setHasPrevious(boolean) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setHttpConnections(Integer) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setId(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setId(String) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
setId(String) - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
setKey(K) - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
setMap(String) - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce
 
setMaxConnections(int) - Method in class com.cloudant.client.api.model.ConnectOptions
 
setName(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx
 
setNextParam(String) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setOffset(int) - Method in class com.cloudant.client.api.model.ViewResult
Deprecated.
setOrder(Object[]) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRows
 
setPageNumber(int) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setPermissions(String, EnumSet<Permissions>) - Method in class com.cloudant.client.api.Database
Set permissions for a user/apiKey on this database.
setPreviousParam(String) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setProxy(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setProxyHost(String) - Method in class com.cloudant.client.api.model.ConnectOptions
 
setProxyPort(int) - Method in class com.cloudant.client.api.model.ConnectOptions
 
setQueryParams(JsonObject) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setRanges(Map<String, Map<String, Long>>) - Method in class com.cloudant.client.api.model.SearchResult
 
setReduce(String) - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce
 
setReplicationId(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setReplicationState(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setReplicationStateTime(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setResultFrom(int) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setResultList(List<T>) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setResultTo(int) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setRetriesPerRequest(Integer) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setRevision(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setRoles(String[]) - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx
 
setRows(List<SearchResult<T>.SearchResultRows>) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroups
 
setRows(List<SearchResult<T>.SearchResultRows>) - Method in class com.cloudant.client.api.model.SearchResult
 
setRows(List<ViewResult<K, V, T>.Rows>) - Method in class com.cloudant.client.api.model.ViewResult
 
setSinceSeq(Integer) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setSocketTimeout(int) - Method in class com.cloudant.client.api.model.ConnectOptions
 
setSource(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setSSLAuthenticationDisabled(boolean) - Method in class com.cloudant.client.api.model.ConnectOptions
Sets whether hostname verification, certificate chain validation, and the use of the optional ConnectOptions.getAuthenticatedModeSSLSocketFactory() should be disabled.
setTarget(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setTotalResults(long) - Method in class com.cloudant.client.api.model.Page
Deprecated.
setTotalRows(Long) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroups
 
setTotalRows(long) - Method in class com.cloudant.client.api.model.SearchResult
 
setTotalRows(long) - Method in class com.cloudant.client.api.model.ViewResult
 
setUpdateSeq(long) - Method in class com.cloudant.client.api.model.ViewResult
 
setUserCtx(ReplicatorDocument.UserCtx) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setValue(V) - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
setWorkerBatchSize(Integer) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
setWorkerProcesses(Integer) - Method in class com.cloudant.client.api.model.ReplicatorDocument
 
Shard - Class in com.cloudant.client.api.model
Encapsulates info about a Cloudant Shard
Shard(String, List<String>) - Constructor for class com.cloudant.client.api.model.Shard
 
shutdown() - Method in class com.cloudant.client.api.CloudantClient
Shuts down the connection manager used by this client instance.
since(String) - Method in class com.cloudant.client.api.Changes
 
sinceSeq(Integer) - Method in class com.cloudant.client.api.Replication
Starts a replication since an update sequence.
sinceSeq(Integer) - Method in class com.cloudant.client.api.Replicator
 
skip(Integer) - Method in class com.cloudant.client.api.model.FindByIndexOptions
 
skip(Integer) - Method in class com.cloudant.client.api.View
 
sort(IndexField) - Method in class com.cloudant.client.api.model.FindByIndexOptions
Can be called multiple times to set the sort syntax
sort(String) - Method in class com.cloudant.client.api.Search
Specify the sort order for the result.
source(String) - Method in class com.cloudant.client.api.Replication
 
source(String) - Method in class com.cloudant.client.api.Replicator
 
stale(boolean) - Method in class com.cloudant.client.api.Search
 
stale(String) - Method in class com.cloudant.client.api.View
 
startKey(Object...) - Method in class com.cloudant.client.api.View
 
startKeyDocId(String) - Method in class com.cloudant.client.api.View
 
stop() - Method in class com.cloudant.client.api.Changes
Stops a running continuous feed.
style(String) - Method in class com.cloudant.client.api.Changes
 
syncDesignDocsWithDb() - Method in class com.cloudant.client.api.Database
Synchronize all design documents with the database.
synchronizeAllWithDb() - Method in class com.cloudant.client.api.DbDesign
Synchronize all design documents on desk to the database.
synchronizeWithDb(DesignDocument) - Method in class com.cloudant.client.api.DbDesign
Synchronizes a design document to the Database.

T

target(String) - Method in class com.cloudant.client.api.Replication
 
target(String) - Method in class com.cloudant.client.api.Replicator
 
targetOauth(String, String, String, String) - Method in class com.cloudant.client.api.Replication
 
Task - Class in com.cloudant.client.api.model
Encapsulates info about Cloudant Server Task
timeout(long) - Method in class com.cloudant.client.api.Changes
 
toString() - Method in class com.cloudant.client.api.model.ApiKey
(non-Javadoc)
toString() - Method in class com.cloudant.client.api.model.DbInfo
 
toString() - Method in class com.cloudant.client.api.model.Index
 
toString() - Method in class com.cloudant.client.api.model.IndexField
 
toString() - Method in class com.cloudant.client.api.model.Membership
 
toString() - Method in class com.cloudant.client.api.model.Params
 
toString() - Method in class com.cloudant.client.api.model.Response
 
toString() - Method in class com.cloudant.client.api.model.ViewResult.Rows
 
toString() - Method in class com.cloudant.client.api.model.ViewResult
 
trigger() - Method in class com.cloudant.client.api.Replication
Triggers a replication request.

U

update(Object) - Method in class com.cloudant.client.api.Database
Updates an object in the database, the object must have the correct _id and _rev values.
update(Object, int) - Method in class com.cloudant.client.api.Database
Updates an object in the database, the object must have the correct _id and _rev values.
updateSeq(Boolean) - Method in class com.cloudant.client.api.View
 
useIndex(String) - Method in class com.cloudant.client.api.model.FindByIndexOptions
Specify a specific index to run the query against
useIndex(String, String) - Method in class com.cloudant.client.api.model.FindByIndexOptions
Specify a specific index to run the query against
UserCtx() - Constructor for class com.cloudant.client.api.model.ReplicatorDocument.UserCtx
 
userCtxName(String) - Method in class com.cloudant.client.api.Replicator
 
userCtxRoles(String...) - Method in class com.cloudant.client.api.Replicator
 
uuids(long) - Method in class com.cloudant.client.api.CloudantClient
Request cloudant to send a list of UUIDs.

V

valueOf(String) - Static method in enum com.cloudant.client.api.model.IndexField.SortOrder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.cloudant.client.api.model.Permissions
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.cloudant.client.api.model.IndexField.SortOrder
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.cloudant.client.api.model.Permissions
Returns an array containing the constants of this enum type, in the order they are declared.
view(String) - Method in class com.cloudant.client.api.Database
Provides access to CouchDB View APIs.
View - Class in com.cloudant.client.api
This class provides access to the View APIs.
View() - Constructor for class com.cloudant.client.api.View
 
ViewResult<K,V,T> - Class in com.cloudant.client.api.model
Holds a view result entries.
ViewResult() - Constructor for class com.cloudant.client.api.model.ViewResult
 
ViewResult(ViewResult<K, V, T>) - Constructor for class com.cloudant.client.api.model.ViewResult
 
ViewResult.Rows - Class in com.cloudant.client.api.model
 

W

workerBatchSize(int) - Method in class com.cloudant.client.api.Replicator
 
workerProcesses(int) - Method in class com.cloudant.client.api.Replicator
 
A B C D E F G H I K L M N O P Q R S T U V W 
Skip navigation links