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

Class GetLocalDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.GetLocalDocumentOptions

All Implemented Interfaces:

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

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

The getLocalDocument options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	accept()	Gets the accept.
Boolean	attachments()	Gets the attachments.
Boolean	attEncodingInfo()	Gets the attEncodingInfo.
List<String>	attsSince()	Gets the attsSince.
String	db()	Gets the db.
String	docId()	Gets the docId.
String	ifNoneMatch()	Gets the ifNoneMatch.
Boolean	localSeq()	Gets the localSeq.
GetLocalDocumentOptions.Builder	newBuilder()	New builder.

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

New builder.

Returns:

a GetLocalDocumentOptions builder

db

public String db()

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

Returns:

the db

docId

public String docId()

Gets the docId. Path parameter to specify the document ID.

Returns:

the docId

accept

public String accept()

Gets the accept. The type of the response: application/json, multipart/mixed, multipart/related, or application/octet-stream.

Returns:

the accept

ifNoneMatch

public String ifNoneMatch()

Gets the ifNoneMatch. Header parameter to specify a double quoted document revision token for cache control.

Returns:

the ifNoneMatch

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

attsSince

public List<String> attsSince()

Gets the attsSince. Query parameter to specify whether to include attachments only since specified revisions. Note this does not include the attachments for the specified revisions.

Returns:

the attsSince

localSeq

public Boolean localSeq()

Gets the localSeq. Query parameter to specify whether to include the last update sequence for the document.

Returns:

the localSeq