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

Class DeleteIndexOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.DeleteIndexOptions

All Implemented Interfaces:

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

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

The deleteIndex options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteIndexOptions.Builder	Builder.
static interface	DeleteIndexOptions.Type	Path parameter to specify the index type.

Method Summary

Modifier and Type	Method	Description
String	db()	Gets the db.
String	ddoc()	Gets the ddoc.
String	index()	Gets the index.
DeleteIndexOptions.Builder	newBuilder()	New builder.
String	type()	Gets the type.

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 DeleteIndexOptions.Builder newBuilder()

New builder.

Returns:

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

type

public String type()

Gets the type. Path parameter to specify the index type.

Returns:

the type

index

public String index()

Gets the index. Path parameter to specify the index name.

Returns:

the index