Class DesignDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.DesignDocumentOptions

All Implemented Interfaces:

ObjectModel

public class DesignDocumentOptions
extends GenericModel

Schema for design document options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DesignDocumentOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
DesignDocumentOptions.Builder	newBuilder()	New builder.
Boolean	partitioned()	Gets the partitioned.

Methods inherited from class GenericModel

equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public DesignDocumentOptions.Builder newBuilder()

New builder.

Returns:

a DesignDocumentOptions builder

partitioned

public Boolean partitioned()

Gets the partitioned. Whether this design document describes partitioned or global indexes. Set this option to `false` for a design document that describes global indexes in a partitioned database. A design document describes either global or partitioned indexes, but not both. By default, for a partitioned database this option is `true` and the design document describes partitioned indexes for queries on a single partition at a time. When set to `false` this option allows creating global indexes in this design document for queries spanning many partitions. For non-partitioned databases, the default is `false` and design documents default to global. Only partitioned databases can have partitioned indexes.

Returns:

the partitioned