IndexOptions (c84j 1.1.14 API)

java.lang.Object
- com.c8db.model.IndexOptions

Direct Known Subclasses:

FulltextIndexOptions, GeoIndexOptions, HashIndexOptions, PersistentIndexOptions, SkiplistIndexOptions, TTLIndexOptions
```
public class IndexOptions
extends Object
```
This class is used for all index similarities

Constructor Summary

Constructors
Constructor Description

IndexOptions(IndexType type)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static IndexOptions`	`create(IndexType indexType)`
`Boolean`	`getInBackground()`
`String`	`getName()`
`IndexType`	`getType()`
`IndexOptions`	`inBackground(Boolean inBackground)`
`IndexOptions`	`name(String name)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexOptions

public IndexOptions(IndexType type)

Method Detail

inBackground
```
public IndexOptions inBackground(Boolean inBackground)
```
Parameters:

inBackground - create the the index in the background this is a RocksDB only flag.

Returns:

options

getInBackground
```
public Boolean getInBackground()
```

getType
```
public IndexType getType()
```

getName
```
public String getName()
```

name

public IndexOptions name(String name)

create

public static IndexOptions create(IndexType indexType)