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

Class DeleteDesignDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.DeleteDesignDocumentOptions

All Implemented Interfaces:

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

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

The deleteDesignDocument options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteDesignDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
static class	DeleteDesignDocumentOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	batch()	Gets the batch.
String	db()	Gets the db.
String	ddoc()	Gets the ddoc.
String	ifMatch()	Gets the ifMatch.
DeleteDesignDocumentOptions.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 DeleteDesignDocumentOptions.Builder newBuilder()

New builder.

Returns:

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

ifMatch

public String ifMatch()

Gets the ifMatch. Header parameter to specify the document revision. Alternative to rev query parameter.

Returns:

the ifMatch

batch

public String batch()

Gets the batch. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

Returns:

the batch

rev

public String rev()

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

Returns:

the rev