HashIndexOptions (c84j 1.1.14 API)

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

public class HashIndexOptions
extends IndexOptions

Constructor Summary

Constructors
Constructor Description

HashIndexOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HashIndexOptions`	`deduplicate(Boolean deduplicate)`
`protected HashIndexOptions`	`fields(Iterable<String> fields)`
`Boolean`	`getDeduplicate()`
`protected Iterable<String>`	`getFields()`
`Boolean`	`getSparse()`
`Boolean`	`getUnique()`
`HashIndexOptions`	`sparse(Boolean sparse)`
`HashIndexOptions`	`unique(Boolean unique)`

Methods inherited from class com.c8db.model.IndexOptions
create, getInBackground, getName, getType, inBackground, name

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

Constructor Detail
- HashIndexOptions
```
public HashIndexOptions()
```

Method Detail

getFields

protected Iterable<String> getFields()

fields

protected HashIndexOptions fields(Iterable<String> fields)

Parameters:: fields - A list of attribute paths
Returns:: options

getUnique
```
public Boolean getUnique()
```

unique
```
public HashIndexOptions unique(Boolean unique)
```
Parameters:

unique - if true, then create a unique index

Returns:

options

getSparse
```
public Boolean getSparse()
```

sparse
```
public HashIndexOptions sparse(Boolean sparse)
```
Parameters:

sparse - if true, then create a sparse index

Returns:

options

getDeduplicate
```
public Boolean getDeduplicate()
```

deduplicate
```
public HashIndexOptions deduplicate(Boolean deduplicate)
```
Parameters:

deduplicate - if false, the deduplication of array values is turned off.

Returns:

options