| Package | Description | 
|---|---|
| org.apache.tinkerpop.gremlin.driver | 
| Modifier and Type | Method and Description | 
|---|---|
| Cluster.Builder | Cluster.Builder. addContactPoint(String address)Adds the address of a Gremlin Server to the list of servers a  Clientwill try to contact to send
 requests to. | 
| Cluster.Builder | Cluster.Builder. addContactPoints(String... addresses)Add one or more the addresses of a Gremlin Servers to the list of servers a  Clientwill try to
 contact to send requests to. | 
| Cluster.Builder | Cluster.Builder. authProperties(AuthProperties authProps)Specifies parameters for authentication to Gremlin Server. | 
| static Cluster.Builder | Cluster. build() | 
| static Cluster.Builder | Cluster. build(File configurationFile) | 
| static Cluster.Builder | Cluster. build(String address) | 
| Cluster.Builder | Cluster.Builder. channelizer(Class channelizerClass)Specify the  Channelizerimplementation to use on the client when creating aConnection. | 
| Cluster.Builder | Cluster.Builder. channelizer(String channelizerClass)Specify the  Channelizerimplementation to use on the client when creating aConnection. | 
| Cluster.Builder | Cluster.Builder. connectionSetupTimeoutMillis(long connectionSetupTimeoutMillis)Sets the duration of time in milliseconds provided for connection setup to complete which includes WebSocket
 handshake and SSL handshake. | 
| Cluster.Builder | Cluster.Builder. credentials(String username,
           String password)Sets the  AuthProperties.Property.USERNAMEandAuthProperties.Property.PASSWORDproperties
 for authentication to Gremlin Server. | 
| Cluster.Builder | Cluster.Builder. enableSsl(boolean enable)Enables connectivity over SSL - note that the server should be configured with SSL turned on for this
 setting to work properly. | 
| Cluster.Builder | Cluster.Builder. handshakeInterceptor(HandshakeInterceptor interceptor)Specifies an  HandshakeInterceptorthat will allow manipulation of theFullHttpRequestprior to its being sent over the websocket. | 
| Cluster.Builder | Cluster.Builder. jaasEntry(String jaasEntry)Sets the  AuthProperties.Property.JAAS_ENTRYproperties for authentication to Gremlin Server. | 
| Cluster.Builder | Cluster.Builder. keepAliveInterval(long keepAliveInterval)Length of time in milliseconds to wait on an idle connection before sending a keep-alive request. | 
| Cluster.Builder | Cluster.Builder. keyStore(String keyStore)The file location of the private key in JKS or PKCS#12 format. | 
| Cluster.Builder | Cluster.Builder. keyStorePassword(String keyStorePassword)The password of the  keyStore, ornullif it's not password-protected. | 
| Cluster.Builder | Cluster.Builder. keyStoreType(String keyStoreType) | 
| Cluster.Builder | Cluster.Builder. loadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy)Specifies the load balancing strategy to use on the client side. | 
| Cluster.Builder | Cluster.Builder. maxConnectionPoolSize(int maxSize)The maximum size that the  ConnectionPoolcan grow. | 
| Cluster.Builder | Cluster.Builder. maxContentLength(int maxContentLength)The maximum size in bytes of any request sent to the server. | 
| Cluster.Builder | Cluster.Builder. maxInProcessPerConnection(int maxInProcessPerConnection)The maximum number of in-flight requests that can occur on a  Connection. | 
| Cluster.Builder | Cluster.Builder. maxSimultaneousUsagePerConnection(int maxSimultaneousUsagePerConnection)The maximum number of times that a  Connectioncan be borrowed from the pool simultaneously. | 
| Cluster.Builder | Cluster.Builder. maxWaitForClose(int maxWait)The amount of time in milliseconds to wait the connection to close before timing out where the default
 value is 3000. | 
| Cluster.Builder | Cluster.Builder. maxWaitForConnection(int maxWait)The maximum amount of time to wait for a connection to be borrowed from the connection pool. | 
| Cluster.Builder | Cluster.Builder. minConnectionPoolSize(int minSize)The minimum size of the  ConnectionPool. | 
| Cluster.Builder | Cluster.Builder. minInProcessPerConnection(int minInProcessPerConnection)The minimum number of in-flight requests that can occur on a  Connectionbefore it is considered
 for closing on return to theConnectionPool. | 
| Cluster.Builder | Cluster.Builder. minSimultaneousUsagePerConnection(int minSimultaneousUsagePerConnection)The minimum number of times that a  Connectionshould be borrowed from the pool before it falls
 under consideration for closing. | 
| Cluster.Builder | Cluster.Builder. nioPoolSize(int nioPoolSize)Size of the pool for handling request/response operations. | 
| Cluster.Builder | Cluster.Builder. path(String path)The path to the Gremlin service on the host which is "/gremlin" by default. | 
| Cluster.Builder | Cluster.Builder. port(int port)Sets the port that the Gremlin Servers will be listening on. | 
| Cluster.Builder | Cluster.Builder. protocol(String protocol)Sets the  AuthProperties.Property.PROTOCOLproperties for authentication to Gremlin Server. | 
| Cluster.Builder | Cluster.Builder. reconnectInterval(int interval)Time in milliseconds to wait between retries when attempting to reconnect to a dead host. | 
| Cluster.Builder | Cluster.Builder. resultIterationBatchSize(int size)Override the server setting that determines how many results are returned per batch. | 
| Cluster.Builder | Cluster.Builder. serializer(MessageSerializer<?> serializer)Sets the  MessageSerializerto use. | 
| Cluster.Builder | Cluster.Builder. serializer(Serializers mimeType)Set the  MessageSerializerto use via theSerializersenum. | 
| Cluster.Builder | Cluster.Builder. serializer(String mimeType)Set the  MessageSerializerto use given the exact name of aSerializersenum. | 
| Cluster.Builder | Cluster.Builder. sslCipherSuites(List<String> sslCipherSuites)A list of cipher suites to enable. | 
| Cluster.Builder | Cluster.Builder. sslContext(io.netty.handler.ssl.SslContext sslContext)Explicitly set the  SslContextfor when more flexibility is required in the configuration than is
 allowed by theCluster.Builder. | 
| Cluster.Builder | Cluster.Builder. sslEnabledProtocols(List<String> sslEnabledProtocols)A list of SSL protocols to enable. | 
| Cluster.Builder | Cluster.Builder. sslSkipCertValidation(boolean sslSkipCertValidation)If true, trust all certificates and do not perform any validation. | 
| Cluster.Builder | Cluster.Builder. trustStore(String trustStore)The file location for a SSL Certificate Chain to use when SSL is enabled. | 
| Cluster.Builder | Cluster.Builder. trustStorePassword(String trustStorePassword)The password of the  trustStore, ornullif it's not password-protected. | 
| Cluster.Builder | Cluster.Builder. trustStoreType(String trustStoreType) | 
| Cluster.Builder | Cluster.Builder. validationRequest(String script)Specify a valid Gremlin script that can be used to test remote operations. | 
| Cluster.Builder | Cluster.Builder. workerPoolSize(int workerPoolSize)Size of the pool for handling background work. | 
Copyright © 2013–2022 Apache Software Foundation. All rights reserved.