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

Class PutDesignDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.PutDesignDocumentOptions

All Implemented Interfaces:

ObjectModel

public class PutDesignDocumentOptions
extends GenericModel

The putDesignDocument options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	batch()	Gets the batch.
String	db()	Gets the db.
String	ddoc()	Gets the ddoc.
DesignDocument	designDocument()	Gets the designDocument.
String	ifMatch()	Gets the ifMatch.
PutDesignDocumentOptions.Builder	newBuilder()	New builder.
Boolean	newEdits()	Gets the newEdits.
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 Details

newBuilder

public PutDesignDocumentOptions.Builder newBuilder()

New builder.

Returns:

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

designDocument

public DesignDocument designDocument()

Gets the designDocument. HTTP request body for DesignDocument operations.

Returns:

the designDocument

ifMatch

public String ifMatch()

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

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

newEdits

public Boolean newEdits()

Gets the newEdits. Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed _rev must be included in the document. False is used by the replicator to insert documents into the target database even if that leads to the creation of conflicts. Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it is very easy to accidentally end up with a large number of conflicts.

Returns:

the newEdits

rev

public String rev()

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

Returns:

the rev