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

Class AllDocsQuery

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.AllDocsQuery

All Implemented Interfaces:

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

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

Schema for an all documents query operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AllDocsQuery.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
Boolean	attachments()	Gets the attachments.
Boolean	attEncodingInfo()	Gets the attEncodingInfo.
Boolean	conflicts()	Gets the conflicts.
Boolean	descending()	Gets the descending.
String	endkey()	Gets the endkey.
Boolean	includeDocs()	Gets the includeDocs.
Boolean	inclusiveEnd()	Gets the inclusiveEnd.
String	key()	Gets the key.
List<String>	keys()	Gets the keys.
Long	limit()	Gets the limit.
AllDocsQuery.Builder	newBuilder()	New builder.
Long	skip()	Gets the skip.
String	startkey()	Gets the startkey.
Boolean	updateSeq()	Gets the updateSeq.

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 Detail

newBuilder

public AllDocsQuery.Builder newBuilder()

New builder.

Returns:

a AllDocsQuery builder

attEncodingInfo

public Boolean attEncodingInfo()

Gets the attEncodingInfo. Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.

Returns:

the attEncodingInfo

attachments

public Boolean attachments()

Gets the attachments. Parameter to specify whether to include attachments bodies in a response.

Returns:

the attachments

conflicts

public Boolean conflicts()

Gets the conflicts. Parameter to specify whether to include a list of conflicted revisions in the `_conflicts` property of the returned document. Ignored if `include_docs` isn't `true`.

Returns:

the conflicts

descending

public Boolean descending()

Gets the descending. Parameter to specify whether to return the documents in descending by key order.

Returns:

the descending

includeDocs

public Boolean includeDocs()

Gets the includeDocs. Parameter to specify whether to include the full content of the documents in the response.

Returns:

the includeDocs

inclusiveEnd

public Boolean inclusiveEnd()

Gets the inclusiveEnd. Parameter to specify whether the specified end key should be included in the result.

Returns:

the inclusiveEnd

limit

public Long limit()

Gets the limit. Parameter to specify the number of returned documents to limit the result to.

Returns:

the limit

skip

public Long skip()

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

Returns:

the skip

updateSeq

public Boolean updateSeq()

Gets the updateSeq. Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the database the view reflects.

Returns:

the updateSeq

endkey

public String endkey()

Gets the endkey. Schema for a document ID.

Returns:

the endkey

key

public String key()

Gets the key. Schema for a document ID.

Returns:

the key

keys

public List<String> keys()

Gets the keys. Schema for a list of document IDs.

Returns:

the keys

startkey

public String startkey()

Gets the startkey. Schema for a document ID.

Returns:

the startkey