Package org.apache.tinkerpop.gremlin.util

Class Tokens

java.lang.Object
org.apache.tinkerpop.gremlin.util.Tokens
public final class Tokens extends Object
String constants used in gremlin-driver and gremlin-server.
Author:
Stephen Mallette (http://stephen.genoprime.com)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Tokens.Headers
    String constants used in the HTTP API.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ARGS_BATCH_SIZE
    Argument name that allows definition of the number of iterations each HTTP chunk should contain - overrides the @{code resultIterationBatchSize} server setting.
    static final String
    ARGS_G
    Argument name that allows definition of alias names for Graph and TraversalSource objects on the remote system.
    static final String
    ARGS_GREMLIN
    Argument name that corresponds to the Gremlin to evaluate.
    static final String
    ARGS_LANGUAGE
    Argument name that allows definition of the flavor of Gremlin used (e.g.
    static final String
    ARGS_MATERIALIZE_PROPERTIES
    The name of the argument that allows to control the serialization of properties on the server.
    static final String
    ARGS_PARAMETERS
    Argument name that allows to provide a map of key/value pairs to apply as query parameters in the context of the Gremlin request sent to the server.
    static final String
    ARGS_TRANSACTION_ID
    Argument name for the transaction ID used to track multi-request transactions over HTTP.
    static final String
    ARGS_USER_AGENT
    A value that is a custom string that the user can pass to a server that might accept it for purpose of identifying the kind of client it came from.
    static final String
    BULK_RESULTS
    The key for server to bulk result as a form of optimization for driver requests.
    static final String
    MATERIALIZE_PROPERTIES_ALL
    The name of the value denoting that all properties of Element should be returned.
    static final String
    MATERIALIZE_PROPERTIES_TOKENS
    The name of the value denoting that only `ID` and `Label` of Element should be returned.
    static final String
    TIMEOUT_MILLIS
    The key for the per request server-side timeout in milliseconds.

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ARGS_BATCH_SIZE

      public static final String ARGS_BATCH_SIZE
      Argument name that allows definition of the number of iterations each HTTP chunk should contain - overrides the @{code resultIterationBatchSize} server setting.
      See Also:

    • ARGS_PARAMETERS

      public static final String ARGS_PARAMETERS
      Argument name that allows to provide a map of key/value pairs to apply as query parameters in the context of the Gremlin request sent to the server.
      See Also:

    • ARGS_G

      public static final String ARGS_G
      Argument name that allows definition of alias names for Graph and TraversalSource objects on the remote system.
      See Also:

    • ARGS_GREMLIN

      public static final String ARGS_GREMLIN
      Argument name that corresponds to the Gremlin to evaluate.
      See Also:

    • ARGS_LANGUAGE

      public static final String ARGS_LANGUAGE
      Argument name that allows definition of the flavor of Gremlin used (e.g. gremlin-groovy) to process the request.
      See Also:

    • ARGS_MATERIALIZE_PROPERTIES

      public static final String ARGS_MATERIALIZE_PROPERTIES
      The name of the argument that allows to control the serialization of properties on the server.
      See Also:

    • MATERIALIZE_PROPERTIES_ALL

      public static final String MATERIALIZE_PROPERTIES_ALL
      The name of the value denoting that all properties of Element should be returned. Should be used with ARGS_MATERIALIZE_PROPERTIES
      See Also:

    • MATERIALIZE_PROPERTIES_TOKENS

      public static final String MATERIALIZE_PROPERTIES_TOKENS
      The name of the value denoting that only `ID` and `Label` of Element should be returned. Should be used with ARGS_MATERIALIZE_PROPERTIES
      See Also:

    • TIMEOUT_MILLIS

      public static final String TIMEOUT_MILLIS
      The key for the per request server-side timeout in milliseconds. This overrides the server's configured default (timeoutMillis) and determines the maximum time a request is allowed to execute on the server before it times out.
      See Also:

    • BULK_RESULTS

      public static final String BULK_RESULTS
      The key for server to bulk result as a form of optimization for driver requests.
      See Also:

    • ARGS_USER_AGENT

      public static final String ARGS_USER_AGENT
      A value that is a custom string that the user can pass to a server that might accept it for purpose of identifying the kind of client it came from.
      See Also:

    • ARGS_TRANSACTION_ID

      public static final String ARGS_TRANSACTION_ID
      Argument name for the transaction ID used to track multi-request transactions over HTTP. The transaction ID is a UUID generated by the client at transaction begin time and included in every request within the transaction.
      See Also: