Package com.ibm.cloud.cloudant.v1.model
Class GetAllDbsOptions
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.model.GenericModel
-
- com.ibm.cloud.cloudant.v1.model.GetAllDbsOptions
-
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class GetAllDbsOptions extends com.ibm.cloud.sdk.core.service.model.GenericModel
The getAllDbs options.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetAllDbsOptions.Builder
Builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
descending()
Gets the descending.String
endkey()
Gets the endkey.Long
limit()
Gets the limit.GetAllDbsOptions.Builder
newBuilder()
New builder.Long
skip()
Gets the skip.String
startkey()
Gets the startkey.
-
-
-
Method Detail
-
newBuilder
public GetAllDbsOptions.Builder newBuilder()
New builder.- Returns:
- a GetAllDbsOptions 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
-
endkey
public String endkey()
Gets the endkey. Query parameter to specify to stop returning records when the specified key is reached. String representation of any JSON type that matches the key type emitted by the view function.- Returns:
- the endkey
-
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
-
startkey
public String startkey()
Gets the startkey. Query parameter to specify to start returning records from the specified key. String representation of any JSON type that matches the key type emitted by the view function.- Returns:
- the startkey
-
-