Package com.ibm.cloud.cloudant.v1.model

Interface Summary

Interface	Description
ActivityTrackerEvents.Types
Analyzer.Name	Schema for the name of the Apache Lucene analyzer to use for text indexing.
AnalyzerConfiguration.Name	Schema for the name of the Apache Lucene analyzer to use for text indexing.
DbEvent.Type	A database event.
DeleteAttachmentOptions.Batch	Query parameter to specify whether to store in batch mode.
DeleteDesignDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
DeleteDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
DeleteIndexOptions.Type	Path parameter to specify the index type.
DeleteLocalDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
DeleteReplicationDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
DocumentRevisionStatus.Status	Status of the revision.
GeoJsonFeature.Type	Declaration of the GeoJSON type: Feature Object.
GeoJsonGeometry.Type	The type of GeoJSON Geometry.
GeoJsonGeometryCollection.Type	The type of GeoJSON Geometry.
GeoJsonGeometryObject.Type	The type of GeoJSON Geometry.
GeoResult.Type	Declaration of the GeoJSON type: FeatureCollection Object.
GetDbUpdatesOptions.Feed	Query parameter to specify the changes feed type.
GetGeoOptions.Format	Query parameter that causes the geospatial query output to be returned in the specified format.
GetGeoOptions.Relation	Query parameter to specify the DE-9IM (Dimensionally Extended nine-Intersection Model)geospatial relationship between the query geometry and the result documents.
GetGeoOptions.Stale	Query parameter to specify to not wait for the index to finish building before returning results.
GetSchedulerDocsOptions.States	Schema for replication state.
IndexField.Type	The type of the named field.
IndexInformation.Type	Schema for the type of an index.
IndexResult.Result	Flag to show whether the index was created or one already exists.
PostActivityTrackerEventsOptions.Types
PostChangesOptions.Feed	Query parameter to specify the changes feed type.
PostDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
PostExplainOptions.Update	Whether to update the index prior to returning the result.
PostFindOptions.Update	Whether to update the index prior to returning the result.
PostIndexOptions.Type	Schema for the type of an index.
PostPartitionFindOptions.Update	Whether to update the index prior to returning the result.
PostPartitionSearchOptions.Stale	Do not wait for the index to finish building to return results.
PostPartitionViewOptions.Update	Parameter to specify whether or not the view in question should be updated prior to responding to the user.
PostSearchAnalyzeOptions.Analyzer	The analyzer type that is being used at the tokenization.
PostSearchOptions.Stale	Do not wait for the index to finish building to return results.
PostViewOptions.Update	Parameter to specify whether or not the view in question should be updated prior to responding to the user.
PutDesignDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
PutDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
PutLocalDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
PutReplicationDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
SchedulerDocument.State	Schema for replication state.
UpInformation.Status	status.
UserContext.Roles	Schema for a security role.
ViewQuery.Update	Parameter to specify whether or not the view in question should be updated prior to responding to the user.

Class Summary

Class	Description
ActiveTask	Schema for information about a running task.
ActivityTrackerEvents	Schema for Activity Tracker events.
ActivityTrackerEvents.Builder	Builder.
AllDocsQueriesResult	Schema for the result of an all documents queries operation.
AllDocsQuery	Schema for an all documents query operation.
AllDocsQuery.Builder	Builder.
AllDocsResult	Schema for the result of an all documents operation.
Analyzer	Schema for a full text search analyzer.
Analyzer.Builder	Builder.
AnalyzerConfiguration	Schema for a search analyzer configuration.
AnalyzerConfiguration.Builder	Builder.
ApiKeysResult	Schema for api keys.
Attachment	Schema for an attachment.
Attachment.Builder	Builder.
BulkDocs	Schema for submitting documents for bulk modifications.
BulkDocs.Builder	Builder.
BulkGetQueryDocument	Schema for a document item in a bulk get query.
BulkGetQueryDocument.Builder	Builder.
BulkGetResult	Schema for the results object of a bulk get operation.
BulkGetResultDocument	Schema for BulkGetResult object containing a successfully retrieved document or error information.
BulkGetResultItem	Schema for the document revisions information from a bulk get operation.
CapacityThroughputInformation	Schema for information about the currently provisioned and target throughput capacity.
CapacityThroughputInformationCurrent	Detailed information about provisioned throughput capacity.
CapacityThroughputInformationTarget	Detailed information about target throughput capacity.
Change	Schema for a document leaf with single field rev.
ChangesResult	Schema for normal changes feed result.
ChangesResultItem	Schema for an item in the changes results array.
ContentInformationSizes	Schema for size information of content.
CorsInformation	Schema for information about the CORS configuration.
CurrentThroughputInformation	Schema for information about current consumption of a provisioned throughput capacity.
CurrentThroughputInformationThroughput	Detailed information about current consumption.
DatabaseInformation	Schema for information about a database.
DatabaseInformationCluster	Schema for database cluster information.
DatabaseInformationProps	Schema for database properties.
DbEvent	Schema for a database change event.
DbsInfoResult	Schema for database information keyed by database name.
DbUpdates	Schema for database updates.
DeleteAttachmentOptions	The deleteAttachment options.
DeleteAttachmentOptions.Builder	Builder.
DeleteDatabaseOptions	The deleteDatabase options.
DeleteDatabaseOptions.Builder	Builder.
DeleteDesignDocumentOptions	The deleteDesignDocument options.
DeleteDesignDocumentOptions.Builder	Builder.
DeleteDocumentOptions	The deleteDocument options.
DeleteDocumentOptions.Builder	Builder.
DeleteIndexOptions	The deleteIndex options.
DeleteIndexOptions.Builder	Builder.
DeleteLocalDocumentOptions	The deleteLocalDocument options.
DeleteLocalDocumentOptions.Builder	Builder.
DeleteReplicationDocumentOptions	The deleteReplicationDocument options.
DeleteReplicationDocumentOptions.Builder	Builder.
DesignDocument	Schema for a design document.
DesignDocument.Builder	Builder.
DesignDocumentInformation	Schema for information about a design document.
DesignDocumentOptions	Schema for design document options.
DesignDocumentOptions.Builder	Builder.
DesignDocumentViewIndex	View index information.
DesignDocumentViewsMapReduce	Schema for view functions definition.
DesignDocumentViewsMapReduce.Builder	Builder.
DocsResultRow	Schema for a row of document information in a DocsResult.
DocsResultRowValue	Value of built-in `/_all_docs` style view.
Document	Schema for a document.
Document.Builder	Builder.
DocumentResult	Schema for the result of a document modification.
DocumentRevisionStatus	Schema for information about revisions and their status.
DocumentRevisionStatus.Builder	Builder.
DocumentShardInfo	Schema for document shard information.
ExecutionStats	Schema for find query execution statistics.
ExplainResult	Schema for information about the index used for a find query.
ExplainResultRange	range.
FindResult	Schema for the result of a query find operation.
GeoIndexDefinition	Schema for a geospatial index definition.
GeoIndexDefinition.Builder	Builder.
GeoIndexInformation	Schema for information about a geospatial index.
GeoIndexStats	Schema for geospatial index statistics.
GeoJsonFeature	Schema for a GeoJSON feature object.
GeoJsonGeometry	Schema for a GeoJSON geometry.
GeoJsonGeometryCollection	Schema for a GeoJSON GeometryCollection type geometry.
GeoJsonGeometryObject	Schema for a GeoJSON geometry object.
GeoResult	Schema for the result of a geospatial query operation.
GeoResultRow	Schema for a row of a geospatial result using view format.
GetActiveTasksOptions	The getActiveTasks options.
GetActivityTrackerEventsOptions	The getActivityTrackerEvents options.
GetAllDbsOptions	The getAllDbs options.
GetAllDbsOptions.Builder	Builder.
GetAttachmentOptions	The getAttachment options.
GetAttachmentOptions.Builder	Builder.
GetCapacityThroughputInformationOptions	The getCapacityThroughputInformation options.
GetCorsInformationOptions	The getCorsInformation options.
GetCurrentThroughputInformationOptions	The getCurrentThroughputInformation options.
GetDatabaseInformationOptions	The getDatabaseInformation options.
GetDatabaseInformationOptions.Builder	Builder.
GetDbUpdatesOptions	The getDbUpdates options.
GetDbUpdatesOptions.Builder	Builder.
GetDesignDocumentInformationOptions	The getDesignDocumentInformation options.
GetDesignDocumentInformationOptions.Builder	Builder.
GetDesignDocumentOptions	The getDesignDocument options.
GetDesignDocumentOptions.Builder	Builder.
GetDocumentOptions	The getDocument options.
GetDocumentOptions.Builder	Builder.
GetDocumentShardsInfoOptions	The getDocumentShardsInfo options.
GetDocumentShardsInfoOptions.Builder	Builder.
GetGeoIndexInformationOptions	The getGeoIndexInformation options.
GetGeoIndexInformationOptions.Builder	Builder.
GetGeoOptions	The getGeo options.
GetGeoOptions.Builder	Builder.
GetIndexesInformationOptions	The getIndexesInformation options.
GetIndexesInformationOptions.Builder	Builder.
GetLocalDocumentOptions	The getLocalDocument options.
GetLocalDocumentOptions.Builder	Builder.
GetMembershipInformationOptions	The getMembershipInformation options.
GetPartitionInformationOptions	The getPartitionInformation options.
GetPartitionInformationOptions.Builder	Builder.
GetReplicationDocumentOptions	The getReplicationDocument options.
GetReplicationDocumentOptions.Builder	Builder.
GetSchedulerDocsOptions	The getSchedulerDocs options.
GetSchedulerDocsOptions.Builder	Builder.
GetSchedulerDocumentOptions	The getSchedulerDocument options.
GetSchedulerDocumentOptions.Builder	Builder.
GetSchedulerJobOptions	The getSchedulerJob options.
GetSchedulerJobOptions.Builder	Builder.
GetSchedulerJobsOptions	The getSchedulerJobs options.
GetSchedulerJobsOptions.Builder	Builder.
GetSearchInfoOptions	The getSearchInfo options.
GetSearchInfoOptions.Builder	Builder.
GetSecurityOptions	The getSecurity options.
GetSecurityOptions.Builder	Builder.
GetServerInformationOptions	The getServerInformation options.
GetSessionInformationOptions	The getSessionInformation options.
GetShardsInformationOptions	The getShardsInformation options.
GetShardsInformationOptions.Builder	Builder.
GetUpInformationOptions	The getUpInformation options.
GetUuidsOptions	The getUuids options.
GetUuidsOptions.Builder	Builder.
HeadAttachmentOptions	The headAttachment options.
HeadAttachmentOptions.Builder	Builder.
HeadDatabaseOptions	The headDatabase options.
HeadDatabaseOptions.Builder	Builder.
HeadDesignDocumentOptions	The headDesignDocument options.
HeadDesignDocumentOptions.Builder	Builder.
HeadDocumentOptions	The headDocument options.
HeadDocumentOptions.Builder	Builder.
HeadLocalDocumentOptions	The headLocalDocument options.
HeadLocalDocumentOptions.Builder	Builder.
HeadReplicationDocumentOptions	The headReplicationDocument options.
HeadReplicationDocumentOptions.Builder	Builder.
HeadSchedulerDocumentOptions	The headSchedulerDocument options.
HeadSchedulerDocumentOptions.Builder	Builder.
HeadSchedulerJobOptions	The headSchedulerJob options.
HeadSchedulerJobOptions.Builder	Builder.
HeadUpInformationOptions	The headUpInformation options.
IndexDefinition	Schema for a `json` or `text` query index definition.
IndexDefinition.Builder	Builder.
IndexesInformation	Schema for information about the indexes in a database.
IndexField	Schema for indexed fields for use with declarative JSON query.
IndexField.Builder	Builder.
IndexInformation	Schema for information about an index.
IndexResult	Schema for the result of creating an index.
IndexTextOperatorDefaultField	Schema for the text index default field configuration.
IndexTextOperatorDefaultField.Builder	Builder.
MembershipInformation	Schema for information about known nodes and cluster membership.
Ok	Schema for an OK result.
PartitionInformation	Schema for information about a database partition.
PartitionInformationIndexes	Schema for information about the partition index count and limit in a database.
PartitionInformationIndexesIndexes	The count breakdown of partitioned indexes.
PartitionInformationSizes	The size of active and external data, in bytes.
PostActivityTrackerEventsOptions	The postActivityTrackerEvents options.
PostActivityTrackerEventsOptions.Builder	Builder.
PostAllDocsOptions	The postAllDocs options.
PostAllDocsOptions.Builder	Builder.
PostAllDocsQueriesOptions	The postAllDocsQueries options.
PostAllDocsQueriesOptions.Builder	Builder.
PostApiKeysOptions	The postApiKeys options.
PostBulkDocsOptions	The postBulkDocs options.
PostBulkDocsOptions.Builder	Builder.
PostBulkGetOptions	The postBulkGet options.
PostBulkGetOptions.Builder	Builder.
PostChangesOptions	The postChanges options.
PostChangesOptions.Builder	Builder.
PostDbsInfoOptions	The postDbsInfo options.
PostDbsInfoOptions.Builder	Builder.
PostDesignDocsOptions	The postDesignDocs options.
PostDesignDocsOptions.Builder	Builder.
PostDesignDocsQueriesOptions	The postDesignDocsQueries options.
PostDesignDocsQueriesOptions.Builder	Builder.
PostDocumentOptions	The postDocument options.
PostDocumentOptions.Builder	Builder.
PostExplainOptions	The postExplain options.
PostExplainOptions.Builder	Builder.
PostFindOptions	The postFind options.
PostFindOptions.Builder	Builder.
PostGeoCleanupOptions	The postGeoCleanup options.
PostGeoCleanupOptions.Builder	Builder.
PostIndexOptions	The postIndex options.
PostIndexOptions.Builder	Builder.
PostPartitionAllDocsOptions	The postPartitionAllDocs options.
PostPartitionAllDocsOptions.Builder	Builder.
PostPartitionFindOptions	The postPartitionFind options.
PostPartitionFindOptions.Builder	Builder.
PostPartitionSearchOptions	The postPartitionSearch options.
PostPartitionSearchOptions.Builder	Builder.
PostPartitionViewOptions	The postPartitionView options.
PostPartitionViewOptions.Builder	Builder.
PostRevsDiffOptions	The postRevsDiff options.
PostRevsDiffOptions.Builder	Builder.
PostSearchAnalyzeOptions	The postSearchAnalyze options.
PostSearchAnalyzeOptions.Builder	Builder.
PostSearchOptions	The postSearch options.
PostSearchOptions.Builder	Builder.
PostViewOptions	The postView options.
PostViewOptions.Builder	Builder.
PostViewQueriesOptions	The postViewQueries options.
PostViewQueriesOptions.Builder	Builder.
PutAttachmentOptions	The putAttachment options.
PutAttachmentOptions.Builder	Builder.
PutCapacityThroughputConfigurationOptions	The putCapacityThroughputConfiguration options.
PutCapacityThroughputConfigurationOptions.Builder	Builder.
PutCloudantSecurityConfigurationOptions	The putCloudantSecurityConfiguration options.
PutCloudantSecurityConfigurationOptions.Builder	Builder.
PutCorsConfigurationOptions	The putCorsConfiguration options.
PutCorsConfigurationOptions.Builder	Builder.
PutDatabaseOptions	The putDatabase options.
PutDatabaseOptions.Builder	Builder.
PutDesignDocumentOptions	The putDesignDocument options.
PutDesignDocumentOptions.Builder	Builder.
PutDocumentOptions	The putDocument options.
PutDocumentOptions.Builder	Builder.
PutLocalDocumentOptions	The putLocalDocument options.
PutLocalDocumentOptions.Builder	Builder.
PutReplicationDocumentOptions	The putReplicationDocument options.
PutReplicationDocumentOptions.Builder	Builder.
PutSecurityOptions	The putSecurity options.
PutSecurityOptions.Builder	Builder.
ReplicationCreateTargetParameters	Request parameters to use during target database creation.
ReplicationCreateTargetParameters.Builder	Builder.
ReplicationDatabase	Schema for a replication source or target database.
ReplicationDatabase.Builder	Builder.
ReplicationDatabaseAuth	Schema for replication source or target database authentication.
ReplicationDatabaseAuth.Builder	Builder.
ReplicationDatabaseAuthBasic	Schema for basic authentication of replication source or target database.
ReplicationDatabaseAuthBasic.Builder	Builder.
ReplicationDatabaseAuthIam	Schema for an IAM API key for replication database authentication.
ReplicationDatabaseAuthIam.Builder	Builder.
ReplicationDocument	Schema for a replication document.
ReplicationDocument.Builder	Builder.
Revisions	Schema for list of revision information.
Revisions.Builder	Builder.
RevsDiff	Schema for information about missing revs and possible ancestors.
SchedulerDocsResult	Schema for a listing of replication scheduler documents.
SchedulerDocument	Schema for a replication scheduler document.
SchedulerInfo	Schema for scheduler document information.
SchedulerJob	Schema for a replication scheduler job.
SchedulerJobEvent	Schema for a replication scheduler job event.
SchedulerJobsResult	Schema for a listing of replication scheduler jobs.
SearchAnalyzeResult	Schema for the output of testing search analyzer tokenization.
SearchIndexDefinition	Schema for a search index definition.
SearchIndexDefinition.Builder	Builder.
SearchIndexInfo	Schema for metadata information about a search index.
SearchInfoResult	Schema for search index information.
SearchResult	Schema for the result of a query search operation.
SearchResultProperties	Schema for the result of a query search operation.
SearchResultRow	Schema for a row of the result of a query search operation.
Security	Schema for a security document.
Security.Builder	Builder.
SecurityObject	Schema for names and roles to map to a database permission.
SecurityObject.Builder	Builder.
ServerInformation	Schema for information about the server instance.
ServerVendor	Schema for server vendor information.
SessionAuthentication	Schema for session authentication information.
SessionInformation	Schema for information about a session.
ShardsInformation	Schema for a shards object that maps the hash value range for each shard to the array of nodes that contain a copy of that shard.
ThroughputInformation	Schema for detailed information about throughput capacity with breakdown by specific throughput requests classes.
UpInformation	Schema for information about the up state of the server.
UserContext	Schema for the user context of a session.
UserContext.Builder	Builder.
UuidsResult	Schema for a set of uuids generated by the server.
ViewQueriesResult	Schema for the results of a queries view operation.
ViewQuery	Schema for a query view operation.
ViewQuery.Builder	Builder.
ViewResult	Schema for the result of a query view operation.
ViewResultRow	Schema for a row of a view result.