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

Class GetSchedulerDocsOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.GetSchedulerDocsOptions

All Implemented Interfaces:

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

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

The getSchedulerDocs options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetSchedulerDocsOptions.Builder	Builder.
static interface	GetSchedulerDocsOptions.States	Schema for replication state.

Method Summary

Modifier and Type	Method	Description
Long	limit()	Gets the limit.
GetSchedulerDocsOptions.Builder	newBuilder()	New builder.
Long	skip()	Gets the skip.
List<String>	states()	Gets the states.

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 GetSchedulerDocsOptions.Builder newBuilder()

New builder.

Returns:

a GetSchedulerDocsOptions builder

limit

public Long limit()

Gets the limit. Query parameter to specify the number of returned documents to limit the result to.

Returns:

the limit

skip

public Long skip()

Gets the skip. Query parameter to specify the number of records before starting to return the results.

Returns:

the skip

states

public List<String> states()

Gets the states. Query parameter to include only replication documents in the specified states. String must be a comma-delimited string.

Returns:

the states