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

Class DeleteLocalDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.DeleteLocalDocumentOptions

All Implemented Interfaces:

ObjectModel

public class DeleteLocalDocumentOptions
extends GenericModel

The deleteLocalDocument options.

Nested Class Summary

Nested Classes

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

Method Summary

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

New builder.

Returns:

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

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