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

Class DeleteReplicationDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.DeleteReplicationDocumentOptions

All Implemented Interfaces:

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

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

The deleteReplicationDocument options.

Nested Class Summary

Nested Classes

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

Method Summary

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

New builder.

Returns:

a DeleteReplicationDocumentOptions builder

docId

public String docId()

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

Returns:

the docId

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