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 Detail

      • ARGS_BATCH_SIZE

        public static final String ARGS_BATCH_SIZE
        Argument name that allows definition of the number of iterations each ResponseMessage 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
      • ARGS_MAINTAIN_STATE_AFTER_EXCEPTION

        public static final String ARGS_MAINTAIN_STATE_AFTER_EXCEPTION
        Argument name that is intended to be used with a session which when its value is true makes it so that a processing error or request timeout will not close the session, but leave it to continue processing in whatever state it may hold. This argument only applies to the UnifiedChannelizer.
        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
      • STATUS_ATTRIBUTE_EXCEPTIONS

        public static final String STATUS_ATTRIBUTE_EXCEPTIONS
        Refers to the hierarchy of exception names for a particular exception thrown on the server.
        See Also:
        Constant Field Values
      • STATUS_ATTRIBUTE_STACK_TRACE

        public static final String STATUS_ATTRIBUTE_STACK_TRACE
        Refers to the stacktrace for an exception thrown on the server
        See Also:
        Constant Field Values
      • STATUS_ATTRIBUTE_WARNINGS

        public static final String STATUS_ATTRIBUTE_WARNINGS
        A ResultSet#statusAttributes() key for user-facing warnings.

        Implementations that set this key should consider using one of these two recommended value types:

        • A List implementation containing references for which String#valueOf(Object) produces a meaningful return value. For example, a list of strings.
        • Otherwise, any single non-list object for which String#valueOf(Object) produces a meaningful return value. For example, a string.
        See Also:
        Constant Field Values