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:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class GetDbUpdatesOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The getDbUpdates options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDbUpdatesOptions.Builder	Builder.
static interface	GetDbUpdatesOptions.Feed	Query parameter to specify the changes feed type.

Method Summary

Modifier and Type	Method	Description
String	feed()	Gets the feed.
Long	heartbeat()	Gets the heartbeat.
GetDbUpdatesOptions.Builder	newBuilder()	New builder.
String	since()	Gets the since.
Long	timeout()	Gets the timeout.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public GetDbUpdatesOptions.Builder newBuilder()

New builder.

Returns:

a GetDbUpdatesOptions builder

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. Only applicable for longpoll, continuous, and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be `true` to use default value of 60000.

Returns:

the heartbeat

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