Package com.ibm.cloud.cloudant.v1

Class Cloudant

  • public class Cloudant
extends CloudantBaseService
    NoSQL database based on Apache CouchDB. See: https://cloud.ibm.com/docs/services/Cloudant/

    • Constructor Detail

      • Cloudant

        public Cloudant​(String serviceName,
                com.ibm.cloud.sdk.core.security.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 Detail

      • 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 com.ibm.cloud.sdk.core.http.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.
        Parameters:
        getServerInformationOptions - the GetServerInformationOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ServerInformation

      • getServerInformation

        public com.ibm.cloud.sdk.core.http.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.
        Returns:
        a ServiceCall with a result of type ServerInformation

      • getMembershipInformation

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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

      • getUuids

        public com.ibm.cloud.sdk.core.http.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.
        Parameters:
        getUuidsOptions - the GetUuidsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type UuidsResult

      • getUuids

        public com.ibm.cloud.sdk.core.http.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.
        Returns:
        a ServiceCall with a result of type UuidsResult

      • getCapacityThroughputInformation

        public com.ibm.cloud.sdk.core.http.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

      • getDbUpdates

        public com.ibm.cloud.sdk.core.http.ServiceCall<DbUpdates> getDbUpdates​(GetDbUpdatesOptions getDbUpdatesOptions)
        Retrieve change events for all databases. 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. **Note: This endpoint requires _admin or _db_updates role and is only available on dedicated clusters.**.
        Parameters:
        getDbUpdatesOptions - the GetDbUpdatesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DbUpdates

      • getDbUpdates

        public com.ibm.cloud.sdk.core.http.ServiceCall<DbUpdates> getDbUpdates()
        Retrieve change events for all databases. 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. **Note: This endpoint requires _admin or _db_updates role and is only available on dedicated clusters.**.
        Returns:
        a ServiceCall with a result of type DbUpdates

      • postChanges

        public com.ibm.cloud.sdk.core.http.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.
        Parameters:
        postChangesOptions - the PostChangesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ChangesResult

      • postChangesAsStream

        public com.ibm.cloud.sdk.core.http.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.
        Parameters:
        postChangesOptions - the PostChangesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • headDatabase

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.ServiceCall<List<String>> getAllDbs​(GetAllDbsOptions getAllDbsOptions)
        Query a list of all database names in the instance.
        Parameters:
        getAllDbsOptions - the GetAllDbsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type List

      • getAllDbs

        public com.ibm.cloud.sdk.core.http.ServiceCall<List<String>> getAllDbs()
        Query a list of all database names in the instance.
        Returns:
        a ServiceCall with a result of type List

      • postDbsInfo

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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

      • putDatabase

        public com.ibm.cloud.sdk.core.http.ServiceCall<Ok> putDatabase​(PutDatabaseOptions putDatabaseOptions)
        Create a database.
        Parameters:
        putDatabaseOptions - the PutDatabaseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Ok

      • headDocument

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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. If the JSON document doesn't specify an `_id` field, then the document is created with a new unique ID generated by the UUID algorithm that is configured for the server. If the document includes the `_id` field, then it is created with that `_id` or updated if the `_id` already exists, and an appropriate `_rev` is included in the JSON document. If the `_id` includes the `_local` or `_design` prefix, then this operation is used to create or modify local or design documents respectively.
        Parameters:
        postDocumentOptions - the PostDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DocumentResult

      • postAllDocs

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.ServiceCall<List<DocumentResult>> postBulkDocs​(PostBulkDocsOptions postBulkDocsOptions)
        Bulk modify multiple documents in a database. The bulk document API allows you to create and update multiple documents at the same time within a single request. The basic operation is similar to creating or updating 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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.ServiceCall<DocumentResult> putDocument​(PutDocumentOptions putDocumentOptions)
        Create or modify a document. The PUT method creates a new named document, or creates a new revision of the existing document. Unlike the `POST /{db}` request, you must specify the document ID in the request URL.
        Parameters:
        putDocumentOptions - the PutDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DocumentResult

      • headDesignDocument

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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.
        Parameters:
        postPartitionSearchOptions - the PostPartitionSearchOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SearchResult

      • postPartitionSearchAsStream

        public com.ibm.cloud.sdk.core.http.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.
        Parameters:
        postPartitionSearchOptions - the PostPartitionSearchOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • postPartitionView

        public com.ibm.cloud.sdk.core.http.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.
        Parameters:
        postPartitionViewOptions - the PostPartitionViewOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ViewResult

      • postPartitionViewAsStream

        public com.ibm.cloud.sdk.core.http.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.
        Parameters:
        postPartitionViewOptions - the PostPartitionViewOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • postPartitionFind

        public com.ibm.cloud.sdk.core.http.ServiceCall<FindResult> postPartitionFind​(PostPartitionFindOptions postPartitionFindOptions)
        Query a database partition index by using selector syntax (POST). Query documents by using a declarative JSON querying syntax. Queries can use the built-in `_all_docs` index or custom indices, specified by using the `_index` endpoint.
        Parameters:
        postPartitionFindOptions - the PostPartitionFindOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type FindResult

      • postPartitionFindAsStream

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> postPartitionFindAsStream​(PostPartitionFindOptions postPartitionFindOptions)
        Query a database partition index by using selector syntax (POST) as stream. Query documents by using a declarative JSON querying syntax. Queries can use the built-in `_all_docs` index or custom indices, specified by using the `_index` endpoint.
        Parameters:
        postPartitionFindOptions - the PostPartitionFindOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • postExplain

        public com.ibm.cloud.sdk.core.http.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](#query-an-index-by-using-selector-syntax).
        Parameters:
        postExplainOptions - the PostExplainOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ExplainResult

      • postFind

        public com.ibm.cloud.sdk.core.http.ServiceCall<FindResult> postFind​(PostFindOptions postFindOptions)
        Query an index by using selector syntax. Query documents by using a declarative JSON querying syntax. Queries can use the built-in `_all_docs` index or custom indices, specified by using the `_index` endpoint.
        Parameters:
        postFindOptions - the PostFindOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type FindResult

      • postFindAsStream

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> postFindAsStream​(PostFindOptions postFindOptions)
        Query an index by using selector syntax as stream. Query documents by using a declarative JSON querying syntax. Queries can use the built-in `_all_docs` index or custom indices, specified by using the `_index` endpoint.
        Parameters:
        postFindOptions - the PostFindOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • getIndexesInformation

        public com.ibm.cloud.sdk.core.http.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 indexes used by Cloudant Query in the database, including the primary index. In addition to the information available through this API, indexes are also stored in the `indexes` property of design documents.
        Parameters:
        getIndexesInformationOptions - the GetIndexesInformationOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type IndexesInformation

      • postIndex

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.ServiceCall<Ok> deleteIndex​(DeleteIndexOptions deleteIndexOptions)
        Delete an index.
        Parameters:
        deleteIndexOptions - the DeleteIndexOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Ok

      • postSearchAnalyze

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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

      • getGeo

        public com.ibm.cloud.sdk.core.http.ServiceCall<GeoResult> getGeo​(GetGeoOptions getGeoOptions)
        Query a geospatial index. Executes a query against the requested geospatial index from the specified design document.
        Parameters:
        getGeoOptions - the GetGeoOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type GeoResult

      • getGeoAsStream

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> getGeoAsStream​(GetGeoOptions getGeoOptions)
        Query a geospatial index as stream. Executes a query against the requested geospatial index from the specified design document.
        Parameters:
        getGeoOptions - the GetGeoOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • postGeoCleanup

        public com.ibm.cloud.sdk.core.http.ServiceCall<Ok> postGeoCleanup​(PostGeoCleanupOptions postGeoCleanupOptions)
        Cleanup old geospatial indexes. Cleanup old geospatial indexes from disk that have been superseded by newer index builds.
        Parameters:
        postGeoCleanupOptions - the PostGeoCleanupOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Ok

      • headReplicationDocument

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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.
        Parameters:
        putSecurityOptions - the PutSecurityOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Ok

      • postApiKeys

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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.
        Parameters:
        putCloudantSecurityConfigurationOptions - the PutCloudantSecurityConfigurationOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Ok

      • getCorsInformation

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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

      • getUpInformation

        public com.ibm.cloud.sdk.core.http.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.
        Parameters:
        getUpInformationOptions - the GetUpInformationOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type UpInformation

      • getUpInformation

        public com.ibm.cloud.sdk.core.http.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.
        Returns:
        a ServiceCall with a result of type UpInformation

      • getActivityTrackerEvents

        public com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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 com.ibm.cloud.sdk.core.http.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