GetAllDbsOptions (IBM Cloudant Java SDK 0.9.1 API)

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

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.

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 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