org.janusgraph.diskstorage.es

Enum ElasticSearchSetup

java.lang.Object

java.lang.Enum<ElasticSearchSetup>

org.janusgraph.diskstorage.es.ElasticSearchSetup

All Implemented Interfaces:

Serializable, Comparable<ElasticSearchSetup>

public enum ElasticSearchSetup
extends Enum<ElasticSearchSetup>

Create an ES RestClient from a JanusGraph Configuration.

Any key-value pairs under the ElasticSearchIndex.ES_CREATE_EXTRAS_NS namespace are copied into the Elasticsearch settings builder. This allows overriding arbitrary ES settings from within the JanusGraph properties file.

Assumes that an ES cluster is already running. It does not attempt to start an embedded ES instance. It just connects to whatever hosts are given in GraphDatabaseConfiguration.INDEX_HOSTS.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElasticSearchSetup.Connection

Enum Constant Summary

Enum Constants

Enum Constant and Description
REST_CLIENT Create an ES RestClient connected to GraphDatabaseConfiguration.INDEX_HOSTS.

Method Summary

Modifier and Type	Method and Description
abstract ElasticSearchSetup.Connection	connect(Configuration config)
static ElasticSearchSetup	valueOf(String name) Returns the enum constant of this type with the specified name.
static ElasticSearchSetup[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REST_CLIENT

public static final ElasticSearchSetup REST_CLIENT

Create an ES RestClient connected to GraphDatabaseConfiguration.INDEX_HOSTS.

Method Detail

values

public static ElasticSearchSetup[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ElasticSearchSetup c : ElasticSearchSetup.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ElasticSearchSetup valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

connect

public abstract ElasticSearchSetup.Connection connect(Configuration config)
                                               throws IOException

Throws:

IOException