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

Class GetDbUpdatesOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.cloudant.v1.model.GetDbUpdatesOptions
All Implemented Interfaces:
ObjectModel
public class GetDbUpdatesOptions extends GenericModel
The getDbUpdates options.

  • Method Details

    • newBuilder

      public GetDbUpdatesOptions.Builder newBuilder()
      New builder.
      Returns:
      a GetDbUpdatesOptions builder

    • descending

      public Boolean descending()
      Gets the descending. Query parameter to specify whether to return the documents in descending by key order.
      Returns:
      the descending

    • feed

      public String feed()
      Gets the feed. Query parameter to specify the changes feed type.
      Returns:
      the feed

    • heartbeat

      public Long heartbeat()
      Gets the heartbeat. Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Off by default and only applicable for `continuous` and `eventsource` feeds. Overrides any timeout to keep the feed alive indefinitely. May also be `true` to use a value of `60000`. **Note:** Delivery of heartbeats cannot be relied on at specific intervals. If your application runs in an environment where idle network connections may break, `heartbeat` is not suitable as a keepalive mechanism. Instead, consider one of the following options: * Use the `timeout` parameter with a value that is compatible with your network environment. * Switch to scheduled usage of one of the non-continuous changes feed types (`normal` or `longpoll`). * Use TCP keepalive.
      Returns:
      the heartbeat

    • limit

      public Long limit()
      Gets the limit. Query parameter to specify the number of returned documents to limit the result to.
      Returns:
      the limit

    • timeout

      public Long timeout()
      Gets the timeout. Query parameter to specify the maximum period in milliseconds to wait for a change before the response is sent, even if there are no results. Only applicable for `longpoll` or `continuous` feeds. Default value is specified by `httpd/changes_timeout` configuration option. Note that `60000` value is also the default maximum timeout to prevent undetected dead connections.
      Returns:
      the timeout

    • since

      public String since()
      Gets the since. Query parameter to specify to start the results from the change immediately after the given update sequence. Can be a valid update sequence or `now` value. Default is `0` i.e. all changes.
      Returns:
      the since