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

A

account(String) - Static method in class com.cloudant.client.api.ClientBuilder

Constructs a new ClientBuilder for building a CloudantClient instance to connect to the Cloudant server with the specified account.

add(String...) - Method in class com.cloudant.client.api.views.Key.ComplexKey

Add one or more strings to the complex key.

add(Boolean...) - Method in class com.cloudant.client.api.views.Key.ComplexKey

Add one or more booleans to the complex key.

add(Number...) - Method in class com.cloudant.client.api.views.Key.ComplexKey

Add one or more numbers to the complex key.

add() - Method in interface com.cloudant.client.api.views.MultipleRequestBuilder

Adds a query request to this MultipleRequestBuilder.

addAttachment(String, Attachment) - Method in class com.cloudant.client.api.model.Document

addAttachment(String, Attachment) - Method in class com.cloudant.client.api.model.ReplicatorDocument

addHighSentinel() - Method in class com.cloudant.client.api.views.Key.ComplexKey

Add the high key sentinel value, which is guaranteed to sort last, to the complex key.

addIndexField(String, IndexField.SortOrder) - Method in class com.cloudant.client.api.model.Index

Deprecated.

addParam(String, String) - Method in class com.cloudant.client.api.model.Params

all(String, Object...) - Static method in class com.cloudant.client.api.query.Expression

Matches an array value if it contains all the elements of the argument array

all(Object...) - Static method in class com.cloudant.client.api.query.PredicateExpression

Matches an array value if it contains all the elements of the argument array

AllDocsRequest - Interface in com.cloudant.client.api.views

The AllDocsRequest is used for getting an AllDocsResponse

AllDocsRequestBuilder - Interface in com.cloudant.client.api.views

Interface for building an unpaginated _all_docs request.

AllDocsResponse - Interface in com.cloudant.client.api.views

Encapsulates a response from an _all_docs request.

allIndexes() - Method in class com.cloudant.client.api.query.Indexes

All the indexes defined in the database.

analyzer(String) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Configure the analyzer for the text index.

and(Selector...) - Static method in class com.cloudant.client.api.query.Operation

Combine two or more selectors using the "and" operator

ApiKey - Class in com.cloudant.client.api.model

Encapsulates an ApiKey response from Cloudant

ApiKey() - Constructor for class com.cloudant.client.api.model.ApiKey

asc(String...) - Method in class com.cloudant.client.api.query.JsonIndex.Builder

Add one or more fields to the JsonIndex configuration in ascending order.

asc(String) - Static method in class com.cloudant.client.api.query.Sort

Attachment - Class in com.cloudant.client.api.model

Encapsulates 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

bluemix(String) - Static method in class com.cloudant.client.api.ClientBuilder

This is the same as calling ClientBuilder.bluemix(String, String) with instanceName set to null.

bluemix(String, String) - Static method in class com.cloudant.client.api.ClientBuilder

Sets Cloudant client credentials by inspecting a service information JSON string.

bluemix(String, String, String) - Static method in class com.cloudant.client.api.ClientBuilder

Sets Cloudant client credentials by inspecting a service information JSON string.

bookmark(String) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the bookmark option for the query builder.

bookmark(String) - Method in class com.cloudant.client.api.Search

Control which page of results to get.

bool(String...) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Add a field containing boolean values to the text index configuration.

BOOLEAN - Static variable in class com.cloudant.client.api.views.Key.Type

Type constant for boolean keys.

build() - Method in class com.cloudant.client.api.ClientBuilder

Build the CloudantClient instance based on the endpoint used to construct this client builder and the options that have been set on it before calling this method.

build() - Method in class com.cloudant.client.api.query.QueryBuilder

Build string representation of query for use with Database.query(String, Class).

build() - Method in interface com.cloudant.client.api.views.AllDocsRequestBuilder

build() - Method in interface com.cloudant.client.api.views.MultipleRequestBuilder

Called after composing the multiple requests to build the ViewMultipleRequest.

build() - Method in interface com.cloudant.client.api.views.SingleRequestBuilder

builder() - Static method in class com.cloudant.client.api.query.JsonIndex

Get a new instance of a builder to configure a JsonIndex.

builder() - Static method in class com.cloudant.client.api.query.TextIndex

Get a new instance of a builder to configure a TextIndex.

bulk(List<?>) - Method in class com.cloudant.client.api.Database

Uses the _bulk_docs endpoint to insert multiple documents into the database in a single HTTP 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 for interacting with the changes feed.

ChangesResult - Class in com.cloudant.client.api.model

Encapsulates a Changes feed result of type normal.

ChangesResult() - Constructor for class com.cloudant.client.api.model.ChangesResult

ChangesResult.Row - Class in com.cloudant.client.api.model

Encapsulates a Changes feed result row.

ChangesResult.Row.Rev - Class in com.cloudant.client.api.model

Represent a Change rev.

ClientBuilder - Class in com.cloudant.client.api

This class builds new CloudantClient instances.

CloudantClient - Class in com.cloudant.client.api

Exposes the Cloudant client API

com.cloudant.client.api - package com.cloudant.client.api

This package provides the objects for interacting with Cloudant

com.cloudant.client.api.model - package com.cloudant.client.api.model

This package provides additional objects for interacting with Cloudant

com.cloudant.client.api.query - package com.cloudant.client.api.query

This package provides access to the query API.

com.cloudant.client.api.scheduler - package com.cloudant.client.api.scheduler

com.cloudant.client.api.views - package com.cloudant.client.api.views

This package provides access to the view API.

com.cloudant.client.org.lightcouch - package com.cloudant.client.org.lightcouch

complex(Boolean...) - Static method in class com.cloudant.client.api.views.Key

Create a new complex key with one or more boolean elements at the start

complex(Number...) - Static method in class com.cloudant.client.api.views.Key

Create a new complex key with one or more numerical elements at the start

complex(String...) - Static method in class com.cloudant.client.api.views.Key

Create a new complex key with one or more string elements at the start

COMPLEX - Static variable in class com.cloudant.client.api.views.Key.Type

Type constant for complex keys.

ComplexKeyDeserializer() - Constructor for class com.cloudant.client.api.views.Key.ComplexKeyDeserializer

conflicts() - Method in class com.cloudant.client.api.model.Params

connectionTimeout(long) - Method in class com.cloudant.client.api.Replicator

connectTimeout(long, TimeUnit) - Method in class com.cloudant.client.api.ClientBuilder

Sets the specified timeout value when opening the client connection.

contains(String) - Method in class com.cloudant.client.api.Database

Checks if a document exists 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 com.cloudant.client.org.lightcouch

Base runtime exception class.

CouchDbException(String) - Constructor for exception com.cloudant.client.org.lightcouch.CouchDbException

CouchDbException(Throwable) - Constructor for exception com.cloudant.client.org.lightcouch.CouchDbException

CouchDbException(String, Throwable) - Constructor for exception com.cloudant.client.org.lightcouch.CouchDbException

CouchDbException(String, int) - Constructor for exception com.cloudant.client.org.lightcouch.CouchDbException

CouchDbException(String, Throwable, int) - Constructor for exception com.cloudant.client.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 with the specified name.

createIndex(String, String, String, IndexField[]) - Method in class com.cloudant.client.api.Database

Deprecated.

createIndex(String) - Method in class com.cloudant.client.api.Database

Create a new index from a string of JSON representing the index definition

createPartitionedDB(String) - Method in class com.cloudant.client.api.CloudantClient

Request to create a new partitioned database with the specified name.

createTarget(Boolean) - Method in class com.cloudant.client.api.Replication

createTarget(Boolean) - Method in class com.cloudant.client.api.Replicator

customSSLSocketFactory(SSLSocketFactory) - Method in class com.cloudant.client.api.ClientBuilder

Specifies the custom SSLSocketFactory to use when connecting to Cloudant over a https URL, when SSL authentication is enabled.

D

database(String, boolean) - Method in class com.cloudant.client.api.CloudantClient

Get a database reference for the database with the specified name.

Database - Class in com.cloudant.client.api

Contains a Database Public API implementation.

Database(Database) - Constructor for class com.cloudant.client.api.Database

Constructor for subclasses that want to override Database methods.

DbInfo - Class in com.cloudant.client.api.model

Encapsulates information about a database instance.

DbInfo() - Constructor for class com.cloudant.client.api.model.DbInfo

DbInfo.PartitionedIndexes - Class in com.cloudant.client.api.model

Encapsulates partitioned index properties.

DbInfo.PartitionedIndexes.Indexes - Class in com.cloudant.client.api.model

Encapsulates index properties.

DbInfo.Props - Class in com.cloudant.client.api.model

Encapsulates database properties.

DbInfo.Sizes - Class in com.cloudant.client.api.model

DEFAULT_CONNECTION_TIMEOUT - Static variable in class com.cloudant.client.api.ClientBuilder

Connection timeout defaults to 5 minutes

DEFAULT_MAX_CONNECTIONS - Static variable in class com.cloudant.client.api.ClientBuilder

Default max of 6 connections

DEFAULT_READ_TIMEOUT - Static variable in class com.cloudant.client.api.ClientBuilder

Read timeout defaults to 5 minutes

defaultField(boolean, String) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Configure the default field for the text index.

deleteDB(String) - Method in class com.cloudant.client.api.CloudantClient

Request to delete the database with the specified name.

deleteIndex(String, String) - Method in class com.cloudant.client.api.Database

Delete a JSON index

deleteIndex(String, String, String) - Method in class com.cloudant.client.api.Database

Delete an index with the specified name and type in the given design document.

desc(String...) - Method in class com.cloudant.client.api.query.JsonIndex.Builder

Add one or more fields to the JsonIndex configuration in descending order.

desc(String) - Static method in class com.cloudant.client.api.query.Sort

descending(boolean) - Method in class com.cloudant.client.api.Changes

descending(boolean) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Return the documents in ‘descending by key’ order.

deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.cloudant.client.api.views.Key.ComplexKeyDeserializer

DesignDocument - Class in com.cloudant.client.api.model

Encapsulates a design document.

DesignDocument() - Constructor for class com.cloudant.client.api.model.DesignDocument

designDocument(String) - Method in class com.cloudant.client.api.query.JsonIndex.Builder

Configure the design document name, if not set a new design document will be created with a generated name.

designDocument(String) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Configure the design document name, if not set a new design document will be created with a generated name.

DesignDocument.MapReduce - Class in com.cloudant.client.api.model

Encapsulates the Map-Reduce function of a view.

DesignDocument.Options - Class in com.cloudant.client.api.model

Encapsulates design document options.

DesignDocumentManager - Class in com.cloudant.client.api

Provides API to work with design documents.

disableSSLAuthentication() - Method in class com.cloudant.client.api.ClientBuilder

Flag to disable hostname verification and certificate chain validation.

Doc() - Constructor for class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

docIds(String...) - Method in class com.cloudant.client.api.Replication

Limit the replication to the specified document IDs.

docIds(String...) - Method in class com.cloudant.client.api.Replicator

Document - Class in com.cloudant.client.api.model

Base class for serialisation and deserialisation of Cloudant Documents.

Document() - Constructor for class com.cloudant.client.api.model.Document

DocumentConflictException - Exception in com.cloudant.client.org.lightcouch

Thrown when a conflict is detected during save or update.

DocumentConflictException(String) - Constructor for exception com.cloudant.client.org.lightcouch.DocumentConflictException

drillDown(String, String) - Method in class com.cloudant.client.api.Search

Deprecated.

Use Search.drillDown(String, String...)

drillDown(String, String...) - Method in class com.cloudant.client.api.Search

E

elemMatch(String, PredicateExpression...) - Static method in class com.cloudant.client.api.query.PredicatedOperation

Matches and returns all documents that contain an array field with at least one element that matches all the specified query criteria

empty() - Static method in class com.cloudant.client.api.query.EmptyExpression

EmptyExpression - Class in com.cloudant.client.api.query

endKey(K) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Stop returning records when the specified key is reached.

endKeyDocId(String) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Stop returning records when the specified document ID is reached.

ensureFullCommit() - Method in class com.cloudant.client.api.Database

Requests the database commits any recent changes to disk.

eq(String, Object) - Static method in class com.cloudant.client.api.query.Expression

The field is equal to the argument

eq(Object) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field is equal to the argument

equals(Object) - Method in class com.cloudant.client.api.model.DesignDocument

Compares this design document to the specified object.

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.query.Sort

equals(Object) - Method in class com.cloudant.client.api.query.TextIndex.Field

equals(Object) - Method in class com.cloudant.client.api.views.Key.ComplexKey

error - Variable in exception com.cloudant.client.org.lightcouch.CouchDbException

executeRequest(HttpConnection) - Method in class com.cloudant.client.api.CloudantClient

Executes a HTTP request.

ExecutionStats - Class in com.cloudant.client.api.query

ExecutionStats(long, long, long, long, long) - Constructor for class com.cloudant.client.api.query.ExecutionStats

executionStats(boolean) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the executionStats option for the query builder.

exists(String, boolean) - Static method in class com.cloudant.client.api.query.Expression

Check whether the field exists or not, regardless of its value

exists(boolean) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field exists or not, regardless of its value

Expression - Class in com.cloudant.client.api.query

Expressions are used to evaluate true/false criteria to select documents.

F

Field - Interface in com.cloudant.client.api.query

fields(String) - Method in class com.cloudant.client.api.model.FindByIndexOptions

Can be called multiple times to set the list of return fields

fields(String...) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the fields option for the query builder.

filter(String) - Method in class com.cloudant.client.api.Changes

Specify a filter function to apply to the changes feed.

filter(String) - Method in class com.cloudant.client.api.Replication

Specify a filter function to limit the documents that are replicated from the source database.

filter(String) - Method in class com.cloudant.client.api.Replicator

find(Class<T>, String) - Method in class com.cloudant.client.api.Database

Retrieve the document with the specified ID from the database and deserialize to an instance of the POJO of type T.

find(Class<T>, String, Params) - Method in class com.cloudant.client.api.Database

Retrieve the document with the specified ID from the database and deserialize to an instance of the POJO of type T.

find(Class<T>, String, String) - Method in class com.cloudant.client.api.Database

Retrieve the document with the specified ID at the specified revision from the database and deserialize to an instance of the POJO of type T.

find(String) - Method in class com.cloudant.client.api.Database

Finds the document with the specified document ID and returns it as an InputStream.

find(String, String) - Method in class com.cloudant.client.api.Database

Finds the document with the specified document ID and revision and returns it 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

Deprecated.

Use Database.query(String, Class) instead

findByIndex(String, Class<T>, FindByIndexOptions) - Method in class com.cloudant.client.api.Database

Deprecated.

Use Database.query(String, Class) instead

FindByIndexOptions - Class in com.cloudant.client.api.model

Options to set on findByIndex() request.

FindByIndexOptions() - Constructor for class com.cloudant.client.api.model.FindByIndexOptions

fromDirectory(File) - Static method in class com.cloudant.client.api.DesignDocumentManager

Deserialize a directory of javascript design documents to a List of DesignDocument objects.

fromFile(File) - Static method in class com.cloudant.client.api.DesignDocumentManager

Deserialize a javascript design document file to a DesignDocument object.

G

generateApiKey() - Method in class com.cloudant.client.api.CloudantClient

Use the authorization feature to generate new API keys to access your data.

get(String) - Method in class com.cloudant.client.api.DesignDocumentManager

Gets a design document from the database.

get(String, String) - Method in class com.cloudant.client.api.DesignDocumentManager

Gets a design document using the id and revision from the database.

getActive() - Method in class com.cloudant.client.api.model.DbInfo.Sizes

getActive() - Method in class com.cloudant.client.api.model.PartitionInfo.Sizes

Get the size of live data inside the database, in bytes.

getActiveTasks() - Method in class com.cloudant.client.api.CloudantClient

Get the list of active tasks from the server.

getAllDbs() - Method in class com.cloudant.client.api.CloudantClient

List all the databases on the server for the Cloudant account.

getAllDocsRequestBuilder() - Method in class com.cloudant.client.api.Database

Build a request for the _all_docs endpoint.

getAllNodes() - Method in class com.cloudant.client.api.model.Membership

getAnalyzer() - Method in class com.cloudant.client.api.query.TextIndex

Get the JSON string representation of the analyzer configured for this text index.

getAttachment(String, String) - Method in class com.cloudant.client.api.Database

Reads an attachment from the database.

getAttachment(String, String, String) - Method in class com.cloudant.client.api.Database

Reads an attachment from the database.

getAttachments() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getBaseUri() - Method in class com.cloudant.client.api.CloudantClient

getBookmark() - Method in class com.cloudant.client.api.model.SearchResult

getBookmark() - Method in class com.cloudant.client.api.query.QueryResult

getBy() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroup

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.ReplicatorDocument

getContentType() - Method in class com.cloudant.client.api.model.Attachment

getContinuous() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getCouchdb() - Method in class com.cloudant.client.api.model.MetaInformation

getCount() - Method in class com.cloudant.client.api.model.DbInfo.PartitionedIndexes

Get a total count of the partitioned indexes.

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

getDatabase() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getDatabase() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getDbCopy() - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce

Deprecated.

getDbName() - Method in class com.cloudant.client.api.model.DbInfo

getDBUri() - Method in class com.cloudant.client.api.Database

getDefaultField() - Method in class com.cloudant.client.api.query.TextIndex

Get the JSON string representation of the default field configuration.

getDesign_document() - Method in class com.cloudant.client.api.model.Task

getDesignDocId() - Method in class com.cloudant.client.api.model.Index

Deprecated.

getDesignDocumentID() - Method in interface com.cloudant.client.api.query.Index

getDesignDocumentManager() - Method in class com.cloudant.client.api.Database

Get a manager that has convenience methods for managing design documents.

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.SearchResultRow

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

getDocCount() - Method in class com.cloudant.client.api.model.PartitionInfo

Get a count of the documents in the specified database partition.

getDocDelCount() - Method in class com.cloudant.client.api.model.DbInfo

Deprecated.

getDocDelCount() - Method in class com.cloudant.client.api.model.PartitionInfo

Get a count of the deleted documents in the specified database partition.

getDocDelCountLong() - Method in class com.cloudant.client.api.model.DbInfo

getDocId() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getDocId() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getDocIds() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getDocIds() - Method in interface com.cloudant.client.api.views.AllDocsResponse

getDocs() - Method in class com.cloudant.client.api.query.QueryResult

getDocs() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse

getDocs() - Method in interface com.cloudant.client.api.views.AllDocsResponse

Get the document information from an _all_docs request.

getDocs() - Method in interface com.cloudant.client.api.views.ViewResponse

getDocs_read() - Method in class com.cloudant.client.api.model.Task

getDocs_written() - Method in class com.cloudant.client.api.model.Task

getDocsAs(Class<D>) - Method in interface com.cloudant.client.api.views.AllDocsResponse

Deserializes the included full content of result documents to a list of the specified type.

getDocsAs(Class<D>) - Method in interface com.cloudant.client.api.views.ViewResponse

Deserializes the included full content of result documents to a list of the specified type.

getDocsRead() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory

getDocsWritten() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory

getDocument() - Method in interface com.cloudant.client.api.views.ViewResponse.Row

getDocumentAsType(Class<D>) - Method in interface com.cloudant.client.api.views.ViewResponse.Row

Deserializes the included full content of a result document to the specified type.

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

getError() - Method in interface com.cloudant.client.api.views.ViewResponse.Row

Gets the error message if an error exists.

getError() - Method in exception com.cloudant.client.org.lightcouch.CouchDbException

getErrorCount() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getErrors() - Method in interface com.cloudant.client.api.views.AllDocsResponse

Gets a map of the document id and error message if an error exists for any result in the _all_docs request.

getExecutionStats() - Method in class com.cloudant.client.api.query.QueryResult

getExecutionTimeMs() - Method in class com.cloudant.client.api.query.ExecutionStats

getExternal() - Method in class com.cloudant.client.api.model.DbInfo.Sizes

getExternal() - Method in class com.cloudant.client.api.model.PartitionInfo.Sizes

Get the uncompressed size of database contents, in bytes.

getFeatures() - Method in class com.cloudant.client.api.model.MetaInformation

getFields() - Method in class com.cloudant.client.api.model.FindByIndexOptions

getFields() - Method in class com.cloudant.client.api.model.Index

Deprecated.

getFields() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRow

getFields() - Method in interface com.cloudant.client.api.query.Index

getFile() - Method in class com.cloudant.client.api.model.DbInfo.Sizes

getFilter() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getFilters() - Method in class com.cloudant.client.api.model.DesignDocument

Get the changes feed filter functions defined in this design document.

getFirstRowCount() - Method in interface com.cloudant.client.api.views.ViewResponse

getFulltext() - Method in class com.cloudant.client.api.model.DesignDocument

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

getHistory() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

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.SearchResultRow

getId() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getId() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getId() - Method in interface com.cloudant.client.api.views.ViewResponse.Row

getIdsAndRevs() - Method in interface com.cloudant.client.api.views.AllDocsResponse

Gets a map of the document id and revision for each result in the _all_docs request.

getIndex() - Method in class com.cloudant.client.api.model.Task

getIndexArrayLengths() - Method in class com.cloudant.client.api.query.TextIndex

getIndexes() - Method in class com.cloudant.client.api.model.DbInfo.PartitionedIndexes

Get the DbInfo.PartitionedIndexes.Indexes object for this database.

getIndexes() - Method in class com.cloudant.client.api.model.DesignDocument

Get a JSON object containing all the indexes defined in the design document.

getInfo() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getInstanceStartTime() - Method in class com.cloudant.client.api.model.DbInfo

getInternalParams() - Method in class com.cloudant.client.api.model.Params

getJobs() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse

getKey() - Method in class com.cloudant.client.api.model.ApiKey

Return the Apikey

getKey() - Method in interface com.cloudant.client.api.views.ViewResponse.Row

getKeys() - Method in interface com.cloudant.client.api.views.ViewResponse

getLanguage() - Method in class com.cloudant.client.api.model.DesignDocument

Get the language used for the views defined in this design document.

getLastRowCount() - Method in interface com.cloudant.client.api.views.ViewResponse

getLastSeq() - Method in class com.cloudant.client.api.model.ChangesResult

getLastUpdated() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getLength() - Method in class com.cloudant.client.api.model.Attachment

getLimit() - Method in class com.cloudant.client.api.model.DbInfo.PartitionedIndexes

Get the partitioned index limit.

getLimit() - Method in class com.cloudant.client.api.model.FindByIndexOptions

getLists() - Method in class com.cloudant.client.api.model.DesignDocument

Get the list functions defined in this design document.

getLocalId() - Method in class com.cloudant.client.api.model.ReplicationResult

getMap() - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce

Get the defined map function.

getMembership() - Method in class com.cloudant.client.api.CloudantClient

Get the list of all nodes and the list of active nodes in the cluster.

getMessage() - Method in exception com.cloudant.client.org.lightcouch.CouchDbException

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

Deprecated.

getName() - Method in class com.cloudant.client.api.model.IndexField

Deprecated.

getName() - Method in class com.cloudant.client.api.model.MetaInformation.Vendor

getName() - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx

getName() - Method in interface com.cloudant.client.api.query.Field

getName() - Method in interface com.cloudant.client.api.query.Index

getNextPageToken() - Method in interface com.cloudant.client.api.views.ViewResponse

Returns an opaque pagination token for the next page of results, which can be used with ViewRequest.getResponse(String) to retrieve the next page without keeping ViewResponse state.

getNode() - Method in class com.cloudant.client.api.model.Task

getNode() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getNode() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getNodes() - Method in class com.cloudant.client.api.model.Shard

getOffset() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse

getOffset() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse

getOptions() - Method in class com.cloudant.client.api.model.DesignDocument

Get the options defined in this design document.

getOrder() - Method in class com.cloudant.client.api.model.IndexField

Deprecated.

getOrder() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRow

getOrder() - Method in class com.cloudant.client.api.query.Sort

getPageNumber() - Method in interface com.cloudant.client.api.views.ViewResponse

Get the page number of this response.

getParams() - Method in class com.cloudant.client.api.model.Params

getPartialFilterSelector() - Method in interface com.cloudant.client.api.query.Index

Get the JSON string representation of the selector configured for this index.

getPartition() - Method in class com.cloudant.client.api.model.PartitionInfo

Get the database partition key.

getPartitioned() - Method in class com.cloudant.client.api.model.DbInfo.Props

Get the database partitioned property.

getPartitioned() - Method in class com.cloudant.client.api.model.DesignDocument.Options

Get partitioned option for this design document.

getPartitionedIndexes() - Method in class com.cloudant.client.api.model.DbInfo

Get the DbInfo.PartitionedIndexes object for this database.

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

getPid() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getPreviousPageToken() - Method in interface com.cloudant.client.api.views.ViewResponse

Returns an opaque pagination token for the previous page of results, which can be used with ViewRequest.getResponse(String) to retrieve the previous page without keeping ViewResponse state.

getProps() - Method in class com.cloudant.client.api.model.DbInfo

Get the database properties.

getProxy() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getProxy() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getPurgeSeq() - Method in class com.cloudant.client.api.model.DbInfo

Deprecated.

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

getReason() - Method in exception com.cloudant.client.org.lightcouch.CouchDbException

getRecordedSeq() - Method in class com.cloudant.client.api.model.ReplicationResult.ReplicationHistory

getReduce() - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce

Get the defined reduce function.

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

getResponse() - Method in interface com.cloudant.client.api.views.AllDocsRequest

Performs the request and returns the response.

getResponse() - Method in interface com.cloudant.client.api.views.ViewRequest

Performs the request and returns the response.

getResponse(String) - Method in interface com.cloudant.client.api.views.ViewRequest

Performs view request for the page represented by a pagination token obtained from a previous request.

getResults() - Method in class com.cloudant.client.api.model.ChangesResult

getResultsReturned() - Method in class com.cloudant.client.api.query.ExecutionStats

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

getRewrites() - Method in class com.cloudant.client.api.model.DesignDocument

Get the array of URL rewriting rules set in the design document's rewrites property.

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.SearchResultGroup

getRows() - Method in interface com.cloudant.client.api.views.ViewResponse

getSearch() - Method in class com.cloudant.client.api.model.DbInfo.PartitionedIndexes.Indexes

Get a count of the partitioned search indexes.

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.

getShows() - Method in class com.cloudant.client.api.model.DesignDocument

Get the show functions defined in this design document.

getSinceSeq() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getSingleValue() - Method in interface com.cloudant.client.api.views.ViewRequest

Performs the request and returns a single value.

getSizes() - Method in class com.cloudant.client.api.model.DbInfo

getSizes() - Method in class com.cloudant.client.api.model.PartitionInfo

Get the PartitionInfo.Sizes object for this database partition.

getSkip() - Method in class com.cloudant.client.api.model.FindByIndexOptions

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() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getSource() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getSource_seq() - Method in class com.cloudant.client.api.model.Task

getSourceIamApiKey() - Method in class com.cloudant.client.api.model.ReplicatorDocument

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

getStartTime() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getStartTime() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getState() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getStatusCode() - Method in class com.cloudant.client.api.model.Response

getStatusCode() - Method in exception com.cloudant.client.org.lightcouch.CouchDbException

getStringPurgeSeq() - Method in class com.cloudant.client.api.model.DbInfo

An opaque string that describes the state of purge operations across the database.

getTarget() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getTarget() - Method in class com.cloudant.client.api.model.Task

getTarget() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse.Doc

getTarget() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getTargetIamApiKey() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getTimestamp() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.History

getTotal_changes() - Method in class com.cloudant.client.api.model.Task

getTotalDocsExamined() - Method in class com.cloudant.client.api.query.ExecutionStats

getTotalKeysExamined() - Method in class com.cloudant.client.api.query.ExecutionStats

getTotalQuorumDocsExamined() - Method in class com.cloudant.client.api.query.ExecutionStats

getTotalRowCount() - Method in interface com.cloudant.client.api.views.AllDocsResponse

getTotalRowCount() - Method in interface com.cloudant.client.api.views.ViewResponse

getTotalRows() - Method in class com.cloudant.client.api.model.SearchResult

getTotalRows() - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroup

getTotalRows() - Method in class com.cloudant.client.api.scheduler.SchedulerDocsResponse

getTotalRows() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse

getType() - Method in class com.cloudant.client.api.model.Index

Deprecated.

getType() - Method in class com.cloudant.client.api.model.Task

getType() - Method in interface com.cloudant.client.api.query.Index

getType() - Method in class com.cloudant.client.api.query.TextIndex.Field

getType() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.History

getUpdated_on() - Method in class com.cloudant.client.api.model.Task

getUpdates() - Method in class com.cloudant.client.api.model.DesignDocument

Get the update handlers defined in this design document.

getUpdateSeq() - Method in class com.cloudant.client.api.model.DbInfo

getUseIndex() - Method in class com.cloudant.client.api.model.FindByIndexOptions

getUser() - Method in class com.cloudant.client.api.model.Task

getUser() - Method in class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

getUserCtx() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getUserCtx() - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx

getUuid() - Method in class com.cloudant.client.api.model.MetaInformation

getValidateDocUpdate() - Method in class com.cloudant.client.api.model.DesignDocument

Get the string of the javascript function set for the design document's validate_doc_update property.

getValue() - Method in interface com.cloudant.client.api.views.ViewResponse.Row

getValues() - Method in interface com.cloudant.client.api.views.ViewResponse

getVariant() - Method in class com.cloudant.client.api.model.MetaInformation.Vendor

getVendor() - Method in class com.cloudant.client.api.model.MetaInformation

getVersion() - Method in class com.cloudant.client.api.model.MetaInformation

getVersion() - Method in class com.cloudant.client.api.model.MetaInformation.Vendor

getView() - Method in class com.cloudant.client.api.model.DbInfo.PartitionedIndexes.Indexes

Get a count of the partitioned view indexes.

getView() - Method in class com.cloudant.client.api.model.Task

getViewRequestBuilder(String, String) - Method in class com.cloudant.client.api.Database

getViewResponses() - Method in interface com.cloudant.client.api.views.ViewMultipleRequest

Perform a single POST request to get the responses for the queries built into this request.

getViews() - Method in class com.cloudant.client.api.model.DesignDocument

Get the views defined in this design document.

getWarning() - Method in class com.cloudant.client.api.query.QueryResult

getWorkerBatchSize() - Method in class com.cloudant.client.api.model.ReplicatorDocument

getWorkerProcesses() - Method in class com.cloudant.client.api.model.ReplicatorDocument

group(boolean) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Reduceable

Group the results to a group or single row when using a reduce function.

groupField(String, boolean) - Method in class com.cloudant.client.api.Search

Group results by the specified field.

groupLevel(int) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Reduceable

Group reduce results for the specified number of array fields.

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

gsonBuilder(GsonBuilder) - Method in class com.cloudant.client.api.ClientBuilder

Set a custom GsonBuilder to use when serializing and de-serializing JSON in requests and responses between the CloudantClient and the server.

gt(String, Object) - Static method in class com.cloudant.client.api.query.Expression

The field is greater than the argument

gt(Object) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field is greater than the argument

gte(String, Object) - Static method in class com.cloudant.client.api.query.Expression

The field is greater than or equal to the argument

gte(Object) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field is greater than or equal to the argument

H

hashCode() - Method in class com.cloudant.client.api.model.DesignDocument

hashCode() - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce

hashCode() - Method in class com.cloudant.client.api.model.Params

hashCode() - Method in class com.cloudant.client.api.query.Sort

hashCode() - Method in class com.cloudant.client.api.query.TextIndex.Field

hashCode() - Method in class com.cloudant.client.api.views.Key.ComplexKey

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.

hasNextPage() - Method in interface com.cloudant.client.api.views.ViewResponse

hasPreviousPage() - Method in interface com.cloudant.client.api.views.ViewResponse

heartBeat(long) - Method in class com.cloudant.client.api.Changes

Enable an empty line heartbeat for longpoll or continuous feeds for when there have been no changes.

History() - Constructor for class com.cloudant.client.api.scheduler.SchedulerJobsResponse.History

httpConnections(int) - Method in class com.cloudant.client.api.Replicator

I

iamApiKey(String) - Method in class com.cloudant.client.api.ClientBuilder

Sets the IAM API key for the client connection.

iamApiKey(String, String, String) - Method in class com.cloudant.client.api.ClientBuilder

Sets the IAM API key for the client connection.

in(String, Object...) - Static method in class com.cloudant.client.api.query.Expression

The document field must exist in the list provided

in(Object...) - Static method in class com.cloudant.client.api.query.PredicateExpression

The document field must exist in the list provided

includeDocs(boolean) - Method in class com.cloudant.client.api.Changes

includeDocs(Boolean) - Method in class com.cloudant.client.api.Search

includeDocs(boolean) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Include the full content of the documents in the response.

inclusiveEnd(boolean) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Include rows with the specified endkey.

Index - Class in com.cloudant.client.api.model

Deprecated.

Index(String, String, String) - Constructor for class com.cloudant.client.api.model.Index

Deprecated.

Index<F extends Field> - Interface in com.cloudant.client.api.query

indexArrayLengths(boolean) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Indexes() - Constructor for class com.cloudant.client.api.model.DbInfo.PartitionedIndexes.Indexes

Indexes - Class in com.cloudant.client.api.query

Class modelling the indexes defined for a database.

Indexes() - Constructor for class com.cloudant.client.api.query.Indexes

IndexField - Class in com.cloudant.client.api.model

Deprecated.

IndexField(String, IndexField.SortOrder) - Constructor for class com.cloudant.client.api.model.IndexField

Deprecated.

Encapsulates a Cloudant Sort Syntax for a json field.

IndexField.SortOrder - Enum in com.cloudant.client.api.model

Deprecated.

Ascending or descending sort order

info() - Method in class com.cloudant.client.api.Database

Get information about this database.

interceptors(HttpConnectionInterceptor...) - Method in class com.cloudant.client.api.ClientBuilder

This method adds HttpConnectionInterceptors to be used on the CloudantClient connection.

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

isOk() - Method in class com.cloudant.client.api.model.ReplicationResult

isStub() - Method in class com.cloudant.client.api.model.Attachment

J

Job() - Constructor for class com.cloudant.client.api.scheduler.SchedulerJobsResponse.Job

JsonIndex - Class in com.cloudant.client.api.query

Class model of a JSON index definition.

JsonIndex.Builder - Class in com.cloudant.client.api.query

Class for building a definition for a JSON type index.

JsonIndex.Field - Class in com.cloudant.client.api.query

Model of a field in a JSON index including the field name and sort order.

jsonIndexes() - Method in class com.cloudant.client.api.query.Indexes

K

Key - Class in com.cloudant.client.api.views

Class for specifying the types of keys emitted by a view.

Key() - Constructor for class com.cloudant.client.api.views.Key

Key.ComplexKey - Class in com.cloudant.client.api.views

Provides methods for adding values to build a complex key array.

Key.ComplexKeyDeserializer - Class in com.cloudant.client.api.views

GSON deserializer to convert JSON arrays to .ComplexKey

Key.Type<T> - Class in com.cloudant.client.api.views

Key type identifier.

keys(K...) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Return only documents that match the specified key or keys.

L

limit(int) - Method in class com.cloudant.client.api.Changes

Limit the number of rows to return.

limit(Integer) - Method in class com.cloudant.client.api.model.FindByIndexOptions

limit(long) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the limit option for the query builder.

limit(Integer) - Method in class com.cloudant.client.api.Search

limit(int) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Unpaginated

Limits the number of returned rows to the specified count.

list() - Method in class com.cloudant.client.api.DesignDocumentManager

Performs a query to retrieve all the design documents defined in the database.

listIndexes() - Method in class com.cloudant.client.api.Database

List the indexes in the database.

listIndices() - Method in class com.cloudant.client.api.Database

Deprecated.

localSeq() - Method in class com.cloudant.client.api.model.Params

lt(String, Object) - Static method in class com.cloudant.client.api.query.Expression

The field is less than the argument

lt(Object) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field is less than the argument

lte(String, Object) - Static method in class com.cloudant.client.api.query.Expression

The field is less than or equal to the argument

lte(Object) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field is less than or equal to the argument

M

MapReduce() - Constructor for class com.cloudant.client.api.model.DesignDocument.MapReduce

maxConnections(int) - Method in class com.cloudant.client.api.ClientBuilder

Set the maximum number of connections to maintain in the connection pool.

Membership - Class in com.cloudant.client.api.model

Encapsulates the list of nodes in a Cloudant cluster

metaInformation() - Method in class com.cloudant.client.api.CloudantClient

Get the welcome message metadata.

MetaInformation - Class in com.cloudant.client.api.model

MetaInformation(String, String, String, MetaInformation.Vendor, List<String>) - Constructor for class com.cloudant.client.api.model.MetaInformation

MetaInformation.Vendor - Class in com.cloudant.client.api.model

mod(String, Long, Long) - Static method in class com.cloudant.client.api.query.Expression

Divisor and Remainder are both positive or negative integers.

mod(Long, Long) - Static method in class com.cloudant.client.api.query.PredicateExpression

Divisor and Remainder are both positive or negative integers.

MultipleRequestBuilder<K,V> - Interface in com.cloudant.client.api.views

Interface for building ViewMultipleRequests.

N

name(String) - Method in class com.cloudant.client.api.query.JsonIndex.Builder

Configure the name of the index, if not set a name will be generated.

name(String) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Configure the name of the index, if not set a name will be generated.

ne(String, Object) - Static method in class com.cloudant.client.api.query.Expression

The field is not equal to the argument

ne(Object) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field is not equal to the argument

newInstance() - Method in class com.cloudant.client.api.query.JsonIndex.Builder

newInstance() - Method in class com.cloudant.client.api.query.TextIndex.Builder

newMultipleRequest(Key.Type<K>, Class<V>) - Method in class com.cloudant.client.api.views.ViewRequestBuilder

Create a new builder for multiple unpaginated requests on the view.

newPaginatedRequest(Key.Type<K>, Class<V>) - Method in class com.cloudant.client.api.views.ViewRequestBuilder

Create a new builder for a paginated request on the view.

newRequest(Key.Type<K>, Class<V>) - Method in class com.cloudant.client.api.views.ViewRequestBuilder

Create a new builder for an unpaginated request on the view.

next() - Method in class com.cloudant.client.api.Changes

nextPage() - Method in interface com.cloudant.client.api.views.ViewResponse

nin(String, Object...) - Static method in class com.cloudant.client.api.query.Expression

The document field must not exist in the list provided

nin(Object...) - Static method in class com.cloudant.client.api.query.PredicateExpression

The document field must not exist in the list provided

NoDocumentException - Exception in com.cloudant.client.org.lightcouch

Thrown when a requested document is not found.

NoDocumentException(String) - Constructor for exception com.cloudant.client.org.lightcouch.NoDocumentException

nor(Selector...) - Static method in class com.cloudant.client.api.query.Operation

Combine two or more selectors using the "nor" operator

not(Selector) - Static method in class com.cloudant.client.api.query.Operation

Negate the logic of the selector

number(String...) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Add one or more fields containing numerical values to the text index configuration.

NUMBER - Static variable in class com.cloudant.client.api.views.Key.Type

Type constant for numerical keys.

O

Operation - Class in com.cloudant.client.api.query

An Operation allows Expressions or other Operations to be combined using logical operators or negated.

Options() - Constructor for class com.cloudant.client.api.model.DesignDocument.Options

or(Selector...) - Static method in class com.cloudant.client.api.query.Operation

Combine two or more selectors using the "or" operator

P

PaginatedRequestBuilder<K,V> - Interface in com.cloudant.client.api.views

Interface for building a paginated ViewRequest.

parameter(String, String) - Method in class com.cloudant.client.api.Changes

Add a custom query parameter to the _changes request.

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

partialFilterSelector(Selector) - Method in class com.cloudant.client.api.query.JsonIndex.Builder

Configure a selector to choose documents that should be added to the index.

partialFilterSelector(Selector) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Configure a selector to choose documents that should be added to the index.

partition(String) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

A partition key can be specified when querying data so that results can be constrained to a specific database partition.

PartitionedIndexes() - Constructor for class com.cloudant.client.api.model.DbInfo.PartitionedIndexes

partitionInfo(String) - Method in class com.cloudant.client.api.Database

Get information about a partition in this database.

PartitionInfo - Class in com.cloudant.client.api.model

Created by samsmith on 24/01/2019.

PartitionInfo() - Constructor for class com.cloudant.client.api.model.PartitionInfo

PartitionInfo.Sizes - Class in com.cloudant.client.api.model

password(String) - Method in class com.cloudant.client.api.ClientBuilder

Sets the password for the client connection.

Permissions - Enum in com.cloudant.client.api.model

post(Object) - Method in class com.cloudant.client.api.Database

Creates a document in the database using a HTTP POST request.

post(Object, int) - Method in class com.cloudant.client.api.Database

Creates a document in the database similarly to Database.post(Object) but using a specific write quorum.

PreconditionFailedException - Exception in com.cloudant.client.org.lightcouch

CouchDbException class for HTTP 412 precondition failed status codes

PreconditionFailedException(String) - Constructor for exception com.cloudant.client.org.lightcouch.PreconditionFailedException

PredicatedOperation - Class in com.cloudant.client.api.query

A PredicatedOperation allows multiple predicates (such as "equals 5") to be combined.

PredicateExpression - Class in com.cloudant.client.api.query

PredicateExpressions are the same as ordinary Expressions, but instead of taking a field name as one of their arguments, they are combined with a PredicatedOperation.

previousPage() - Method in interface com.cloudant.client.api.views.ViewResponse

Props() - Constructor for class com.cloudant.client.api.model.DbInfo.Props

proxy(String) - Method in class com.cloudant.client.api.Replication

proxy(String) - Method in class com.cloudant.client.api.Replicator

proxyPassword(String) - Method in class com.cloudant.client.api.ClientBuilder

Sets an optional proxy password for the proxy user specified by ClientBuilder.proxyUser(String).

proxyURL(URL) - Method in class com.cloudant.client.api.ClientBuilder

Sets a proxy url for the client connection.

proxyUser(String) - Method in class com.cloudant.client.api.ClientBuilder

Sets an optional proxy username for the client connection.

put(DesignDocument) - Method in class com.cloudant.client.api.DesignDocumentManager

Synchronizes a design document to the Database.

put(DesignDocument...) - Method in class com.cloudant.client.api.DesignDocumentManager

Synchronize multiple design documents with the database.

Q

query(String, Class<T>) - Method in class com.cloudant.client.api.Database

Query documents using an index and a query selector.

query(String, String, Class<T>) - Method in class com.cloudant.client.api.Database

Execute a partitioned query using an index and a query selector.

query(String, Class<T>) - Method in class com.cloudant.client.api.Search

Queries a Search Index and returns ungrouped results.

QueryBuilder - Class in com.cloudant.client.api.query

Helper class for building query selector strings.

QueryBuilder(Selector) - Constructor for class com.cloudant.client.api.query.QueryBuilder

Construct a QueryBuilder object for use with Database.query(String, Class)

queryForStream(String) - Method in class com.cloudant.client.api.Search

Performs a Cloudant Search and returns the result as an InputStream

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.

queryParams(String) - Method in class com.cloudant.client.api.Replication

Specify additional query parameters to be passed to the filter function.

queryParams(Map<String, Object>) - Method in class com.cloudant.client.api.Replication

Specify additional query parameters to be passed to the filter function.

queryParams(String) - Method in class com.cloudant.client.api.Replicator

queryParams(Map<String, Object>) - Method in class com.cloudant.client.api.Replicator

QueryResult<T> - Class in com.cloudant.client.api.query

QueryResult(List<T>, String, ExecutionStats, String) - Constructor for class com.cloudant.client.api.query.QueryResult

querySearchResult(String, Class<T>) - Method in class com.cloudant.client.api.Search

Performs a Cloudant Search and returns the result as an SearchResult

R

ranges(String) - Method in class com.cloudant.client.api.Search

Ranges for faceted searches

readQuorum(Integer) - Method in class com.cloudant.client.api.model.FindByIndexOptions

readQuorum(int) - Method in class com.cloudant.client.api.model.Params

readTimeout(long, TimeUnit) - Method in class com.cloudant.client.api.ClientBuilder

Sets the specified timeout value when reading from a InputStream with an established client connection.

reason - Variable in exception com.cloudant.client.org.lightcouch.CouchDbException

reduce(boolean) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Reduceable

Use the reduce function of the view.

regex(String, String) - Static method in class com.cloudant.client.api.query.Expression

A regular expression pattern to match against the document field.

regex(String) - Static method in class com.cloudant.client.api.query.PredicateExpression

A regular expression pattern to match against the document field.

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 the document from the database with the specified _id and _rev values.

remove(String) - Method in class com.cloudant.client.api.DesignDocumentManager

Removes a design document from the database.

remove(String, String) - Method in class com.cloudant.client.api.DesignDocumentManager

Removes a design document using the id and rev from the database.

remove(DesignDocument) - Method in class com.cloudant.client.api.DesignDocumentManager

Removes a design document using DesignDocument object from the database.

remove() - Method in class com.cloudant.client.api.Replicator

Removes a document from the replicator database.

removeAttachment(Object, String) - Method in class com.cloudant.client.api.Database

Removes an attachment from the specified document.

removeAttachment(String, String, String) - Method in class com.cloudant.client.api.Database

Removes the attachment from a document the specified _id and _rev and attachmentName values.

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

Encapsulates the result of a replication request, along with previous session's 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

Encapsulates the history of a replication session.

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

Encapsulates a _replicator database replication document.

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

RequestBuilder<RB> - Interface in com.cloudant.client.api.views

Parent interface of all types of view request builders.

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

returnThis() - Method in class com.cloudant.client.api.query.JsonIndex.Builder

returnThis() - Method in class com.cloudant.client.api.query.TextIndex.Builder

returnThis() - Method in interface com.cloudant.client.api.views.RequestBuilder

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() - Constructor for class com.cloudant.client.api.model.ChangesResult.Row

rowsPerPage(int) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Paginated

Limits the number of returned rows to the specified number on each page.

S

save(Object) - Method in class com.cloudant.client.api.Database

Saves a document in the database.

save(Object, int) - Method in class com.cloudant.client.api.Database

Saves a document in the database similarly to Database.save(Object) but using a specific write quorum.

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

Creates an attachment from the specified InputStream and a new document with a generated document ID.

saveAttachment(InputStream, String, String, String, String) - Method in class com.cloudant.client.api.Database

Creates or updates an attachment on the given document ID and revision.

schedulerDoc(String) - Method in class com.cloudant.client.api.CloudantClient

Get replication document state for a given replication document ID.

schedulerDocs() - Method in class com.cloudant.client.api.CloudantClient

Lists replication documents.

SchedulerDocsResponse - Class in com.cloudant.client.api.scheduler

SchedulerDocsResponse() - Constructor for class com.cloudant.client.api.scheduler.SchedulerDocsResponse

SchedulerDocsResponse.Doc - Class in com.cloudant.client.api.scheduler

schedulerJobs() - Method in class com.cloudant.client.api.CloudantClient

Lists replication jobs.

SchedulerJobsResponse - Class in com.cloudant.client.api.scheduler

SchedulerJobsResponse() - Constructor for class com.cloudant.client.api.scheduler.SchedulerJobsResponse

SchedulerJobsResponse.History - Class in com.cloudant.client.api.scheduler

SchedulerJobsResponse.Job - Class in com.cloudant.client.api.scheduler

search(String) - Method in class com.cloudant.client.api.Database

Provides access to Cloudant Search APIs.

search(String, String) - Method in class com.cloudant.client.api.Database

Provides access to partitioned 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

Encapsulates search result entries

SearchResult() - Constructor for class com.cloudant.client.api.model.SearchResult

SearchResult.SearchResultGroup - Class in com.cloudant.client.api.model

Encapsulates a SearchResult group.

SearchResult.SearchResultRow - Class in com.cloudant.client.api.model

Encapsulates a SearchResult row.

SearchResultGroup() - Constructor for class com.cloudant.client.api.model.SearchResult.SearchResultGroup

SearchResultRow() - Constructor for class com.cloudant.client.api.model.SearchResult.SearchResultRow

Selector - Interface in com.cloudant.client.api.query

Interface that identifies all Operations and Expressions that can form the basis of a selector.

selector(Selector) - Method in class com.cloudant.client.api.Replicator

serialize(Key.ComplexKey, Type, JsonSerializationContext) - Method in class com.cloudant.client.api.views.Key.ComplexKeyDeserializer

serverVersion() - Method in class com.cloudant.client.api.CloudantClient

Get the reported server version from the welcome message metadata.

setAttachments(Map<String, Attachment>) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setBookmark(String) - Method in class com.cloudant.client.api.model.SearchResult

setBy(String) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroup

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

setDbCopy(String) - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce

Deprecated.

setDoc(T) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRow

setDocIds(String[]) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setFields(T) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRow

setFilter(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setFilters(Map<String, String>) - Method in class com.cloudant.client.api.model.DesignDocument

Define the changes feed filter functions set in this design document.

setFulltext(JsonObject) - Method in class com.cloudant.client.api.model.DesignDocument

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.SearchResultRow

setIndexes(JsonObject) - Method in class com.cloudant.client.api.model.DesignDocument

Set a JSON object defining the indexes of this design document.

setLanguage(String) - Method in class com.cloudant.client.api.model.DesignDocument

Set the language of the design document.

setLists(Map<String, String>) - Method in class com.cloudant.client.api.model.DesignDocument

Set the list functions defined in this design document.

setMap(String) - Method in class com.cloudant.client.api.model.DesignDocument.MapReduce

Set the map function.

setName(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx

setOptions(DesignDocument.Options) - Method in class com.cloudant.client.api.model.DesignDocument

Set design document options.

setOrder(Object[]) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultRow

setPartitioned(boolean) - Method in class com.cloudant.client.api.model.DesignDocument.Options

Set the partitioned option for this design document.

setPermissions(String, EnumSet<Permissions>) - Method in class com.cloudant.client.api.Database

Set permissions for a user/apiKey on this database.

setProxy(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument

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

Set the reduce function.

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

setRetriesPerRequest(Integer) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setRevision(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setRewrites(JsonArray) - Method in class com.cloudant.client.api.model.DesignDocument

Set the array of URL rewriting rules set in the design document's rewrites property.

setRoles(String[]) - Method in class com.cloudant.client.api.model.ReplicatorDocument.UserCtx

setRows(List<SearchResult<T>.SearchResultRow>) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroup

setRows(List<SearchResult<T>.SearchResultRow>) - Method in class com.cloudant.client.api.model.SearchResult

setShows(Map<String, String>) - Method in class com.cloudant.client.api.model.DesignDocument

Set the show functions defined in this design document.

setSinceSeq(Integer) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setSource(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setSourceIamApiKey(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument

SettableViewParameters - Interface in com.cloudant.client.api.views

Describes the parameters that can be set when building view requests.

SettableViewParameters.Common<K,RB extends RequestBuilder> - Interface in com.cloudant.client.api.views

Setters for parameters that are common to all view requests.

SettableViewParameters.Paginated<K,RB extends RequestBuilder> - Interface in com.cloudant.client.api.views

Setters for parameters only available to paginated requests.

SettableViewParameters.Reduceable<K,RB extends RequestBuilder> - Interface in com.cloudant.client.api.views

Setters for parameters applicable to views that have reduce

SettableViewParameters.Unpaginated<K,RB extends RequestBuilder> - Interface in com.cloudant.client.api.views

Setters for parameters only available to unpaginated requests.

setTarget(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setTargetIamApiKey(String) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setTotalRows(Long) - Method in class com.cloudant.client.api.model.SearchResult.SearchResultGroup

setTotalRows(long) - Method in class com.cloudant.client.api.model.SearchResult

setUpdates(Map<String, String>) - Method in class com.cloudant.client.api.model.DesignDocument

Set the update handlers defined in this design document.

setUrl(String) - Method in exception com.cloudant.client.org.lightcouch.CouchDbException

Set the URL that resulted in this exception being thrown.

setUserCtx(ReplicatorDocument.UserCtx) - Method in class com.cloudant.client.api.model.ReplicatorDocument

setValidateDocUpdate(String) - Method in class com.cloudant.client.api.model.DesignDocument

Set the javascript function for the design document's validate_doc_update property.

setViews(Map<String, DesignDocument.MapReduce>) - Method in class com.cloudant.client.api.model.DesignDocument

Set the views defined in this design document's view property.

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

Return only changes after the specified sequence identifier.

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

SingleRequestBuilder<K,V,RB> - Interface in com.cloudant.client.api.views

A request builder for a single request on a view.

size(String, Long) - Static method in class com.cloudant.client.api.query.Expression

Special condition to match the length of an array field in a document.

size(Long) - Static method in class com.cloudant.client.api.query.PredicateExpression

Special condition to match the length of an array field in a document.

Sizes() - Constructor for class com.cloudant.client.api.model.DbInfo.Sizes

Sizes() - Constructor for class com.cloudant.client.api.model.PartitionInfo.Sizes

skip(Integer) - Method in class com.cloudant.client.api.model.FindByIndexOptions

skip(long) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the skip option for the query builder.

skip(long) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Unpaginated

Skips the specified number of rows from the start.

sort(IndexField) - Method in class com.cloudant.client.api.model.FindByIndexOptions

Can be called multiple times to set the sort syntax

sort(Sort...) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the sort option for the query builder.

Sort - Class in com.cloudant.client.api.query

Sort(String, Sort.Order) - Constructor for class com.cloudant.client.api.query.Sort

sort(String) - Method in class com.cloudant.client.api.Search

Specify the sort order for the result.

Sort.Order - Enum in com.cloudant.client.api.query

source(String) - Method in class com.cloudant.client.api.Replication

Specify the name or URL of the database source of the replication.

source(String) - Method in class com.cloudant.client.api.Replicator

sourceIamApiKey(String) - Method in class com.cloudant.client.api.Replication

Sets the IAM API key for the replication source.

sourceIamApiKey(String) - Method in class com.cloudant.client.api.Replicator

stable(boolean) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the stable option for the query builder.

stable(boolean) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Determine whether the view should be returned from a "stable" set of shards.

stale(boolean) - Method in class com.cloudant.client.api.Search

stale(String) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Deprecated.

use SettableViewParameters.Common.stable(boolean) and SettableViewParameters.Common.update(String) instead

STALE_NO - Static variable in interface com.cloudant.client.api.views.SettableViewParameters

Convenience constant defined as null to omit the value for a stale parameter, resulting in the server default case, i.e.

STALE_OK - Static variable in interface com.cloudant.client.api.views.SettableViewParameters

Constant for the value "ok" for use with SettableViewParameters.Common.stale(String)

STALE_UPDATE_AFTER - Static variable in interface com.cloudant.client.api.views.SettableViewParameters

Constant for the value "update_after" for use with SettableViewParameters.Common.stale(String)

startKey(K) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Return records starting with the specified key.

startKeyDocId(String) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Return records starting with the specified document ID.

stop() - Method in class com.cloudant.client.api.Changes

Stops a running continuous feed.

string(String...) - Method in class com.cloudant.client.api.query.TextIndex.Builder

Add one or more fields containing string values to the text index configuration.

STRING - Static variable in class com.cloudant.client.api.views.Key.Type

Type constant for string keys.

style(String) - Method in class com.cloudant.client.api.Changes

Configures how many changes are returned "main_only" for the winning revision only or "all_docs" to also include leaf revisions.

T

target(String) - Method in class com.cloudant.client.api.Replication

Specify the name or URL of the database target of the replication.

target(String) - Method in class com.cloudant.client.api.Replicator

targetIamApiKey(String) - Method in class com.cloudant.client.api.Replication

Sets the IAM API key for the replication target.

targetIamApiKey(String) - Method in class com.cloudant.client.api.Replicator

targetOauth(String, String, String, String) - Method in class com.cloudant.client.api.Replication

Set OAuth 1 authentication credentials for the replication target

Task - Class in com.cloudant.client.api.model

Encapsulates info about Cloudant Server Task

TextIndex - Class in com.cloudant.client.api.query

Class model of a text index definition.

TextIndex.Builder - Class in com.cloudant.client.api.query

Class for building a definition for a text type index.

TextIndex.Field - Class in com.cloudant.client.api.query

Model of a field in the text index including the field name and type.

textIndexes() - Method in class com.cloudant.client.api.query.Indexes

timeout(long) - Method in class com.cloudant.client.api.Changes

Configure a timeout for the changes feed.

toJson() - Method in class com.cloudant.client.api.views.Key.ComplexKey

TooManyRequestsException - Exception in com.cloudant.client.org.lightcouch

CouchDbException class for HTTP 429 too many requests status code

TooManyRequestsException(String) - Constructor for exception com.cloudant.client.org.lightcouch.TooManyRequestsException

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

Deprecated.

toString() - Method in class com.cloudant.client.api.model.IndexField

Deprecated.

toString() - Method in class com.cloudant.client.api.model.Membership

toString() - Method in class com.cloudant.client.api.model.MetaInformation

toString() - Method in class com.cloudant.client.api.model.MetaInformation.Vendor

toString() - Method in class com.cloudant.client.api.model.Params

toString() - Method in class com.cloudant.client.api.model.PartitionInfo

toString() - Method in class com.cloudant.client.api.model.Response

toString() - Method in class com.cloudant.client.api.query.EmptyExpression

toString() - Method in class com.cloudant.client.api.query.ExecutionStats

toString() - Method in class com.cloudant.client.api.query.Expression

toString() - Method in class com.cloudant.client.api.query.Operation

toString() - Method in class com.cloudant.client.api.query.PredicatedOperation

toString() - Method in class com.cloudant.client.api.query.PredicateExpression

toString() - Method in enum com.cloudant.client.api.query.Sort.Order

toString() - Method in class com.cloudant.client.api.query.Sort

toString() - Method in enum com.cloudant.client.api.query.Type

trigger() - Method in class com.cloudant.client.api.Replication

Triggers a replication request, blocks while the replication is in progress.

type(String, Type) - Static method in class com.cloudant.client.api.query.Expression

Check the document field's type and object

type(Type) - Static method in class com.cloudant.client.api.query.PredicateExpression

The field has a given type

Type - Enum in com.cloudant.client.api.query

U

UnpaginatedRequestBuilder<K,V> - Interface in com.cloudant.client.api.views

Interface for building an unpaginated ViewRequest.

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 similarly to Database.update(Object), but specifying the write quorum.

update(boolean) - Method in class com.cloudant.client.api.query.QueryBuilder

Set the update option for the query builder.

update(String) - Method in interface com.cloudant.client.api.views.SettableViewParameters.Common

Determine whether the view in question should be updated prior to or after responding to the user.

UPDATE_FALSE - Static variable in interface com.cloudant.client.api.views.SettableViewParameters

Constant for the value "false" for use with SettableViewParameters.Common.update(String)

UPDATE_LAZY - Static variable in interface com.cloudant.client.api.views.SettableViewParameters

Constant for the value "lazy" for use with SettableViewParameters.Common.update(String)

UPDATE_TRUE - Static variable in interface com.cloudant.client.api.views.SettableViewParameters

Constant for the value "true" for use with SettableViewParameters.Common.update(String)

url(URL) - Static method in class com.cloudant.client.api.ClientBuilder

Constructs a new ClientBuilder for building a CloudantClient instance to connect to the Cloudant server with the specified URL.

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

useIndex(String) - Method in class com.cloudant.client.api.query.QueryBuilder

Instruct a query to use a specific index.

useIndex(String, String) - Method in class com.cloudant.client.api.query.QueryBuilder

Instruct a query to use a specific index.

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

username(String) - Method in class com.cloudant.client.api.ClientBuilder

Sets a username or API key for the client connection.

uuids(long) - Method in class com.cloudant.client.api.CloudantClient

Request a list of generated UUIDs from the Cloudant server.

V

valueOf(String) - Static method in enum com.cloudant.client.api.model.IndexField.SortOrder

Deprecated.

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.

valueOf(String) - Static method in enum com.cloudant.client.api.query.Sort.Order

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.cloudant.client.api.query.Type

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.cloudant.client.api.model.IndexField.SortOrder

Deprecated.

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.

values() - Static method in enum com.cloudant.client.api.query.Sort.Order

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.query.Type

Returns an array containing the constants of this enum type, in the order they are declared.

Vendor(String, String, String) - Constructor for class com.cloudant.client.api.model.MetaInformation.Vendor

ViewMultipleRequest<K,V> - Interface in com.cloudant.client.api.views

A convenience class for performing multiple unpaginated query requests on a single view.

ViewRequest<K,V> - Interface in com.cloudant.client.api.views

Enables retrieving view responses.

ViewRequestBuilder - Class in com.cloudant.client.api.views

Provides methods for obtaining builders for view requests.

ViewRequestBuilder(CloudantClient, Database, String, String) - Constructor for class com.cloudant.client.api.views.ViewRequestBuilder

Create a new ViewRequestBuilder for the specified database, design document and view name.

ViewResponse<K,V> - Interface in com.cloudant.client.api.views

Encapsulates a response from a view request.

ViewResponse.Row<K,V> - Interface in com.cloudant.client.api.views

Encapsulates a single row from the response results array.

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 J K L M N O P Q R S T U V W