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

Class HeadDesignDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.HeadDesignDocumentOptions

All Implemented Interfaces:

ObjectModel

public class HeadDesignDocumentOptions
extends GenericModel

The headDesignDocument options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	db()	Gets the db.
String	ddoc()	Gets the ddoc.
String	ifNoneMatch()	Gets the ifNoneMatch.
HeadDesignDocumentOptions.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 Details

newBuilder

public HeadDesignDocumentOptions.Builder newBuilder()

New builder.

Returns:

a HeadDesignDocumentOptions builder

db

public String db()

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

Returns:

the db

ddoc

public String ddoc()

Gets the ddoc. Path parameter to specify the design document name. The design document name is the design document ID excluding the `_design/` prefix.

Returns:

the ddoc

ifNoneMatch

public String ifNoneMatch()

Gets the ifNoneMatch. Header parameter for a conditional HTTP request not matching an ETag.

Returns:

the ifNoneMatch