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

Class PostBulkGetOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.PostBulkGetOptions

All Implemented Interfaces:

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

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

The postBulkGet options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Boolean	attachments()	Gets the attachments.
Boolean	attEncodingInfo()	Gets the attEncodingInfo.
String	db()	Gets the db.
List<BulkGetQueryDocument>	docs()	Gets the docs.
Boolean	latest()	Gets the latest.
PostBulkGetOptions.Builder	newBuilder()	New builder.
Boolean	revs()	Gets the revs.

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

New builder.

Returns:

a PostBulkGetOptions builder

db

public String db()

Gets the db. Path parameter to specify the database name.

Returns:

the db

docs

public List<BulkGetQueryDocument> docs()

Gets the docs. List of document items to get in bulk.

Returns:

the docs

attachments

public Boolean attachments()

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

Returns:

the attachments

attEncodingInfo

public Boolean attEncodingInfo()

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

Returns:

the attEncodingInfo

latest

public Boolean latest()

Gets the latest. Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.

Returns:

the latest

revs

public Boolean revs()

Gets the revs. Query parameter to specify whether to include a list of all known document revisions.

Returns:

the revs