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

Class PostIndexOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.PostIndexOptions

All Implemented Interfaces:

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

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

The postIndex options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PostIndexOptions.Builder	Builder.
static interface	PostIndexOptions.Type	Schema for the type of an index.

Method Summary

Modifier and Type	Method	Description
String	db()	Gets the db.
String	ddoc()	Gets the ddoc.
IndexDefinition	index()	Gets the index.
String	name()	Gets the name.
PostIndexOptions.Builder	newBuilder()	New builder.
Boolean	partitioned()	Gets the partitioned.
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 Details

newBuilder

public PostIndexOptions.Builder newBuilder()

New builder.

Returns:

a PostIndexOptions builder

db

public String db()

Gets the db. Path parameter to specify the database name.

Returns:

the db

index

public IndexDefinition index()

Gets the index. Schema for a `json` or `text` query index definition. Indexes of type `text` have additional configuration properties that do not apply to `json` indexes, these are: * `default_analyzer` - the default text analyzer to use * `default_field` - whether to index the text in all document fields and what analyzer to use for that purpose.

Returns:

the index

ddoc

public String ddoc()

Gets the ddoc. Specifies the design document name in which the index will be created. The design document name is the design document ID excluding the `_design/` prefix.

Returns:

the ddoc

name

public String name()

Gets the name. name.

Returns:

the name

partitioned

public Boolean partitioned()

Gets the partitioned. The default value is `true` for databases with `partitioned: true` and `false` otherwise. For databases with `partitioned: false` if this option is specified the value must be `false`.

Returns:

the partitioned

type

public String type()

Gets the type. Schema for the type of an index.

Returns:

the type