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

Class HeadDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.HeadDocumentOptions

All Implemented Interfaces:

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

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

The headDocument options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	db()	Gets the db.
String	docId()	Gets the docId.
String	ifNoneMatch()	Gets the ifNoneMatch.
Boolean	latest()	Gets the latest.
HeadDocumentOptions.Builder	newBuilder()	New builder.
String	rev()	Gets the rev.

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

New builder.

Returns:

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

ifNoneMatch

public String ifNoneMatch()

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

Returns:

the ifNoneMatch

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

rev

public String rev()

Gets the rev. Query parameter to specify a document revision.

Returns:

the rev