org.apache.tinkerpop.gremlin.driver

Class Client.Settings.Builder

java.lang.Object

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

Enclosing class:

Client.Settings

public static class Client.Settings.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Client.Settings	create()
Client.Settings.Builder	unrollTraversers(boolean unrollTraversers) A request to Gremlin Server may return a Traverser.
Client.Settings.Builder	useSession(boolean enabled) Enables a session.
Client.Settings.Builder	useSession(Client.SessionSettings settings) Enables a session.
Client.Settings.Builder	useSession(String sessionId) Enables a session.

Methods inherited from class java.lang.Object

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

Method Detail

unrollTraversers

public Client.Settings.Builder unrollTraversers(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.

useSession

public Client.Settings.Builder useSession(boolean enabled)

Enables a session. By default this will create a random session name and configure transactions to be unmanaged. This method will override settings provided by calls to the other overloads of useSession.

useSession

public Client.Settings.Builder useSession(String sessionId)

Enables a session. By default this will create a session with the provided name and configure transactions to be unmanaged. This method will override settings provided by calls to the other overloads of useSession.

useSession

public Client.Settings.Builder useSession(Client.SessionSettings settings)

Enables a session. This method will override settings provided by calls to the other overloads of useSession.

create

public Client.Settings create()