Package org.apache.tinkerpop.gremlin.driver

Interface RequestSubmitter

All Known Subinterfaces:
RemoteTransaction
All Known Implementing Classes:
Client, Client.AliasClusteredClient, Client.ClusteredClient, Client.PinnedClient
public interface RequestSubmitter
Defines the synchronous request submission contract for Gremlin requests.

This interface is implemented by both Client and transaction classes to ensure a consistent API for submitting Gremlin scripts. The synchronous nature of these methods means they block until the request completes.

For asynchronous submission, see RequestSubmitterAsync.

  • Method Summary

    Modifier and Type
    Method
    Description
    ResultSet
    submit(String gremlin)
    Submits a Gremlin script and blocks until the response is received.
    ResultSet
    submit(String gremlin, Map<String,Object> parameters)
    Submits a Gremlin script with bound parameters and blocks until the response is received.
    ResultSet
    submit(String gremlin, RequestOptions options)
    Submits a Gremlin script with request options and blocks until the response is received.

  • Method Details

    • submit

      ResultSet submit(String gremlin)
      Submits a Gremlin script and blocks until the response is received.
      Parameters:
      gremlin - the Gremlin script to execute
      Returns:
      the results of the script execution

    • submit

      ResultSet submit(String gremlin, Map<String,Object> parameters)
      Submits a Gremlin script with bound parameters and blocks until the response is received.

      Prefer this method over string concatenation when executing scripts with variable arguments, as parameterized scripts perform better.

      Parameters:
      gremlin - the Gremlin script to execute
      parameters - a map of parameters that will be bound to the script on execution
      Returns:
      the results of the script execution

    • submit

      ResultSet submit(String gremlin, RequestOptions options)
      Submits a Gremlin script with request options and blocks until the response is received.
      Parameters:
      gremlin - the Gremlin script to execute
      options - the options to supply for this request
      Returns:
      the results of the script execution