Package com.ibm.cloud.cloudant.v1

Class Cloudant

java.lang.Object
com.ibm.cloud.sdk.core.service.BaseService
com.ibm.cloud.cloudant.internal.CloudantBaseService
com.ibm.cloud.cloudant.v1.Cloudant
public class Cloudant extends CloudantBaseService
NoSQL database based on Apache CouchDB. See: https://cloud.ibm.com/docs/services/Cloudant/

  • Field Details

    • DEFAULT_SERVICE_NAME

      public static final String DEFAULT_SERVICE_NAME
      Default service name used when configuring the `Cloudant` client.
      See Also:

    • DEFAULT_SERVICE_URL

      public static final String DEFAULT_SERVICE_URL
      Default service endpoint URL.
      See Also:

  • Constructor Details

    • Cloudant

      public Cloudant(String serviceName, Authenticator authenticator)
      Constructs an instance of the `Cloudant` client. The specified service name and authenticator are used to configure the client instance.
      Parameters:
      serviceName - the service name to be used when configuring the client instance
      authenticator - the Authenticator instance to be configured for this client

  • Method Details

    • newInstance

      public static Cloudant newInstance()
      Class method which constructs an instance of the `Cloudant` client. The default service name is used to configure the client instance.
      Returns:
      an instance of the `Cloudant` client using external configuration

    • newInstance

      public static Cloudant newInstance(String serviceName)
      Class method which constructs an instance of the `Cloudant` client. The specified service name is used to configure the client instance.
      Parameters:
      serviceName - the service name to be used when configuring the client instance
      Returns:
      an instance of the `Cloudant` client using external configuration

    • getServerInformation

      public ServiceCall<ServerInformation> getServerInformation(GetServerInformationOptions getServerInformationOptions)
      Retrieve server instance information. When you access the root of an instance, IBM Cloudant returns meta-information about the instance. The response includes a JSON structure that contains information about the server, including a welcome message and the server's version. **Tip:** The authentication for this endpoint is only enforced when using IAM.
      Parameters:
      getServerInformationOptions - the GetServerInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ServerInformation

    • getServerInformation

      public ServiceCall<ServerInformation> getServerInformation()
      Retrieve server instance information. When you access the root of an instance, IBM Cloudant returns meta-information about the instance. The response includes a JSON structure that contains information about the server, including a welcome message and the server's version. **Tip:** The authentication for this endpoint is only enforced when using IAM.
      Returns:
      a ServiceCall with a result of type ServerInformation

    • getUuids

      public ServiceCall<UuidsResult> getUuids(GetUuidsOptions getUuidsOptions)
      Retrieve one or more UUIDs. Requests one or more Universally Unique Identifiers (UUIDs) from the instance. The response is a JSON object that provides a list of UUIDs. **Tip:** The authentication for this endpoint is only enforced when using IAM.
      Parameters:
      getUuidsOptions - the GetUuidsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type UuidsResult

    • getUuids

      public ServiceCall<UuidsResult> getUuids()
      Retrieve one or more UUIDs. Requests one or more Universally Unique Identifiers (UUIDs) from the instance. The response is a JSON object that provides a list of UUIDs. **Tip:** The authentication for this endpoint is only enforced when using IAM.
      Returns:
      a ServiceCall with a result of type UuidsResult

    • getCapacityThroughputInformation

      public ServiceCall<CapacityThroughputInformation> getCapacityThroughputInformation(GetCapacityThroughputInformationOptions getCapacityThroughputInformationOptions)
      Retrieve provisioned throughput capacity information. View the amount of provisioned throughput capacity that is allocated to an IBM Cloudant instance and what is the target provisioned throughput capacity.
      Parameters:
      getCapacityThroughputInformationOptions - the GetCapacityThroughputInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type CapacityThroughputInformation

    • getCapacityThroughputInformation

      public ServiceCall<CapacityThroughputInformation> getCapacityThroughputInformation()
      Retrieve provisioned throughput capacity information. View the amount of provisioned throughput capacity that is allocated to an IBM Cloudant instance and what is the target provisioned throughput capacity.
      Returns:
      a ServiceCall with a result of type CapacityThroughputInformation

    • putCapacityThroughputConfiguration

      public ServiceCall<CapacityThroughputInformation> putCapacityThroughputConfiguration(PutCapacityThroughputConfigurationOptions putCapacityThroughputConfigurationOptions)
      Update the target provisioned throughput capacity. Sets the target provisioned throughput capacity for an IBM Cloudant instance. When target capacity is changed, the current capacity asynchronously changes to meet the target capacity.
      Parameters:
      putCapacityThroughputConfigurationOptions - the PutCapacityThroughputConfigurationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type CapacityThroughputInformation

    • getDbUpdates

      @Deprecated public ServiceCall<DbUpdates> getDbUpdates(GetDbUpdatesOptions getDbUpdatesOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      Retrieve change events for all databases. **This endpoint is not available in IBM Cloudant.** Lists changes to databases, like a global changes feed. Types of changes include updating the database and creating or deleting a database. Like the changes feed, the feed is not guaranteed to return changes in the correct order and might repeat changes. Polling modes for this method work like polling modes for the changes feed.
      Parameters:
      getDbUpdatesOptions - the GetDbUpdatesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DbUpdates

    • getDbUpdates

      @Deprecated public ServiceCall<DbUpdates> getDbUpdates()
      Deprecated.
      this method is deprecated and may be removed in a future release
      Retrieve change events for all databases. **This endpoint is not available in IBM Cloudant.** Lists changes to databases, like a global changes feed. Types of changes include updating the database and creating or deleting a database. Like the changes feed, the feed is not guaranteed to return changes in the correct order and might repeat changes. Polling modes for this method work like polling modes for the changes feed.
      Returns:
      a ServiceCall with a result of type DbUpdates

    • postChanges

      public ServiceCall<ChangesResult> postChanges(PostChangesOptions postChangesOptions)
      Query the database document changes feed. Requests the database changes feed in the same way as `GET /{db}/_changes` does. It is widely used with the `filter` query parameter because it allows one to pass more information to the filter. ### Note Before using the changes feed read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-faq-using-changes-feed) to understand the limitations and appropriate use cases. If you need to pass parameters to dynamically change the filtered content use the `_selector` filter type for better performance and compatibility. The SDKs have full support for change requests using selector filters, but don't support passing parameters to design document filters.
      Parameters:
      postChangesOptions - the PostChangesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ChangesResult

    • postChangesAsStream

      public ServiceCall<InputStream> postChangesAsStream(PostChangesOptions postChangesOptions)
      Query the database document changes feed as stream. Requests the database changes feed in the same way as `GET /{db}/_changes` does. It is widely used with the `filter` query parameter because it allows one to pass more information to the filter. ### Note Before using the changes feed read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-faq-using-changes-feed) to understand the limitations and appropriate use cases. If you need to pass parameters to dynamically change the filtered content use the `_selector` filter type for better performance and compatibility. The SDKs have full support for change requests using selector filters, but don't support passing parameters to design document filters.
      Parameters:
      postChangesOptions - the PostChangesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • headDatabase

      public ServiceCall<Void> headDatabase(HeadDatabaseOptions headDatabaseOptions)
      Retrieve the HTTP headers for a database. Returns the HTTP headers that contain a minimal amount of information about the specified database. Since the response body is empty, using the HEAD method is a lightweight way to check if the database exists or not.
      Parameters:
      headDatabaseOptions - the HeadDatabaseOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getAllDbs

      public ServiceCall<List<String>> getAllDbs(GetAllDbsOptions getAllDbsOptions)
      Query a list of all database names in the instance. Query to retrieve a list of database names from the instance.
      Parameters:
      getAllDbsOptions - the GetAllDbsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type List

    • getAllDbs

      public ServiceCall<List<String>> getAllDbs()
      Query a list of all database names in the instance. Query to retrieve a list of database names from the instance.
      Returns:
      a ServiceCall with a result of type List

    • postDbsInfo

      public ServiceCall<List<DbsInfoResult>> postDbsInfo(PostDbsInfoOptions postDbsInfoOptions)
      Query information about multiple databases. This operation enables you to request information about multiple databases in a single request, instead of issuing multiple `GET /{db}` requests. It returns a list that contains an information object for each database specified in the request.
      Parameters:
      postDbsInfoOptions - the PostDbsInfoOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type List

    • deleteDatabase

      public ServiceCall<Ok> deleteDatabase(DeleteDatabaseOptions deleteDatabaseOptions)
      Delete a database. Deletes the specified database and all documents and attachments contained within it. To avoid deleting a database, the server responds with a 400 HTTP status code when the request URL includes a `?rev=` parameter. This response suggests that a user wanted to delete a document but forgot to add the document ID to the URL.
      Parameters:
      deleteDatabaseOptions - the DeleteDatabaseOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Ok

    • getDatabaseInformation

      public ServiceCall<DatabaseInformation> getDatabaseInformation(GetDatabaseInformationOptions getDatabaseInformationOptions)
      Retrieve information about a database. Retrieve detailed information about the database.
      Parameters:
      getDatabaseInformationOptions - the GetDatabaseInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DatabaseInformation

    • putDatabase

      public ServiceCall<Ok> putDatabase(PutDatabaseOptions putDatabaseOptions)
      Create a database. Create a new database with the requested properties.
      Parameters:
      putDatabaseOptions - the PutDatabaseOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Ok

    • headDocument

      public ServiceCall<Void> headDocument(HeadDocumentOptions headDocumentOptions)
      Retrieve the HTTP headers for the document. This method supports the same query arguments as the `GET /{db}/{docid}` method, but only the header information (including document size and the revision as an ETag) is returned. The ETag header shows the current revision for the requested document, and the Content-Length specifies the length of the data if the document was requested in full. Add any of the query arguments, then the resulting HTTP headers that correspond to it are returned.
      Parameters:
      headDocumentOptions - the HeadDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • postDocument

      public ServiceCall<DocumentResult> postDocument(PostDocumentOptions postDocumentOptions)
      Create or modify a document in a database. Creates or modifies a document in the specified database by using the supplied JSON document. For creation, you may specify the document ID but you should not specify the revision. If you don't specify the document ID, then the server generates an ID for your document. For modification, you must specify the document ID and a revision identifier in the JSON document. If your document ID includes the `_local/` or `_design/` prefix, then this operation creates or modifies a local or a design document respectively.
      Parameters:
      postDocumentOptions - the PostDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • postAllDocs

      public ServiceCall<AllDocsResult> postAllDocs(PostAllDocsOptions postAllDocsOptions)
      Query a list of all documents in a database. Queries the primary index (all document IDs). The results that match the request body parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all documents in the database are returned. Optionally, document content or additional metadata can be included in the response.
      Parameters:
      postAllDocsOptions - the PostAllDocsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AllDocsResult

    • postAllDocsAsStream

      public ServiceCall<InputStream> postAllDocsAsStream(PostAllDocsOptions postAllDocsOptions)
      Query a list of all documents in a database as stream. Queries the primary index (all document IDs). The results that match the request body parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all documents in the database are returned. Optionally, document content or additional metadata can be included in the response.
      Parameters:
      postAllDocsOptions - the PostAllDocsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postAllDocsQueries

      public ServiceCall<AllDocsQueriesResult> postAllDocsQueries(PostAllDocsQueriesOptions postAllDocsQueriesOptions)
      Multi-query the list of all documents in a database. Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of result objects, one for each query, with a structure equivalent to that of a single `_all_docs` request. This enables you to request multiple queries in a single request, in place of multiple `POST /{db}/_all_docs` requests.
      Parameters:
      postAllDocsQueriesOptions - the PostAllDocsQueriesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AllDocsQueriesResult

    • postAllDocsQueriesAsStream

      public ServiceCall<InputStream> postAllDocsQueriesAsStream(PostAllDocsQueriesOptions postAllDocsQueriesOptions)
      Multi-query the list of all documents in a database as stream. Runs multiple queries using the primary index (all document IDs). Returns a JSON object that contains a list of result objects, one for each query, with a structure equivalent to that of a single `_all_docs` request. This enables you to request multiple queries in a single request, in place of multiple `POST /{db}/_all_docs` requests.
      Parameters:
      postAllDocsQueriesOptions - the PostAllDocsQueriesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postBulkDocs

      public ServiceCall<List<DocumentResult>> postBulkDocs(PostBulkDocsOptions postBulkDocsOptions)
      Bulk modify multiple documents in a database. The bulk document API allows you to create, update, and delete multiple documents at the same time within a single request. The basic operation is similar to creating, updating, or deleting a single document, except that you batch the document structure and information.
      Parameters:
      postBulkDocsOptions - the PostBulkDocsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type List

    • postBulkGet

      public ServiceCall<BulkGetResult> postBulkGet(PostBulkGetOptions postBulkGetOptions)
      Bulk query revision information for multiple documents. Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.
      Parameters:
      postBulkGetOptions - the PostBulkGetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BulkGetResult

    • postBulkGetAsMixed

      public ServiceCall<InputStream> postBulkGetAsMixed(PostBulkGetOptions postBulkGetOptions)
      Bulk query revision information for multiple documents as mixed. Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.
      Parameters:
      postBulkGetOptions - the PostBulkGetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postBulkGetAsRelated

      public ServiceCall<InputStream> postBulkGetAsRelated(PostBulkGetOptions postBulkGetOptions)
      Bulk query revision information for multiple documents as related. Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.
      Parameters:
      postBulkGetOptions - the PostBulkGetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postBulkGetAsStream

      public ServiceCall<InputStream> postBulkGetAsStream(PostBulkGetOptions postBulkGetOptions)
      Bulk query revision information for multiple documents as stream. Fetch specific revisions or revision histories for multiple documents in bulk as replicators do.
      Parameters:
      postBulkGetOptions - the PostBulkGetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • deleteDocument

      public ServiceCall<DocumentResult> deleteDocument(DeleteDocumentOptions deleteDocumentOptions)
      Delete a document. Marks the specified document as deleted by adding a `_deleted` field with the value `true`. Documents with this field are not returned within requests anymore but stay in the database. You must supply the current (latest) revision, either by using the `rev` parameter or by using the `If-Match` header to specify the revision.
      Parameters:
      deleteDocumentOptions - the DeleteDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • getDocument

      public ServiceCall<Document> getDocument(GetDocumentOptions getDocumentOptions)
      Retrieve a document. Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.
      Parameters:
      getDocumentOptions - the GetDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Document

    • getDocumentAsMixed

      public ServiceCall<InputStream> getDocumentAsMixed(GetDocumentOptions getDocumentOptions)
      Retrieve a document as mixed. Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.
      Parameters:
      getDocumentOptions - the GetDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • getDocumentAsRelated

      public ServiceCall<InputStream> getDocumentAsRelated(GetDocumentOptions getDocumentOptions)
      Retrieve a document as related. Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.
      Parameters:
      getDocumentOptions - the GetDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • getDocumentAsStream

      public ServiceCall<InputStream> getDocumentAsStream(GetDocumentOptions getDocumentOptions)
      Retrieve a document as stream. Returns document with the specified `doc_id` from the specified database. Unless you request a specific revision, the latest revision of the document is always returned.
      Parameters:
      getDocumentOptions - the GetDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • putDocument

      public ServiceCall<DocumentResult> putDocument(PutDocumentOptions putDocumentOptions)
      Create or modify a document. Creates or modifies a document in the specified database. For creation, you must specify the document ID but you should not specify the revision. For modification, you must specify the document ID and a revision identifier.
      Parameters:
      putDocumentOptions - the PutDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • headDesignDocument

      public ServiceCall<Void> headDesignDocument(HeadDesignDocumentOptions headDesignDocumentOptions)
      Retrieve the HTTP headers for a design document. This method supports the same query arguments as the `GET /{db}/_design/{ddoc}` method, but the results include only the header information (including design document size, and the revision as an ETag). The ETag header shows the current revision for the requested design document, and if you requested the design document in full, the Content-Length specifies the length of the data. If you add any of the query arguments, then the resulting HTTP headers correspond to what is returned for the equivalent GET request.
      Parameters:
      headDesignDocumentOptions - the HeadDesignDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • deleteDesignDocument

      public ServiceCall<DocumentResult> deleteDesignDocument(DeleteDesignDocumentOptions deleteDesignDocumentOptions)
      Delete a design document. Marks the specified design document as deleted by adding a `_deleted` field with the value `true`. Documents with this field are not returned with requests but stay in the database. You must supply the current (latest) revision, either by using the `rev` parameter or by using the `If-Match` header to specify the revision.
      Parameters:
      deleteDesignDocumentOptions - the DeleteDesignDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • getDesignDocument

      public ServiceCall<DesignDocument> getDesignDocument(GetDesignDocumentOptions getDesignDocumentOptions)
      Retrieve a design document. Returns design document with the specified `doc_id` from the specified database. Unless you request a specific revision, the current revision of the design document is always returned.
      Parameters:
      getDesignDocumentOptions - the GetDesignDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DesignDocument

    • putDesignDocument

      public ServiceCall<DocumentResult> putDesignDocument(PutDesignDocumentOptions putDesignDocumentOptions)
      Create or modify a design document. The PUT method creates a new named design document, or creates a new revision of the existing design document.
      Parameters:
      putDesignDocumentOptions - the PutDesignDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • getDesignDocumentInformation

      public ServiceCall<DesignDocumentInformation> getDesignDocumentInformation(GetDesignDocumentInformationOptions getDesignDocumentInformationOptions)
      Retrieve information about a design document. Retrieves information about the specified design document, including the index, index size, and current status of the design document and associated index information.
      Parameters:
      getDesignDocumentInformationOptions - the GetDesignDocumentInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DesignDocumentInformation

    • postDesignDocs

      public ServiceCall<AllDocsResult> postDesignDocs(PostDesignDocsOptions postDesignDocsOptions)
      Query a list of all design documents in a database. Queries the index of all design document IDs. The results matching the request body parameters are returned in a JSON object, including a list of matching design documents with basic contents, such as the ID and revision. When no request body parameters are specified, results for all design documents in the database are returned. Optionally, the design document content or additional metadata can be included in the response.
      Parameters:
      postDesignDocsOptions - the PostDesignDocsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AllDocsResult

    • postDesignDocsQueries

      public ServiceCall<AllDocsQueriesResult> postDesignDocsQueries(PostDesignDocsQueriesOptions postDesignDocsQueriesOptions)
      Multi-query the list of all design documents. This operation runs multiple view queries of all design documents in the database. This operation enables you to request numerous queries in a single request, in place of multiple POST `/{db}/_design_docs` requests.
      Parameters:
      postDesignDocsQueriesOptions - the PostDesignDocsQueriesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AllDocsQueriesResult

    • postView

      public ServiceCall<ViewResult> postView(PostViewOptions postViewOptions)
      Query a MapReduce view. This operation queries the specified MapReduce view of the specified design document. By default, the map and reduce functions of the view are run to update the view before returning the response. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.
      Parameters:
      postViewOptions - the PostViewOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ViewResult

    • postViewAsStream

      public ServiceCall<InputStream> postViewAsStream(PostViewOptions postViewOptions)
      Query a MapReduce view as stream. This operation queries the specified MapReduce view of the specified design document. By default, the map and reduce functions of the view are run to update the view before returning the response. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.
      Parameters:
      postViewOptions - the PostViewOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postViewQueries

      public ServiceCall<ViewQueriesResult> postViewQueries(PostViewQueriesOptions postViewQueriesOptions)
      Multi-query a MapReduce view. This operation runs multiple specified view queries against the view function from the specified design document.
      Parameters:
      postViewQueriesOptions - the PostViewQueriesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ViewQueriesResult

    • postViewQueriesAsStream

      public ServiceCall<InputStream> postViewQueriesAsStream(PostViewQueriesOptions postViewQueriesOptions)
      Multi-query a MapReduce view as stream. This operation runs multiple specified view queries against the view function from the specified design document.
      Parameters:
      postViewQueriesOptions - the PostViewQueriesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • getPartitionInformation

      public ServiceCall<PartitionInformation> getPartitionInformation(GetPartitionInformationOptions getPartitionInformationOptions)
      Retrieve information about a database partition. Given a partition key, return the database name, sizes, partition, doc count, and doc delete count.
      Parameters:
      getPartitionInformationOptions - the GetPartitionInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PartitionInformation

    • postPartitionAllDocs

      public ServiceCall<AllDocsResult> postPartitionAllDocs(PostPartitionAllDocsOptions postPartitionAllDocsOptions)
      Query a list of all documents in a database partition. Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no query parameters are specified, results for all documents in the database partition are returned. Optionally, document content or additional metadata can be included in the response.
      Parameters:
      postPartitionAllDocsOptions - the PostPartitionAllDocsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AllDocsResult

    • postPartitionAllDocsAsStream

      public ServiceCall<InputStream> postPartitionAllDocsAsStream(PostPartitionAllDocsOptions postPartitionAllDocsOptions)
      Query a list of all documents in a database partition as stream. Queries the primary index (all document IDs). The results that match the query parameters are returned in a JSON object, including a list of matching documents with basic contents, such as the ID and revision. When no query parameters are specified, results for all documents in the database partition are returned. Optionally, document content or additional metadata can be included in the response.
      Parameters:
      postPartitionAllDocsOptions - the PostPartitionAllDocsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postPartitionSearch

      public ServiceCall<SearchResult> postPartitionSearch(PostPartitionSearchOptions postPartitionSearchOptions)
      Query a database partition search index. Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce views. The index function decides what data to index and store in the index. Before using read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partition-querying) to understand the limitations and appropriate use cases.
      Parameters:
      postPartitionSearchOptions - the PostPartitionSearchOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SearchResult

    • postPartitionSearchAsStream

      public ServiceCall<InputStream> postPartitionSearchAsStream(PostPartitionSearchOptions postPartitionSearchOptions)
      Query a database partition search index as stream. Partitioned Search indexes, which are defined in design documents, allow partition databases to be queried by using Lucene Query Parser Syntax. Search indexes are defined by an index function, similar to a map function in MapReduce views. The index function decides what data to index and store in the index. Before using read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partition-querying) to understand the limitations and appropriate use cases.
      Parameters:
      postPartitionSearchOptions - the PostPartitionSearchOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postPartitionView

      public ServiceCall<ViewResult> postPartitionView(PostPartitionViewOptions postPartitionViewOptions)
      Query a database partition MapReduce view function. Runs the specified view function from the specified design document. Unlike `GET /{db}/_design/{ddoc}/_view/{view}` for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view results. The remainder of the POST view functionality is identical to the `GET /{db}/_design/{ddoc}/_view/{view}` API. Before using read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partition-querying) to understand the limitations and appropriate use cases.
      Parameters:
      postPartitionViewOptions - the PostPartitionViewOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ViewResult

    • postPartitionViewAsStream

      public ServiceCall<InputStream> postPartitionViewAsStream(PostPartitionViewOptions postPartitionViewOptions)
      Query a database partition MapReduce view function as stream. Runs the specified view function from the specified design document. Unlike `GET /{db}/_design/{ddoc}/_view/{view}` for accessing views, the POST method supports the specification of explicit keys to be retrieved from the view results. The remainder of the POST view functionality is identical to the `GET /{db}/_design/{ddoc}/_view/{view}` API. Before using read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partition-querying) to understand the limitations and appropriate use cases.
      Parameters:
      postPartitionViewOptions - the PostPartitionViewOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postPartitionExplain

      public ServiceCall<ExplainResult> postPartitionExplain(PostPartitionExplainOptions postPartitionExplainOptions)
      Retrieve information about which partition index is used for a query. Shows which index is being used by the query. Parameters are the same as the [`/{db}/_partition/{partition_key}/_find` endpoint](#postpartitionfind-queries).
      Parameters:
      postPartitionExplainOptions - the PostPartitionExplainOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ExplainResult

    • postPartitionFind

      public ServiceCall<FindResult> postPartitionFind(PostPartitionFindOptions postPartitionFindOptions)
      Query a database partition index by using selector syntax. Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint. Queries without an appropriate backing index by default fallback to using the built-in `_all_docs` index. This isn't recommended because it has a significant performance impact causing a full scan of the partition with each request. In this case the response body includes a warning field recommending the creation of an index. To avoid the fallback behavior set the `allow_fallback` option to `false` and the server responds with a `400` status code if no suitable index exists. If you want to use only a specific index for your query set `allow_fallback` to `false` and set the `use_index` option. Before using read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partition-querying) to understand the limitations and appropriate use cases.
      Parameters:
      postPartitionFindOptions - the PostPartitionFindOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FindResult

    • postPartitionFindAsStream

      public ServiceCall<InputStream> postPartitionFindAsStream(PostPartitionFindOptions postPartitionFindOptions)
      Query a database partition index by using selector syntax as stream. Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint. Queries without an appropriate backing index by default fallback to using the built-in `_all_docs` index. This isn't recommended because it has a significant performance impact causing a full scan of the partition with each request. In this case the response body includes a warning field recommending the creation of an index. To avoid the fallback behavior set the `allow_fallback` option to `false` and the server responds with a `400` status code if no suitable index exists. If you want to use only a specific index for your query set `allow_fallback` to `false` and set the `use_index` option. Before using read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partition-querying) to understand the limitations and appropriate use cases.
      Parameters:
      postPartitionFindOptions - the PostPartitionFindOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • postExplain

      public ServiceCall<ExplainResult> postExplain(PostExplainOptions postExplainOptions)
      Retrieve information about which index is used for a query. Shows which index is being used by the query. Parameters are the same as the [`_find` endpoint](#postfind).
      Parameters:
      postExplainOptions - the PostExplainOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ExplainResult

    • postFind

      public ServiceCall<FindResult> postFind(PostFindOptions postFindOptions)
      Query an index by using selector syntax. Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint. Queries without an appropriate backing index by default fallback to using the built-in `_all_docs` index. This isn't recommended because it has a significant performance impact causing a full scan of the database with each request. In this case the response body includes a warning field recommending the creation of an index. To avoid the fallback behavior set the `allow_fallback` option to `false` and the server responds with a `400` status code if no suitable index exists. If you want to use only a specific index for your query set `allow_fallback` to `false` and set the `use_index` option.
      Parameters:
      postFindOptions - the PostFindOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FindResult

    • postFindAsStream

      public ServiceCall<InputStream> postFindAsStream(PostFindOptions postFindOptions)
      Query an index by using selector syntax as stream. Query documents by using a declarative JSON querying syntax. It's best practice to create an appropriate index for all fields in selector by using the `_index` endpoint. Queries without an appropriate backing index by default fallback to using the built-in `_all_docs` index. This isn't recommended because it has a significant performance impact causing a full scan of the database with each request. In this case the response body includes a warning field recommending the creation of an index. To avoid the fallback behavior set the `allow_fallback` option to `false` and the server responds with a `400` status code if no suitable index exists. If you want to use only a specific index for your query set `allow_fallback` to `false` and set the `use_index` option.
      Parameters:
      postFindOptions - the PostFindOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • getIndexesInformation

      public ServiceCall<IndexesInformation> getIndexesInformation(GetIndexesInformationOptions getIndexesInformationOptions)
      Retrieve information about all indexes. When you make a GET request to `/db/_index`, you get a list of all the indexes using `"language":"query"` in the database and the primary index. In addition to the information available through this API, the indexes are stored in the `indexes` property of their respective design documents.
      Parameters:
      getIndexesInformationOptions - the GetIndexesInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IndexesInformation

    • postIndex

      public ServiceCall<IndexResult> postIndex(PostIndexOptions postIndexOptions)
      Create a new index on a database. Create a new index on a database.
      Parameters:
      postIndexOptions - the PostIndexOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IndexResult

    • deleteIndex

      public ServiceCall<Ok> deleteIndex(DeleteIndexOptions deleteIndexOptions)
      Delete an index. Delete the index functions from the design document and index files on the server.
      Parameters:
      deleteIndexOptions - the DeleteIndexOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Ok

    • postSearchAnalyze

      public ServiceCall<SearchAnalyzeResult> postSearchAnalyze(PostSearchAnalyzeOptions postSearchAnalyzeOptions)
      Query tokenization of sample text. Returns the results of analyzer tokenization of the provided sample text. This endpoint can be used for testing analyzer tokenization.
      Parameters:
      postSearchAnalyzeOptions - the PostSearchAnalyzeOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SearchAnalyzeResult

    • postSearch

      public ServiceCall<SearchResult> postSearch(PostSearchOptions postSearchOptions)
      Query a search index. Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function decides what data to index and what data to store in the index. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.
      Parameters:
      postSearchOptions - the PostSearchOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SearchResult

    • postSearchAsStream

      public ServiceCall<InputStream> postSearchAsStream(PostSearchOptions postSearchOptions)
      Query a search index as stream. Search indexes, which are defined in design documents, allow databases to be queried by using Lucene Query Parser Syntax. An index function defines a search index, similar to a map function in MapReduce views. The index function decides what data to index and what data to store in the index. The advantage of using the HTTP `POST` method is that the query is submitted as a JSON object in the request body. This avoids the limitations of passing query options as URL query parameters of a `GET` request.
      Parameters:
      postSearchOptions - the PostSearchOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • getSearchInfo

      public ServiceCall<SearchInfoResult> getSearchInfo(GetSearchInfoOptions getSearchInfoOptions)
      Retrieve information about a search index. Retrieve search index metadata information, such as the size of the index on disk.
      Parameters:
      getSearchInfoOptions - the GetSearchInfoOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SearchInfoResult

    • headReplicationDocument

      public ServiceCall<Void> headReplicationDocument(HeadReplicationDocumentOptions headReplicationDocumentOptions)
      Retrieve the HTTP headers for a replication document. Retrieves the HTTP headers containing minimal amount of information about the specified replication document from the `_replicator` database. The method supports the same query arguments as the `GET /_replicator/{doc_id}` method, but only headers like content length and the revision (ETag header) are returned.
      Parameters:
      headReplicationDocumentOptions - the HeadReplicationDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • headSchedulerDocument

      public ServiceCall<Void> headSchedulerDocument(HeadSchedulerDocumentOptions headSchedulerDocumentOptions)
      Retrieve HTTP headers for a replication scheduler document. Retrieves the HTTP headers containing minimal amount of information about the specified replication scheduler document. Since the response body is empty, using the HEAD method is a lightweight way to check if the replication scheduler document exists or not.
      Parameters:
      headSchedulerDocumentOptions - the HeadSchedulerDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • headSchedulerJob

      public ServiceCall<Void> headSchedulerJob(HeadSchedulerJobOptions headSchedulerJobOptions)
      Retrieve the HTTP headers for a replication scheduler job. Returns the HTTP headers that contain a minimal amount of information about the specified replication task. Only the header information is returned.
      Parameters:
      headSchedulerJobOptions - the HeadSchedulerJobOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • deleteReplicationDocument

      public ServiceCall<DocumentResult> deleteReplicationDocument(DeleteReplicationDocumentOptions deleteReplicationDocumentOptions)
      Cancel a replication. Cancels a replication by deleting the document that describes it from the `_replicator` database.
      Parameters:
      deleteReplicationDocumentOptions - the DeleteReplicationDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • getReplicationDocument

      public ServiceCall<ReplicationDocument> getReplicationDocument(GetReplicationDocumentOptions getReplicationDocumentOptions)
      Retrieve a replication document. Retrieves a replication document from the `_replicator` database to view the configuration of the replication. The status of the replication is no longer recorded in the document but can be checked via the replication scheduler.
      Parameters:
      getReplicationDocumentOptions - the GetReplicationDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReplicationDocument

    • putReplicationDocument

      public ServiceCall<DocumentResult> putReplicationDocument(PutReplicationDocumentOptions putReplicationDocumentOptions)
      Create or modify a replication using a replication document. Creates or modifies a document in the `_replicator` database to start a new replication or to edit an existing replication.
      Parameters:
      putReplicationDocumentOptions - the PutReplicationDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • getSchedulerDocs

      public ServiceCall<SchedulerDocsResult> getSchedulerDocs(GetSchedulerDocsOptions getSchedulerDocsOptions)
      Retrieve replication scheduler documents. Lists replication documents, including information about all documents, even the ones in a completed or failed state. For each document, the endpoint returns the document ID, database, replication ID, source and target, and other information.
      Parameters:
      getSchedulerDocsOptions - the GetSchedulerDocsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SchedulerDocsResult

    • getSchedulerDocs

      public ServiceCall<SchedulerDocsResult> getSchedulerDocs()
      Retrieve replication scheduler documents. Lists replication documents, including information about all documents, even the ones in a completed or failed state. For each document, the endpoint returns the document ID, database, replication ID, source and target, and other information.
      Returns:
      a ServiceCall with a result of type SchedulerDocsResult

    • getSchedulerDocument

      public ServiceCall<SchedulerDocument> getSchedulerDocument(GetSchedulerDocumentOptions getSchedulerDocumentOptions)
      Retrieve a replication scheduler document. Retrieves information about a replication document from the replicator database. The endpoint returns the document ID, database, replication ID, source and target, and other information.
      Parameters:
      getSchedulerDocumentOptions - the GetSchedulerDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SchedulerDocument

    • getSchedulerJobs

      public ServiceCall<SchedulerJobsResult> getSchedulerJobs(GetSchedulerJobsOptions getSchedulerJobsOptions)
      Retrieve replication scheduler jobs. Retrieves information about replications that were created via `/_replicate` endpoint, as well as those created from replication documents. It doesn't include replications that completed or failed to start because replication documents were malformed. Each job description includes source and target information, replication ID, history of recent events, and other information.
      Parameters:
      getSchedulerJobsOptions - the GetSchedulerJobsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SchedulerJobsResult

    • getSchedulerJobs

      public ServiceCall<SchedulerJobsResult> getSchedulerJobs()
      Retrieve replication scheduler jobs. Retrieves information about replications that were created via `/_replicate` endpoint, as well as those created from replication documents. It doesn't include replications that completed or failed to start because replication documents were malformed. Each job description includes source and target information, replication ID, history of recent events, and other information.
      Returns:
      a ServiceCall with a result of type SchedulerJobsResult

    • getSchedulerJob

      public ServiceCall<SchedulerJob> getSchedulerJob(GetSchedulerJobOptions getSchedulerJobOptions)
      Retrieve a replication scheduler job. Retrieves the state of a single replication task based on its replication ID.
      Parameters:
      getSchedulerJobOptions - the GetSchedulerJobOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SchedulerJob

    • getSessionInformation

      public ServiceCall<SessionInformation> getSessionInformation(GetSessionInformationOptions getSessionInformationOptions)
      Retrieve current session cookie information. Retrieves information about the authenticated user's session.
      Parameters:
      getSessionInformationOptions - the GetSessionInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SessionInformation

    • getSessionInformation

      public ServiceCall<SessionInformation> getSessionInformation()
      Retrieve current session cookie information. Retrieves information about the authenticated user's session.
      Returns:
      a ServiceCall with a result of type SessionInformation

    • getSecurity

      public ServiceCall<Security> getSecurity(GetSecurityOptions getSecurityOptions)
      Retrieve database permissions information. See who has permission to read, write, and manage the database. The credentials you use to log in to the dashboard automatically include `_admin` permissions to all databases you create. Everyone and everything else, including users you share databases with and API keys you create, must be given a permission level explicitly.
      Parameters:
      getSecurityOptions - the GetSecurityOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Security

    • putSecurity

      public ServiceCall<Ok> putSecurity(PutSecurityOptions putSecurityOptions)
      Modify database permissions. Modify who has permission to read, write, or manage a database. This endpoint can be used to modify both Cloudant and CouchDB related permissions. Be careful: by removing a Cloudant API key, a member or an admin from the list of users that have access permissions, you remove it from the list of users that have access to the database. ### Note about nobody role The `nobody` username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but did not identify itself, the task can continue only if the `nobody` user has the role `_reader`.
      Parameters:
      putSecurityOptions - the PutSecurityOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Ok

    • postApiKeys

      public ServiceCall<ApiKeysResult> postApiKeys(PostApiKeysOptions postApiKeysOptions)
      Generates API keys for apps or persons to enable database access. Generates API keys to enable database access for a person or application, but without creating a new IBM Cloudant account for that person or application. An API key is a randomly generated username and password. The key is given the wanted access permissions for a database.
      Parameters:
      postApiKeysOptions - the PostApiKeysOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ApiKeysResult

    • postApiKeys

      public ServiceCall<ApiKeysResult> postApiKeys()
      Generates API keys for apps or persons to enable database access. Generates API keys to enable database access for a person or application, but without creating a new IBM Cloudant account for that person or application. An API key is a randomly generated username and password. The key is given the wanted access permissions for a database.
      Returns:
      a ServiceCall with a result of type ApiKeysResult

    • putCloudantSecurityConfiguration

      public ServiceCall<Ok> putCloudantSecurityConfiguration(PutCloudantSecurityConfigurationOptions putCloudantSecurityConfigurationOptions)
      Modify only Cloudant related database permissions. Modify only Cloudant related permissions to database. Be careful: by removing an API key from the list, you remove the API key from the list of users that have access to the database. ### Note about nobody role The `nobody` username applies to all unauthenticated connection attempts. For example, if an application tries to read data from a database, but did not identify itself, the task can continue only if the `nobody` user has the role `_reader`.
      Parameters:
      putCloudantSecurityConfigurationOptions - the PutCloudantSecurityConfigurationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Ok

    • getCorsInformation

      public ServiceCall<CorsInformation> getCorsInformation(GetCorsInformationOptions getCorsInformationOptions)
      Retrieve CORS configuration information. Lists all Cross-origin resource sharing (CORS) configuration. CORS defines a way in which the browser and the server interact to determine whether or not to allow the request.
      Parameters:
      getCorsInformationOptions - the GetCorsInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type CorsInformation

    • getCorsInformation

      public ServiceCall<CorsInformation> getCorsInformation()
      Retrieve CORS configuration information. Lists all Cross-origin resource sharing (CORS) configuration. CORS defines a way in which the browser and the server interact to determine whether or not to allow the request.
      Returns:
      a ServiceCall with a result of type CorsInformation

    • putCorsConfiguration

      public ServiceCall<Ok> putCorsConfiguration(PutCorsConfigurationOptions putCorsConfigurationOptions)
      Modify CORS configuration. Sets the CORS configuration. The configuration applies to all databases and all account level endpoints in your account.
      Parameters:
      putCorsConfigurationOptions - the PutCorsConfigurationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Ok

    • headAttachment

      public ServiceCall<Void> headAttachment(HeadAttachmentOptions headAttachmentOptions)
      Retrieve the HTTP headers for an attachment. Returns the HTTP headers that contain a minimal amount of information about the specified attachment. This method supports the same query arguments as the `GET /{db}/{doc_id}/{attachment_name}` method, but only the header information (including attachment size, encoding, and the MD5 hash as an ETag), is returned.
      Parameters:
      headAttachmentOptions - the HeadAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • deleteAttachment

      public ServiceCall<DocumentResult> deleteAttachment(DeleteAttachmentOptions deleteAttachmentOptions)
      Delete an attachment. Deletes the attachment with the filename, `{attachment_name}`, from the specified doc. You must supply the `rev` query parameter or `If-Match` header with the current revision to delete the attachment.
      Parameters:
      deleteAttachmentOptions - the DeleteAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • getAttachment

      public ServiceCall<InputStream> getAttachment(GetAttachmentOptions getAttachmentOptions)
      Retrieve an attachment. Returns the file attachment that is associated with the document. The raw data of the associated attachment is returned, just as if you were accessing a static file. The returned Content-Type header is the same as the content type set when the document attachment was submitted to the database.
      Parameters:
      getAttachmentOptions - the GetAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InputStream

    • putAttachment

      public ServiceCall<DocumentResult> putAttachment(PutAttachmentOptions putAttachmentOptions)
      Create or modify an attachment. Uploads the supplied content as an attachment to the specified document. The attachment name that you provide must be a URL encoded string. You must supply the Content-Type header, and for an existing document, you must also supply either the `rev` query argument or the `If-Match` HTTP header. If you omit the revision, a new, otherwise empty, document is created with the provided attachment, or a conflict occurs. If the uploaded attachment uses an existing attachment name in the remote database, it updates the corresponding stored content of the database. Since you must supply the revision information to add an attachment to the document, this serves as validation to update the existing attachment.
      Parameters:
      putAttachmentOptions - the PutAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • headLocalDocument

      public ServiceCall<Void> headLocalDocument(HeadLocalDocumentOptions headLocalDocumentOptions)
      Retrieve HTTP headers for a local document. Retrieves the HTTP headers containing minimal amount of information about the specified local document. Since the response body is empty, using the HEAD method is a lightweight way to check if the local document exists or not.
      Parameters:
      headLocalDocumentOptions - the HeadLocalDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • deleteLocalDocument

      public ServiceCall<DocumentResult> deleteLocalDocument(DeleteLocalDocumentOptions deleteLocalDocumentOptions)
      Delete a local document. Deletes the specified local document. The semantics are identical to deleting a standard document in the specified database, except that the document is not replicated.
      Parameters:
      deleteLocalDocumentOptions - the DeleteLocalDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • getLocalDocument

      public ServiceCall<Document> getLocalDocument(GetLocalDocumentOptions getLocalDocumentOptions)
      Retrieve a local document. Retrieves the specified local document. The semantics are identical to accessing a standard document in the specified database, except that the document is not replicated.
      Parameters:
      getLocalDocumentOptions - the GetLocalDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Document

    • putLocalDocument

      public ServiceCall<DocumentResult> putLocalDocument(PutLocalDocumentOptions putLocalDocumentOptions)
      Create or modify a local document. Stores the specified local document. The semantics are identical to storing a standard document in the specified database, except that the document is not replicated.
      Parameters:
      putLocalDocumentOptions - the PutLocalDocumentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentResult

    • postRevsDiff

      public ServiceCall<Map<String,RevsDiff>> postRevsDiff(PostRevsDiffOptions postRevsDiffOptions)
      Query the document revisions and possible ancestors missing from the database. The replicator is the primary user of this operation. After receiving a set of new revision IDs from the source database, the replicator sends this set to the destination database's `_revs_diff` to find out which of them already exists there. It can then avoid fetching and sending already-known document bodies.
      Parameters:
      postRevsDiffOptions - the PostRevsDiffOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Map

    • getShardsInformation

      public ServiceCall<ShardsInformation> getShardsInformation(GetShardsInformationOptions getShardsInformationOptions)
      Retrieve shard information. List each shard range and the corresponding replicas for a specified database.
      Parameters:
      getShardsInformationOptions - the GetShardsInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShardsInformation

    • getDocumentShardsInfo

      public ServiceCall<DocumentShardInfo> getDocumentShardsInfo(GetDocumentShardsInfoOptions getDocumentShardsInfoOptions)
      Retrieve shard information for a specific document. Retrieves information about a specific shard where a particular document is stored, along with information about the nodes where that shard has a replica.
      Parameters:
      getDocumentShardsInfoOptions - the GetDocumentShardsInfoOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DocumentShardInfo

    • headUpInformation

      public ServiceCall<Void> headUpInformation(HeadUpInformationOptions headUpInformationOptions)
      Retrieve HTTP headers about whether the server is up. Retrieves the HTTP headers about whether the server is up.
      Parameters:
      headUpInformationOptions - the HeadUpInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • headUpInformation

      public ServiceCall<Void> headUpInformation()
      Retrieve HTTP headers about whether the server is up. Retrieves the HTTP headers about whether the server is up.
      Returns:
      a ServiceCall with a void result

    • getActiveTasks

      public ServiceCall<List<ActiveTask>> getActiveTasks(GetActiveTasksOptions getActiveTasksOptions)
      Retrieve list of running tasks. Lists running tasks, including the task type, name, status, and process ID. The result includes a JSON array of the currently running tasks, with each task described as a single object. Depending on the operation type, the set of response object fields might be different.
      Parameters:
      getActiveTasksOptions - the GetActiveTasksOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type List

    • getActiveTasks

      public ServiceCall<List<ActiveTask>> getActiveTasks()
      Retrieve list of running tasks. Lists running tasks, including the task type, name, status, and process ID. The result includes a JSON array of the currently running tasks, with each task described as a single object. Depending on the operation type, the set of response object fields might be different.
      Returns:
      a ServiceCall with a result of type List

    • getMembershipInformation

      public ServiceCall<MembershipInformation> getMembershipInformation(GetMembershipInformationOptions getMembershipInformationOptions)
      Retrieve cluster membership information. Displays the nodes that are part of the cluster as `cluster_nodes`. The field, `all_nodes`, displays all nodes this node knows about, including the ones that are part of the cluster. This endpoint is useful when you set up a cluster.
      Parameters:
      getMembershipInformationOptions - the GetMembershipInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type MembershipInformation

    • getMembershipInformation

      public ServiceCall<MembershipInformation> getMembershipInformation()
      Retrieve cluster membership information. Displays the nodes that are part of the cluster as `cluster_nodes`. The field, `all_nodes`, displays all nodes this node knows about, including the ones that are part of the cluster. This endpoint is useful when you set up a cluster.
      Returns:
      a ServiceCall with a result of type MembershipInformation

    • getUpInformation

      public ServiceCall<UpInformation> getUpInformation(GetUpInformationOptions getUpInformationOptions)
      Retrieve information about whether the server is up. Confirms that the server is up, running, and ready to respond to requests. If `maintenance_mode` is `true` or `nolb`, the endpoint returns a 404 response. **Tip:** The authentication for this endpoint is only enforced when using IAM.
      Parameters:
      getUpInformationOptions - the GetUpInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type UpInformation

    • getUpInformation

      public ServiceCall<UpInformation> getUpInformation()
      Retrieve information about whether the server is up. Confirms that the server is up, running, and ready to respond to requests. If `maintenance_mode` is `true` or `nolb`, the endpoint returns a 404 response. **Tip:** The authentication for this endpoint is only enforced when using IAM.
      Returns:
      a ServiceCall with a result of type UpInformation

    • getActivityTrackerEvents

      public ServiceCall<ActivityTrackerEvents> getActivityTrackerEvents(GetActivityTrackerEventsOptions getActivityTrackerEventsOptions)
      Retrieve Activity Tracker events information. Check event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.
      Parameters:
      getActivityTrackerEventsOptions - the GetActivityTrackerEventsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ActivityTrackerEvents

    • getActivityTrackerEvents

      public ServiceCall<ActivityTrackerEvents> getActivityTrackerEvents()
      Retrieve Activity Tracker events information. Check event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.
      Returns:
      a ServiceCall with a result of type ActivityTrackerEvents

    • postActivityTrackerEvents

      public ServiceCall<Ok> postActivityTrackerEvents(PostActivityTrackerEventsOptions postActivityTrackerEventsOptions)
      Modify Activity Tracker events configuration. Configure event types that are being sent to IBM Cloud Activity Tracker for the IBM Cloudant instance.
      Parameters:
      postActivityTrackerEventsOptions - the PostActivityTrackerEventsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Ok

    • getCurrentThroughputInformation

      public ServiceCall<CurrentThroughputInformation> getCurrentThroughputInformation(GetCurrentThroughputInformationOptions getCurrentThroughputInformationOptions)
      Retrieve the current provisioned throughput capacity consumption. View the current consumption of provisioned throughput capacity for an IBM Cloudant instance. The current consumption shows the quantities of reads, writes, and global queries conducted against the instance for a given second.
      Parameters:
      getCurrentThroughputInformationOptions - the GetCurrentThroughputInformationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type CurrentThroughputInformation

    • getCurrentThroughputInformation

      public ServiceCall<CurrentThroughputInformation> getCurrentThroughputInformation()
      Retrieve the current provisioned throughput capacity consumption. View the current consumption of provisioned throughput capacity for an IBM Cloudant instance. The current consumption shows the quantities of reads, writes, and global queries conducted against the instance for a given second.
      Returns:
      a ServiceCall with a result of type CurrentThroughputInformation