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

Class ExplainResultMrArgs

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.ExplainResultMrArgs

All Implemented Interfaces:

ObjectModel

public class ExplainResultMrArgs
extends GenericModel

Arguments passed to the underlying view.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExplainResultMrArgs.ViewType	The type of the underlying view.

Method Summary

Modifier and Type	Method	Description
Object	getConflicts()	Gets the conflicts.
String	getDirection()	Gets the direction.
Object	getEndKey()	Gets the endKey.
String	getPartition()	Gets the partition.
Object	getStartKey()	Gets the startKey.
Object	getUpdate()	Gets the update.
String	getViewType()	Gets the viewType.
Boolean	isIncludeDocs()	Gets the includeDocs.
Boolean	isReduce()	Gets the reduce.
Boolean	isStable()	Gets the stable.

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

getConflicts

public Object getConflicts()

Gets the conflicts. Schema for any JSON type.

Returns:

the conflicts

getDirection

public String getDirection()

Gets the direction. Direction parameter passed to the underlying view.

Returns:

the direction

getEndKey

public Object getEndKey()

Gets the endKey. Schema for any JSON type.

Returns:

the endKey

isIncludeDocs

public Boolean isIncludeDocs()

Gets the includeDocs. A parameter that specifies whether to include the full content of the documents in the response in the underlying view.

Returns:

the includeDocs

getPartition

public String getPartition()

Gets the partition. Partition parameter passed to the underlying view.

Returns:

the partition

isReduce

public Boolean isReduce()

Gets the reduce. A parameter that specifies returning only documents that match any of the specified keys in the underlying view.

Returns:

the reduce

isStable

public Boolean isStable()

Gets the stable. A parameter that specifies whether the view results should be returned form a "stable" set of shards passed to the underlying view.

Returns:

the stable

getStartKey

public Object getStartKey()

Gets the startKey. Schema for any JSON type.

Returns:

the startKey

getUpdate

public Object getUpdate()

Gets the update. Schema for any JSON type.

Returns:

the update

getViewType

public String getViewType()

Gets the viewType. The type of the underlying view.

Returns:

the viewType