A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- AbstractClient - Class in org.apache.tinkerpop.gremlin.driver.simple
- AbstractClient(String) - Constructor for class org.apache.tinkerpop.gremlin.driver.simple.AbstractClient
- addAlias(String, String) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
The aliases to set on the request.
- addContactPoint(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Adds the address of a Gremlin Server to the list of servers a
Client
will try to contact to send requests to. - addContactPoints(String...) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Add one or more the addresses of a Gremlin Servers to the list of servers a
Client
will try to contact to send requests to. - addParameter(String, Object) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
The parameters to pass on the request.
- addTransactionListener(Consumer<Transaction.Status>) - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
There is no support for remote transaction listeners.
- alias(String) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Create a new
Client
that aliases the specifiedGraph
orTraversalSource
name on the server to a variable called "g" for the context of the requests made through thatClient
. - alias(String) - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Create a new
Client
that aliases the specifiedGraph
orTraversalSource
name on the server to a variable called "g" for the context of the requests made through thatClient
. - alias(Map<String, String>) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Creates a
Client
that supplies the specified set of aliases, thus allowing the user to re-name one or more globally definedGraph
orTraversalSource
server bindings for the context of the createdClient
. - alias(Map<String, String>) - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
-
Creates a
Client
that supplies the specified set of aliases, thus allowing the user to re-name one or more globally definedGraph
orTraversalSource
server bindings for the context of the createdClient
. - alias(Map<String, String>) - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Creates a
Client
that supplies the specified set of aliases, thus allowing the user to re-name one or more globally definedGraph
orTraversalSource
server bindings for the context of the createdClient
. - all() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
The returned
CompletableFuture
completes when all reads are complete for this request and the entire result has been accounted for on the client. - allHosts() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets a list of all the configured hosts.
- allItemsAvailable() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
Determines if all items have been returned to the client.
- allItemsAvailableAsync() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
Returns a future that will complete when all items have been returned from the server.
- authProperties(AuthProperties) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Specifies parameters for authentication to Gremlin Server.
- AuthProperties - Class in org.apache.tinkerpop.gremlin.driver
-
Properties to supply to the
Cluster
for authentication purposes. - AuthProperties() - Constructor for class org.apache.tinkerpop.gremlin.driver.AuthProperties
- AuthProperties.Property - Enum in org.apache.tinkerpop.gremlin.driver
-
An enum of the available authorization properties.
- availableHosts() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the list of hosts that the
Cluster
was able to connect to.
B
- BasicGremlin - Class in examples
- BasicGremlin() - Constructor for class examples.BasicGremlin
- batchSize(int) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
The per client request override for the client and server configured
resultIterationBatchSize
. - begin(Class<T>) - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- build() - Static method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings
- build() - Static method in class org.apache.tinkerpop.gremlin.driver.Client.Settings
- build() - Static method in class org.apache.tinkerpop.gremlin.driver.Cluster
- build() - Static method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- build(File) - Static method in class org.apache.tinkerpop.gremlin.driver.Cluster
- build(String) - Static method in class org.apache.tinkerpop.gremlin.driver.Cluster
- Builder() - Constructor for class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
- buildMessage(RequestMessage.Builder) - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- buildMessage(RequestMessage.Builder) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Makes any initial changes to the builder and returns the constructed
RequestMessage
. - buildMessage(RequestMessage.Builder) - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionedClient
-
Adds the
Tokens.ARGS_SESSION
value to everyRequestMessage
.
C
- callbackResponseHandler - Variable in class org.apache.tinkerpop.gremlin.driver.simple.AbstractClient
- channelInactive(ChannelHandlerContext) - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler
- channelizer(Class) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Specify the
Channelizer
implementation to use on the client when creating aConnection
. - channelizer(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Specify the
Channelizer
implementation to use on the client when creating aConnection
. - Channelizer - Interface in org.apache.tinkerpop.gremlin.driver
-
Client-side channel initializer interface.
- Channelizer.AbstractChannelizer - Class in org.apache.tinkerpop.gremlin.driver
-
Base implementation of the client side
Channelizer
. - Channelizer.HttpChannelizer - Class in org.apache.tinkerpop.gremlin.driver
-
Sends requests over the HTTP endpoint.
- Channelizer.WebSocketChannelizer - Class in org.apache.tinkerpop.gremlin.driver
-
WebSocket
Channelizer
implementation. - chooseConnection(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
-
Delegates to the underlying
Client.ClusteredClient
. - chooseConnection(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Chooses a
Connection
to write the message to. - chooseConnection(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Uses a
LoadBalancingStrategy
to choose the bestHost
and then selects the best connection from that host's connection pool. - chooseConnection(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionedClient
-
Since the session is bound to a single host, simply borrow a connection from that pool.
- clearTransactionListeners() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
There is no support for remote transaction listeners.
- Client - Class in org.apache.tinkerpop.gremlin.driver
-
A
Client
is constructed from aCluster
and represents a way to send messages to Gremlin Server. - Client.AliasClusteredClient - Class in org.apache.tinkerpop.gremlin.driver
-
Uses a
Client.ClusteredClient
that rebinds requests to a specifiedGraph
orTraversalSource
instances on the server-side. - Client.ClusteredClient - Class in org.apache.tinkerpop.gremlin.driver
-
A
Client
implementation that does not operate in a session. - Client.SessionedClient - Class in org.apache.tinkerpop.gremlin.driver
-
A
Client
implementation that operates in the context of a session. - Client.SessionSettings - Class in org.apache.tinkerpop.gremlin.driver
-
Settings for a
Client
that involve a session. - Client.SessionSettings.Builder - Class in org.apache.tinkerpop.gremlin.driver
- Client.Settings - Class in org.apache.tinkerpop.gremlin.driver
-
Settings given to
Cluster.connect(Client.Settings)
that configures how aClient
will behave. - Client.Settings.Builder - Class in org.apache.tinkerpop.gremlin.driver
- close() - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- close() - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Closes the client by making a synchronous call to
Client.closeAsync()
. - close() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
- close() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
- close() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
The default close behavior for this
Transaction
implementation is toDriverRemoteTransaction.commit()
. - close() - Method in class org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient
- close(Channel) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- close(Channel) - Method in interface org.apache.tinkerpop.gremlin.driver.Channelizer
-
Called on
Connection.closeAsync()
to perform anChannelizer
specific functions. - close(Channel) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer
-
Sends a
CloseWebSocketFrame
to the server for the specified channel. - closeAsync() - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- closeAsync() - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Asynchronous close of the
Client
. - closeAsync() - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Closes all the connection pools on all hosts.
- closeAsync() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionedClient
-
Close the bound
ConnectionPool
. - closeAsync() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
- closeConsumer - Variable in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- cluster - Variable in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- cluster - Variable in class org.apache.tinkerpop.gremlin.driver.Client
- Cluster - Class in org.apache.tinkerpop.gremlin.driver
-
A connection to a set of one or more Gremlin Server instances.
- Cluster.Builder - Class in org.apache.tinkerpop.gremlin.driver
- commit() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- ConfigurationEvaluator - Class in org.apache.tinkerpop.gremlin.driver.util
-
An internal application used to test out ranges of configuration parameters for Gremlin Driver.
- ConfigurationEvaluator() - Constructor for class org.apache.tinkerpop.gremlin.driver.util.ConfigurationEvaluator
- configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.HttpChannelizer
- configure(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer
- connect() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Creates a
Client.ClusteredClient
instance to thisCluster
, meaning requests will be routed to one or more servers (depending on the cluster configuration), where each request represents the entirety of a transaction. - connect(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Creates a
Client.SessionedClient
instance to thisCluster
, meaning requests will be routed to a single server (randomly selected from the cluster), where the same bindings will be available on each request. - connect(String, boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Creates a
Client.SessionedClient
instance to thisCluster
, meaning requests will be routed to a single server (randomly selected from the cluster), where the same bindings will be available on each request. - connect(Client.Settings) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Creates a new
Client
based on the settings provided. - connected() - Method in interface org.apache.tinkerpop.gremlin.driver.Channelizer
-
Called after the channel connects.
- connected() - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.HttpChannelizer
- connected() - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer
- connection - Variable in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- ConnectionException - Exception in org.apache.tinkerpop.gremlin.driver.exception
-
This exception signifies network connection failure.
- ConnectionException(URI, String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.ConnectionException
- ConnectionException(URI, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.ConnectionException
- ConnectionException(URI, InetSocketAddress, String) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.ConnectionException
- ConnectionException(URI, InetSocketAddress, String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.ConnectionException
- Connections - Class in examples
- Connections() - Constructor for class examples.Connections
- Connections.FakeIoRegistry - Class in examples
- connectionSetupTimeoutMillis(long) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Sets the duration of time in milliseconds provided for connection setup to complete which includes WebSocket handshake and SSL handshake.
- create() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings.Builder
- create() - Method in class org.apache.tinkerpop.gremlin.driver.Client.Settings.Builder
- create() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
- create() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
- credentials(String, String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Sets the
AuthProperties.Property.USERNAME
andAuthProperties.Property.PASSWORD
properties for authentication to Gremlin Server.
D
- decode(ChannelHandlerContext, FullHttpResponse, List<Object>) - Method in class org.apache.tinkerpop.gremlin.driver.handler.HttpGremlinResponseDecoder
- decode(ChannelHandlerContext, WebSocketFrame, List<Object>) - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketGremlinResponseDecoder
- DriverRemoteConnection - Class in org.apache.tinkerpop.gremlin.driver.remote
-
A
RemoteConnection
implementation for Gremlin Server. - DriverRemoteConnection(Configuration) - Constructor for class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
- DriverRemoteTransaction - Class in org.apache.tinkerpop.gremlin.driver.remote
-
A remote
Transaction
implementation that is implemented with the Java driver. - DriverRemoteTransaction(DriverRemoteConnection) - Constructor for class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- DriverRemoteTraversal<S,E> - Class in org.apache.tinkerpop.gremlin.driver.remote
-
A
AbstractRemoteTraversal
implementation for the Gremlin Driver. - DriverRemoteTraversal(ResultSet, Client, boolean, Optional<Configuration>) - Constructor for class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTraversal
E
- EMPTY - Static variable in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- enableSsl(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Enables connectivity over SSL - note that the server should be configured with SSL turned on for this setting to work properly.
- enableUserAgentOnConnect(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Configures whether cluster will send a user agent during web socket handshakes
- encode(ChannelHandlerContext, RequestMessage, List<Object>) - Method in class org.apache.tinkerpop.gremlin.driver.handler.HttpGremlinRequestEncoder
- encode(ChannelHandlerContext, RequestMessage, List<Object>) - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketGremlinRequestEncoder
- examples - package examples
- exceptionCaught(ChannelHandlerContext, Throwable) - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler
- execute() - Method in class org.apache.tinkerpop.gremlin.driver.util.ProfilingApplication
F
- FakeIoRegistry() - Constructor for class examples.Connections.FakeIoRegistry
- fillInStackTrace() - Method in exception org.apache.tinkerpop.gremlin.driver.exception.NoHostAvailableException
- finalize(ChannelPipeline) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- forceClosed(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings.Builder
-
Determines if the session should be force closed when the client is closed.
G
- generate(String[]) - Method in class org.apache.tinkerpop.gremlin.driver.util.ConfigurationEvaluator
- get(Class<? extends T>) - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by casting it to the specified
Class
. - get(AuthProperties.Property) - Method in class org.apache.tinkerpop.gremlin.driver.AuthProperties
-
Gets a property given the key.
- getAddress() - Method in exception org.apache.tinkerpop.gremlin.driver.exception.ConnectionException
- getAddress() - Method in class org.apache.tinkerpop.gremlin.driver.Host
- getAliases() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getAvailableItemCount() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
Gets the number of items available on the client.
- getBatchSize() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getBoolean() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to an
boolean
. - getByte() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to an
byte
. - getChannelizer() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the
Channelizer
implementation to use on the client when creating aConnection
. - getCluster() - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Gets the
Cluster
that spawned thisClient
. - getConnectionSetupTimeout() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets time duration of time in milliseconds provided for connection setup to complete which includes WebSocket handshake and SSL handshake.
- getDouble() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to an
double
. - getEdge() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by casting it to an
Edge
. - getElement() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by casting it to an
Element
. - getFloat() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to an
float
. - getHost() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
- getHostUri() - Method in class org.apache.tinkerpop.gremlin.driver.Host
- getInt() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to an
int
. - getKeepAliveInterval() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets time in milliseconds to wait after the last message is sent over a connection before sending a keep-alive message to the server.
- getLanguage() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getLoadBalancingStrategy() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Specifies the load balancing strategy to use on the client side.
- getLong() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to an
long
. - getMaterializeProperties() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getMaxContentLength() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the maximum size in bytes of any request sent to the server.
- getMaxInProcessPerConnection() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the maximum number of in-flight requests that can occur on a
Connection
. - getMaxWaitForClose() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets how long a connection will wait for all pending messages to be returned from the server before closing.
- getMaxWaitForConnection() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the maximum amount of time to wait for a connection to be borrowed from the connection pool.
- getMinInProcessPerConnection() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the minimum number of in-flight requests that can occur on a
Connection
before it is considered for closing on return to theConnectionPool
. - getNioPoolSize() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Size of the pool for handling request/response operations.
- getObject() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item.
- getOriginalRequestMessage() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
- getOverrideRequestId() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getParameters() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getPath() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the path to the Gremlin service.
- getPath() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by casting it to a
Path
. - getPort() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the port that the Gremlin Servers will be listening on.
- getProperty() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by casting it to a
Property
. - getReconnectInterval() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets time in milliseconds to wait between retries when attempting to reconnect to a dead host.
- getRemoteExceptionHierarchy() - Method in exception org.apache.tinkerpop.gremlin.driver.exception.ResponseException
-
The list of exceptions generated by the server starting with the top-most one followed by its "cause".
- getRemoteStackTrace() - Method in exception org.apache.tinkerpop.gremlin.driver.exception.ResponseException
-
The stacktrace produced by the remote server.
- getRequestOptions(Bytecode) - Static method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getResponseStatusCode() - Method in exception org.apache.tinkerpop.gremlin.driver.exception.ResponseException
- getResultIterationBatchSize() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the override for the server setting that determines how many results are returned per batch.
- getScheme(boolean) - Method in interface org.apache.tinkerpop.gremlin.driver.Channelizer
-
Gets the scheme to use to construct the URL and by default uses HTTP.
- getScheme(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer
- getSerializers() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Get the
MessageSerializer
MIME types supported. - getSession() - Method in class org.apache.tinkerpop.gremlin.driver.Client.Settings
-
Determines if the
Client
is to be constructed with a session. - getSessionId() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionedClient
-
Returns the session identifier bound to this
Client
. - getSessionId() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings
-
Provides the identifier of the session.
- getSettings() - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Gets the
Client.Settings
. - getShort() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to an
short
. - getStatusAttributes() - Method in exception org.apache.tinkerpop.gremlin.driver.exception.ResponseException
-
Gets any status attributes from the response.
- getString() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by coercing it to a
String
viatoString()
. - getTimeout() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getUri() - Method in exception org.apache.tinkerpop.gremlin.driver.exception.ConnectionException
- getUserAgent() - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions
- getVertex() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by casting it to a
Vertex
. - getVertexProperty() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Gets the result item by casting it to a
VertexProperty
. - getWorkerPoolSize() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Size of the pool for handling background work.
- GREMLIN_REMOTE_DRIVER_CLUSTERFILE - Static variable in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
- GREMLIN_REMOTE_DRIVER_SOURCENAME - Static variable in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
- group - Variable in class org.apache.tinkerpop.gremlin.driver.simple.AbstractClient
H
- handlerAdded(ChannelHandlerContext) - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler
- handshakeFuture() - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler
- handshakeInterceptor(HandshakeInterceptor) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Deprecated.As of release 3.6.6, replaced with
Cluster.Builder.requestInterceptor(RequestInterceptor)
. - HandshakeInterceptor - Interface in org.apache.tinkerpop.gremlin.driver
-
Deprecated.As of release 3.6.6, replaced by
RequestInterceptor
. - hasNext() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTraversal
- Host - Class in org.apache.tinkerpop.gremlin.driver
-
Identifies a server within the
Cluster
at a specific address. - Host.Listener - Interface in org.apache.tinkerpop.gremlin.driver
- HttpChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.driver.Channelizer.HttpChannelizer
- HttpGremlinRequestEncoder - Class in org.apache.tinkerpop.gremlin.driver.handler
-
Converts
RequestMessage
to aHttpRequest
. - HttpGremlinRequestEncoder(MessageSerializer<?>, UnaryOperator<FullHttpRequest>) - Constructor for class org.apache.tinkerpop.gremlin.driver.handler.HttpGremlinRequestEncoder
-
Deprecated.
- HttpGremlinRequestEncoder(MessageSerializer<?>, UnaryOperator<FullHttpRequest>, boolean) - Constructor for class org.apache.tinkerpop.gremlin.driver.handler.HttpGremlinRequestEncoder
- HttpGremlinResponseDecoder - Class in org.apache.tinkerpop.gremlin.driver.handler
-
Converts
HttpResponse
to aResponseMessage
. - HttpGremlinResponseDecoder(MessageSerializer<?>) - Constructor for class org.apache.tinkerpop.gremlin.driver.handler.HttpGremlinResponseDecoder
I
- init() - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- init() - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Initializes the client which typically means that a connection is established to the server.
- init() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
- init(Connection) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- init(Connection) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.HttpChannelizer
- init(Connection) - Method in interface org.apache.tinkerpop.gremlin.driver.Channelizer
-
Initializes the
Channelizer
. - init(Connection) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer
- initChannel(SocketChannel) - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- initialize(Cluster, Collection<Host>) - Method in interface org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy
-
Initialize the strategy with the
Cluster
instance and the expected host list. - initialize(Cluster, Collection<Host>) - Method in class org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy.RoundRobin
- initialized - Variable in class org.apache.tinkerpop.gremlin.driver.Client
- initializeImplementation() - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- initializeImplementation() - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Initializes the connection pools on all hosts.
- initializeImplementation() - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Called in the
Client.init()
method. - initializeImplementation() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionedClient
-
Randomly choose an available
Host
to bind the session too and initialize theConnectionPool
. - InterceptedWebSocketClientHandshaker13(URI, WebSocketVersion, String, boolean, HttpHeaders, int, boolean, boolean, long, UnaryOperator<FullHttpRequest>) - Constructor for class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler.InterceptedWebSocketClientHandshaker13
- isAvailable() - Method in class org.apache.tinkerpop.gremlin.driver.Host
- isClosed() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Determines if the
Cluster
has completed its closing process after a call toCluster.close()
orCluster.closeAsync()
. - isClosing() - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- isClosing() - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
- isClosing() - Method in class org.apache.tinkerpop.gremlin.driver.Client
- isClosing() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionedClient
- isClosing() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Determines if the
Cluster
is in the process of closing given a call toCluster.close()
orCluster.closeAsync()
. - isForceClosed() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings
-
Determines if the session will be force closed.
- isNull() - Method in class org.apache.tinkerpop.gremlin.driver.Result
-
Determines if the result item is null or not.
- isOpen() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- isSslEnabled() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Determines if connectivity over SSL is enabled.
- isUserAgentOnConnectEnabled() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Checks if cluster is configured to send a User Agent header in the web socket handshake
- iterator() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
Returns a blocking iterator of the items streaming from the server to the client.
J
- JAAS_ENTRY - org.apache.tinkerpop.gremlin.driver.AuthProperties.Property
-
The name used as the index into the configuration for the
LoginContext
. - jaasEntry(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Sets the
AuthProperties.Property.JAAS_ENTRY
properties for authentication to Gremlin Server.
K
- keepAliveInterval(long) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Length of time in milliseconds to wait on an idle connection before sending a keep-alive request.
- keyStore(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The file location of the private key in JKS or PKCS#12 format.
- keyStorePassword(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The password of the
Cluster.Builder.keyStore
, ornull
if it's not password-protected. - keyStoreType(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
L
- language(String) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
Sets the language identifier to be sent on the request.
- loadBalancingStrategy(LoadBalancingStrategy) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Specifies the load balancing strategy to use on the client side.
- LoadBalancingStrategy - Interface in org.apache.tinkerpop.gremlin.driver
-
Provides a method for selecting the host from a
Cluster
. - LoadBalancingStrategy.RoundRobin - Class in org.apache.tinkerpop.gremlin.driver
-
A simple round-robin strategy that simply selects the next host in the
Cluster
to send theRequestMessage
to.
M
- main(String[]) - Static method in class examples.BasicGremlin
- main(String[]) - Static method in class examples.Connections
- main(String[]) - Static method in class examples.ModernTraversals
- main(String[]) - Static method in class org.apache.tinkerpop.gremlin.driver.util.ConfigurationEvaluator
- main(String[]) - Static method in class org.apache.tinkerpop.gremlin.driver.util.ProfilingApplication
- maintainStateAfterException() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings
- maintainStateAfterException(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings.Builder
-
When
true
an exception within a session will not close the session and remove the state bound to that session. - makeDefaultAliasMap(String) - Method in class org.apache.tinkerpop.gremlin.driver.Client
- manageTransactions() - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings
-
If enabled, transactions will be "managed" such that each request will represent a complete transaction.
- manageTransactions(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings.Builder
-
If enabled, transactions will be "managed" such that each request will represent a complete transaction.
- materializeProperties(String) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
Sets the materializeProperties identifier to be sent on the request.
- maxConnectionPoolSize() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the maximum size that the
ConnectionPool
can grow. - maxConnectionPoolSize(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The maximum size that the
ConnectionPool
can grow. - maxContentLength(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The maximum size in bytes of any request sent to the server.
- maxInProcessPerConnection(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The maximum number of in-flight requests that can occur on a
Connection
. - maxSimultaneousUsagePerConnection() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the maximum number of times that a
Connection
can be borrowed from the pool simultaneously. - maxSimultaneousUsagePerConnection(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The maximum number of times that a
Connection
can be borrowed from the pool simultaneously. - maxWaitForClose(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The amount of time in milliseconds to wait the connection to close before timing out where the default value is 3000.
- maxWaitForConnection(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The maximum amount of time to wait for a connection to be borrowed from the connection pool.
- minConnectionPoolSize() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the minimum size of the
ConnectionPool
. - minConnectionPoolSize(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The minimum size of the
ConnectionPool
. - minInProcessPerConnection(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The minimum number of in-flight requests that can occur on a
Connection
before it is considered for closing on return to theConnectionPool
. - minSimultaneousUsagePerConnection() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Gets the minimum number of times that a
Connection
should be borrowed from the pool before it falls under consideration for closing. - minSimultaneousUsagePerConnection(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The minimum number of times that a
Connection
should be borrowed from the pool before it falls under consideration for closing. - ModernTraversals - Class in examples
- ModernTraversals() - Constructor for class examples.ModernTraversals
N
- newHandshakeRequest() - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler.InterceptedWebSocketClientHandshaker13
- next() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTraversal
- nextTraverser() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTraversal
- nioPoolSize(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Size of the pool for handling request/response operations.
- NO_OP - Static variable in interface org.apache.tinkerpop.gremlin.driver.HandshakeInterceptor
-
Deprecated.The default implementation of a
HandshakeInterceptor
and behaves as a no-op. - NO_OP - Static variable in interface org.apache.tinkerpop.gremlin.driver.RequestInterceptor
-
The default implementation of a
RequestInterceptor
and behaves as a no-op. - NoHostAvailableException - Exception in org.apache.tinkerpop.gremlin.driver.exception
- NoHostAvailableException() - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.NoHostAvailableException
- NoHostAvailableException(String) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.NoHostAvailableException
- NoHostAvailableException(Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.NoHostAvailableException
O
- onAvailable(Host) - Method in interface org.apache.tinkerpop.gremlin.driver.Host.Listener
- onAvailable(Host) - Method in class org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy.RoundRobin
- onClose(Consumer<Transaction>) - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- one() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
Get the next
Result
from the stream, blocking until one is available. - onNew(Host) - Method in interface org.apache.tinkerpop.gremlin.driver.Host.Listener
- onNew(Host) - Method in class org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy.RoundRobin
- onReadWrite(Consumer<Transaction>) - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
This
Transaction
implementation is not auto-managed and therefore this method is not supported. - onRemove(Host) - Method in interface org.apache.tinkerpop.gremlin.driver.Host.Listener
- onRemove(Host) - Method in class org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy.RoundRobin
- onUnavailable(Host) - Method in interface org.apache.tinkerpop.gremlin.driver.Host.Listener
- onUnavailable(Host) - Method in class org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy.RoundRobin
- open() - Static method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Create a
Cluster
with all default settings which will connect to one contact point atlocalhost
. - open() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
By virtue of creating a
DriverRemoteTransaction
, the transaction is considered open. - open(String) - Static method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Create a
Cluster
using a YAML-based configuration file. - open(Configuration) - Static method in class org.apache.tinkerpop.gremlin.driver.Cluster
-
Create a
Cluster
from Apache Configurations. - org.apache.tinkerpop.gremlin.driver - package org.apache.tinkerpop.gremlin.driver
- org.apache.tinkerpop.gremlin.driver.exception - package org.apache.tinkerpop.gremlin.driver.exception
- org.apache.tinkerpop.gremlin.driver.handler - package org.apache.tinkerpop.gremlin.driver.handler
- org.apache.tinkerpop.gremlin.driver.remote - package org.apache.tinkerpop.gremlin.driver.remote
- org.apache.tinkerpop.gremlin.driver.simple - package org.apache.tinkerpop.gremlin.driver.simple
- org.apache.tinkerpop.gremlin.driver.util - package org.apache.tinkerpop.gremlin.driver.util
- overrideRequestId(UUID) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
Overrides the identifier to be sent on the request.
P
- PASSWORD - org.apache.tinkerpop.gremlin.driver.AuthProperties.Property
-
The password.
- path(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The path to the Gremlin service on the host which is "/gremlin" by default.
- PIPELINE_GREMLIN_HANDLER - Static variable in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- PIPELINE_GREMLIN_SASL_HANDLER - Static variable in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- PIPELINE_SSL_HANDLER - Static variable in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- port(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Sets the port that the Gremlin Servers will be listening on.
- ProfilingApplication - Class in org.apache.tinkerpop.gremlin.driver.util
-
An internal application used to test out configuration parameters for Gremlin Driver.
- ProfilingApplication(String, Cluster, int, ExecutorService, String, int, boolean) - Constructor for class org.apache.tinkerpop.gremlin.driver.util.ProfilingApplication
- protocol(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Sets the
AuthProperties.Property.PROTOCOL
properties for authentication to Gremlin Server. - PROTOCOL - org.apache.tinkerpop.gremlin.driver.AuthProperties.Property
-
The protocol for which the authentication is being performed (e.g., "ldap").
R
- readWrite() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
This
Transaction
implementation is not auto-managed and therefore this method is not supported. - reconnectInterval(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Time in milliseconds to wait between retries when attempting to reconnect to a dead host.
- removeTransactionListener(Consumer<Transaction.Status>) - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
There is no support for remote transaction listeners.
- requestInterceptor(RequestInterceptor) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Specifies an
HandshakeInterceptor
that will allow manipulation of theFullHttpRequest
prior to its being sent to the server. - RequestInterceptor - Interface in org.apache.tinkerpop.gremlin.driver
-
This function is called a
FullHttpRequest
constructed and allow it to be modified as needed before it is sent to the server. - RequestOptions - Class in org.apache.tinkerpop.gremlin.driver
-
Options that can be supplied on a per request basis.
- RequestOptions.Builder - Class in org.apache.tinkerpop.gremlin.driver
- ResponseException - Exception in org.apache.tinkerpop.gremlin.driver.exception
- ResponseException(ResponseStatusCode, String) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.ResponseException
- ResponseException(ResponseStatusCode, String, List<String>, String) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.ResponseException
- ResponseException(ResponseStatusCode, String, List<String>, String, Map<String, Object>) - Constructor for exception org.apache.tinkerpop.gremlin.driver.exception.ResponseException
- Result - Class in org.apache.tinkerpop.gremlin.driver
-
A
Result
represents a result value from the server-sideIterator
of results. - Result(Object) - Constructor for class org.apache.tinkerpop.gremlin.driver.Result
-
Constructs a "result" from data found in
ResponseResult.getData()
. - resultIterationBatchSize(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Override the server setting that determines how many results are returned per batch.
- ResultSet - Class in org.apache.tinkerpop.gremlin.driver
-
A
ResultSet
is returned from the submission of a Gremlin script to the server and represents the results provided by the server. - ResultSet(ResultQueue, ExecutorService, CompletableFuture<Void>, RequestMessage, Host) - Constructor for class org.apache.tinkerpop.gremlin.driver.ResultSet
- rollback() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- RoundRobin() - Constructor for class org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy.RoundRobin
S
- select(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy.RoundRobin
- select(RequestMessage) - Method in interface org.apache.tinkerpop.gremlin.driver.LoadBalancingStrategy
-
Provide an ordered list of hosts to send the given
RequestMessage
to. - serializer(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Set the
MessageSerializer
to use given the exact name of aSerializers
enum. - serializer(MessageSerializer<?>) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Sets the
MessageSerializer
to use. - serializer(Serializers) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Set the
MessageSerializer
to use via theSerializers
enum. - sessionId(String) - Method in class org.apache.tinkerpop.gremlin.driver.Client.SessionSettings.Builder
-
Provides the identifier of the session.
- settings - Variable in class org.apache.tinkerpop.gremlin.driver.Client
- SimpleClient - Interface in org.apache.tinkerpop.gremlin.driver.simple
- some(int) - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
The returned
CompletableFuture
completes when the number of items specified are available. - sslCipherSuites(List<String>) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
A list of cipher suites to enable.
- sslContext(SslContext) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Explicitly set the
SslContext
for when more flexibility is required in the configuration than is allowed by theCluster.Builder
. - sslEnabledProtocols(List<String>) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
A list of SSL protocols to enable.
- sslSkipCertValidation(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
If true, trust all certificates and do not perform any validation.
- statusAttributes() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
Returns a future that will complete when
ResultSet.allItemsAvailable()
istrue
and will contain the attributes from the response. - stream() - Method in class org.apache.tinkerpop.gremlin.driver.ResultSet
-
Stream items with a blocking iterator.
- submit(String) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Submits a Gremlin script to the server and returns a
ResultSet
once the write of the request is complete. - submit(String) - Method in interface org.apache.tinkerpop.gremlin.driver.simple.SimpleClient
- submit(String, String) - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Submits a Gremlin script to the server and returns a
ResultSet
once the write of the request is complete. - submit(String, String, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Submits a Gremlin script and bound parameters to the server and returns a
ResultSet
once the write of the request is complete. - submit(String, Consumer<ResponseMessage>) - Method in interface org.apache.tinkerpop.gremlin.driver.simple.SimpleClient
- submit(String, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Submits a Gremlin script and bound parameters to the server and returns a
ResultSet
once the write of the request is complete. - submit(String, RequestOptions) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Submits a Gremlin script to the server and returns a
ResultSet
once the write of the request is complete. - submit(Bytecode) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Submit a
Bytecode
to the server for remote execution. - submit(Bytecode, RequestOptions) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
A version of
Client.submit(Bytecode)
which provides the ability to set per-request options. - submit(Traversal) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Submit a
Traversal
to the server for remote execution.Results are returned asTraverser
instances and are therefore bulked, meaning that to properly iterate the contents of the result eachTraverser.bulk()
must be examined to determine the number of times that object should be presented in iteration. - submit(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.simple.AbstractClient
- submit(RequestMessage) - Method in interface org.apache.tinkerpop.gremlin.driver.simple.SimpleClient
- submit(RequestMessage, Consumer<ResponseMessage>) - Method in class org.apache.tinkerpop.gremlin.driver.simple.AbstractClient
- submit(RequestMessage, Consumer<ResponseMessage>) - Method in interface org.apache.tinkerpop.gremlin.driver.simple.SimpleClient
- submitAsync(String) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
The asynchronous version of
Client.submit(String)
where the returned future will complete when the write of the request completes. - submitAsync(String) - Method in interface org.apache.tinkerpop.gremlin.driver.simple.SimpleClient
- submitAsync(String, String, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Deprecated.As of release 3.4.0, replaced by
Client.submitAsync(String, RequestOptions)
. - submitAsync(String, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
The asynchronous version of
Client.submit(String, Map)
} where the returned future will complete when the write of the request completes. - submitAsync(String, Map<String, String>, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
Deprecated.As of release 3.4.0, replaced by
Client.submitAsync(String, RequestOptions)
. - submitAsync(String, RequestOptions) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
The asynchronous version of
Client.submit(String, RequestOptions)
} where the returned future will complete when the write of the request completes. - submitAsync(Bytecode) - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- submitAsync(Bytecode) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
An asynchronous version of
Client.submit(Traversal)
. - submitAsync(Bytecode) - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
- submitAsync(Bytecode) - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
- submitAsync(Bytecode, RequestOptions) - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- submitAsync(Bytecode, RequestOptions) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
A version of
Client.submit(Bytecode)
which provides the ability to set per-request options. - submitAsync(Traversal) - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- submitAsync(Traversal) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
An asynchronous version of
Client.submit(Traversal)
. - submitAsync(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.Client.AliasClusteredClient
- submitAsync(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.Client
-
A low-level method that allows the submission of a manually constructed
RequestMessage
. - submitAsync(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.simple.AbstractClient
- submitAsync(RequestMessage) - Method in interface org.apache.tinkerpop.gremlin.driver.simple.SimpleClient
- supportsSsl() - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.AbstractChannelizer
- supportsSsl() - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.HttpChannelizer
- supportsSsl() - Method in class org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer
T
- timeout(long) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
The per client request override in milliseconds for the server configured
evaluationTimeout
. - TOO_MANY_IN_FLIGHT_REQUESTS - Static variable in class org.apache.tinkerpop.gremlin.driver.Client
- toString() - Method in class org.apache.tinkerpop.gremlin.driver.Cluster
- toString() - Method in class org.apache.tinkerpop.gremlin.driver.Host
- toString() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
- toString() - Method in class org.apache.tinkerpop.gremlin.driver.Result
- trustStore(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The file location for a SSL Certificate Chain to use when SSL is enabled.
- trustStorePassword(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
The password of the
Cluster.Builder.trustStore
, ornull
if it's not password-protected. - trustStoreType(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
- tryReInitializeHost(Host) - Method in class org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient
-
Attempt to re-initialize the
Host
that was previously marked as unavailable. - tx() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Constructs a new
DriverRemoteTransaction
. - tx() - Method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteTransaction
-
It is not possible to have child transactions, therefore this method always returns
Transaction.NO_OP
.
U
- USER_AGENT - Static variable in class org.apache.tinkerpop.gremlin.driver.UserAgent
-
User Agent body to be sent in web socket handshake Has the form of: [Application Name] [GLV Name]/[Version] [Language Runtime Version] [OS]/[Version] [CPU Architecture]
- USER_AGENT_HEADER_NAME - Static variable in class org.apache.tinkerpop.gremlin.driver.UserAgent
-
Request header name for user agent
- userAgent(String) - Method in class org.apache.tinkerpop.gremlin.driver.RequestOptions.Builder
-
Sets the userAgent identifier to be sent on the request.
- UserAgent - Class in org.apache.tinkerpop.gremlin.driver
- UserAgent() - Constructor for class org.apache.tinkerpop.gremlin.driver.UserAgent
- userEventTriggered(ChannelHandlerContext, Object) - Method in class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler
- USERNAME - org.apache.tinkerpop.gremlin.driver.AuthProperties.Property
-
The username.
- useSession(boolean) - Method in class org.apache.tinkerpop.gremlin.driver.Client.Settings.Builder
-
Enables a session.
- useSession(String) - Method in class org.apache.tinkerpop.gremlin.driver.Client.Settings.Builder
-
Enables a session.
- useSession(Client.SessionSettings) - Method in class org.apache.tinkerpop.gremlin.driver.Client.Settings.Builder
-
Enables a session.
- using(String) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
using a newCluster
instance created from the supplied configuration file. - using(String, int) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
using a newCluster
instance created from the supplied host and port and binds it to a remoteGraphTraversalSource
named "g". - using(String, int, String) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
using a newCluster
instance created from the supplied host port and aliases it to the specified remoteGraphTraversalSource
. - using(String, String) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
using a newCluster
instance created from the supplied configuration file. - using(Configuration) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
using an ApacheConfiguration
object. - using(Client) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
using an existingClient
object. - using(Client, String) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
using an existingClient
object. - using(Cluster) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
from an existingCluster
instance. - using(Cluster, String) - Static method in class org.apache.tinkerpop.gremlin.driver.remote.DriverRemoteConnection
-
Creates a
DriverRemoteConnection
from an existingCluster
instance.
V
- validationRequest(String) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Specify a valid Gremlin script that can be used to test remote operations.
- valueOf(String) - Static method in enum org.apache.tinkerpop.gremlin.driver.AuthProperties.Property
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.tinkerpop.gremlin.driver.AuthProperties.Property
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WebSocketChannelizer() - Constructor for class org.apache.tinkerpop.gremlin.driver.Channelizer.WebSocketChannelizer
- WebSocketClient - Class in org.apache.tinkerpop.gremlin.driver.simple
-
A simple, non-thread safe Gremlin Server client using websockets.
- WebSocketClient() - Constructor for class org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient
- WebSocketClient(URI) - Constructor for class org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient
- WebSocketClientHandler - Class in org.apache.tinkerpop.gremlin.driver.handler
-
Wrapper over
WebSocketClientProtocolHandler
. - WebSocketClientHandler(WebSocketClientHandshaker, long, boolean) - Constructor for class org.apache.tinkerpop.gremlin.driver.handler.WebSocketClientHandler
- WebSocketClientHandler.InterceptedWebSocketClientHandshaker13 - Class in org.apache.tinkerpop.gremlin.driver.handler
-
Extension to the Netty implementation that allows for the
WebSocketClientHandler.InterceptedWebSocketClientHandshaker13.newHandshakeRequest()
to be modified by way of aHandshakeInterceptor
that is supplied to theCluster
when it is created. - WebSocketGremlinRequestEncoder - Class in org.apache.tinkerpop.gremlin.driver.handler
- WebSocketGremlinRequestEncoder(boolean, MessageSerializer<?>) - Constructor for class org.apache.tinkerpop.gremlin.driver.handler.WebSocketGremlinRequestEncoder
- WebSocketGremlinResponseDecoder - Class in org.apache.tinkerpop.gremlin.driver.handler
- WebSocketGremlinResponseDecoder(MessageSerializer<?>) - Constructor for class org.apache.tinkerpop.gremlin.driver.handler.WebSocketGremlinResponseDecoder
- with(AuthProperties.Property, String) - Method in class org.apache.tinkerpop.gremlin.driver.AuthProperties
-
Adds a
AuthProperties.Property
with value to the authorization property set. - workerPoolSize(int) - Method in class org.apache.tinkerpop.gremlin.driver.Cluster.Builder
-
Size of the pool for handling background work.
- writeAndFlush(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.simple.AbstractClient
- writeAndFlush(RequestMessage) - Method in class org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient
All Classes All Packages