com.arangodb.model

Class ZKDIndexOptions

java.lang.Object

com.arangodb.model.IndexOptions<ZKDIndexOptions>

com.arangodb.model.ZKDIndexOptions

public class ZKDIndexOptions
extends IndexOptions<ZKDIndexOptions>

Since:

ArangoDB 3.9

Author:

Michele Rastelli

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZKDIndexOptions.FieldValueTypes

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexType	type

Constructor Summary

Constructors

Constructor and Description
ZKDIndexOptions()

Method Summary

Modifier and Type	Method and Description
protected ZKDIndexOptions	fields(Iterable<String> fields)
ZKDIndexOptions	fieldValueTypes(ZKDIndexOptions.FieldValueTypes fieldValueTypes)
protected Iterable<String>	getFields()
ZKDIndexOptions.FieldValueTypes	getFieldValueTypes()
protected ZKDIndexOptions	getThis()
protected IndexType	getType()
Boolean	getUnique()
ZKDIndexOptions	unique(Boolean unique)

Methods inherited from class com.arangodb.model.IndexOptions

getInBackground, getName, inBackground, name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

protected final IndexType type

Constructor Detail

ZKDIndexOptions

public ZKDIndexOptions()

Method Detail

getThis

protected ZKDIndexOptions getThis()

Specified by:

getThis in class IndexOptions<ZKDIndexOptions>

getFields

protected Iterable<String> getFields()

fields

protected ZKDIndexOptions fields(Iterable<String> fields)

Parameters:

fields - A list of attribute paths

Returns:

options

getType

protected IndexType getType()

getUnique

public Boolean getUnique()

unique

public ZKDIndexOptions unique(Boolean unique)

Parameters:

unique - if true, then create a unique index

Returns:

options

getFieldValueTypes

public ZKDIndexOptions.FieldValueTypes getFieldValueTypes()

fieldValueTypes

public ZKDIndexOptions fieldValueTypes(ZKDIndexOptions.FieldValueTypes fieldValueTypes)

Parameters:

fieldValueTypes - must be ZKDIndexOptions.FieldValueTypes.DOUBLE, currently only doubles are supported as values.

Returns:

options