Package org.apache.tinkerpop.gremlin.util

Class Tokens

  • public final class Tokens
extends Object
    String constants used in gremlin-driver and gremlin-server.
    Author:
    Stephen Mallette (http://stephen.genoprime.com)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static 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 String ARGS_BINDINGS
      Argument name that allows to provide a map of key/value pairs to apply as variables in the context of the Gremlin request sent to the server.
      static String ARGS_EVAL_TIMEOUT
      Argument name that allows the override of the server setting that determines the maximum time to wait for a request to execute on the server.
      static String ARGS_G
      Argument name that allows definition of alias names for Graph and TraversalSource objects on the remote system.
      static String ARGS_GREMLIN
      Argument name that corresponds to the Gremlin to evaluate.
      static String ARGS_LANGUAGE
      Argument name that allows definition of the flavor of Gremlin used (e.g.
      static String ARGS_MATERIALIZE_PROPERTIES
      The name of the argument that allows to control the serialization of properties on the server.
      static 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 String BULK_RESULTS
      The key for server to bulk result as a form of optimization for driver requests.
      static String MATERIALIZE_PROPERTIES_ALL
      The name of the value denoting that all properties of Element should be returned.
      static String MATERIALIZE_PROPERTIES_TOKENS
      The name of the value denoting that only `ID` and `Label` of Element should be returned.
      static String TIMEOUT_MS
      The key for the per request server-side timeout in milliseconds.

    • Field Detail

      • 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:
        Constant Field Values

      • ARGS_BINDINGS

        public static final String ARGS_BINDINGS
        Argument name that allows to provide a map of key/value pairs to apply as variables in the context of the Gremlin request sent to the server.
        See Also:
        Constant Field Values

      • ARGS_GREMLIN

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

      • 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:
        Constant Field Values

      • ARGS_EVAL_TIMEOUT

        public static final String ARGS_EVAL_TIMEOUT
        Argument name that allows the override of the server setting that determines the maximum time to wait for a request to execute on the server.
        See Also:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • TIMEOUT_MS

        public static final String TIMEOUT_MS
        The key for the per request server-side timeout in milliseconds.
        See Also:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values