org.apache.tinkerpop.gremlin.driver

Class Client.Settings

java.lang.Object

org.apache.tinkerpop.gremlin.driver.Client.Settings

Enclosing class:

Client

public static class Client.Settings
extends Object

Settings given to Cluster#connect(Settings) that configures how a Client will behave.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.Settings.Builder

Method Summary

Modifier and Type	Method and Description
static Client.Settings.Builder	build()
Optional<Client.SessionSettings>	getSession() Determines if the Client is to be constructed with a session.
boolean	unrollTraversers() A request to Gremlin Server may return a Traverser.

Methods inherited from class java.lang.Object

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

Method Detail

build

public static Client.Settings.Builder build()

unrollTraversers

public boolean unrollTraversers()

A request to Gremlin Server may return a Traverser. By default a Traverser is "unrolled" into an actual result on the client side. So, if the Traverser contained a Vertex then the Vertex would be extracted out of that Traverser for purposes of the result. If this values is instead set to false then the ResultSet will simply contain a Traverser and it will be up to the user to work with that component directly.

getSession

public Optional<Client.SessionSettings> getSession()

Determines if the Client is to be constructed with a session. If the value is present, then a session is expected.