Class ScriptRequestArguments

Represents parameters to pass to Gremlin Server for a ScriptRequestMessage.

Inheritance

System.Object

RequestArguments

ScriptRequestArguments

Inherited Members

RequestArguments.BatchSize

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace:Gremlin.Net.Messages

Assembly:Gremlin.Net.dll

Syntax

public class ScriptRequestArguments : RequestArguments

Properties

Aliases

Gets or sets aliases that allow to bind names of Graph and TraversalSource to other names.

Declaration

[JsonProperty(PropertyName = "aliases", NullValueHandling = NullValueHandling.Ignore)]
public Dictionary<string, string> Aliases { get; set; }

Property Value

Type

Description

System.Collections.Generic.Dictionary<System.String, System.String>

A System.Collections.Generic.Dictionary<TKey, TValue> that allows globally bound Graph and TraversalSource objects to be aliased to different variable names for purposes of the current request. The value represents the name of the global variable and its key represents the new binding name as it will be referenced in the Gremlin query. For example, if the Gremlin Server defines two TraversalSource instances named g1 and g2, it would be possible to send an alias pair with key of "g" and value of "g2" and thus allow the script to refer to "g2" simply as "g".

Bindings

Gets or sets the bindings for the GremlinScript.

Declaration

[JsonProperty(PropertyName = "bindings", NullValueHandling = NullValueHandling.Ignore)]
public Dictionary<string, object> Bindings { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	A System.Collections.Generic.Dictionary<TKey, TValue> to apply as variables in the context of the GremlinScript.

GremlinScript

Gets or sets the Gremlin script to evaluate.

Declaration

[JsonProperty(PropertyName = "gremlin")]
public string GremlinScript { get; set; }

Property Value

Type	Description
System.String	A System.String that contains the Gremlin script to evaluate.

Language

Gets or sets the flavor of Gremlin used (e.g. gremlin-groovy).

Declaration

[JsonProperty(PropertyName = "language", NullValueHandling = NullValueHandling.Ignore)]
public string Language { get; set; }

Property Value

Type	Description
System.String	The default value is null which results in the default value of gremlin-groovy being used.

ScriptEvaluationTimeoutInMs

Gets or sets the override for the server setting that determines the maximum time to wait for a script to execute on the server.

Declaration

[JsonProperty(PropertyName = "scriptEvaluationTimeout", NullValueHandling = NullValueHandling.Ignore)]
public long ? ScriptEvaluationTimeoutInMs { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>	The evaluation timeout value in milliseconds for this request message. The value can be null which avoids overriding the server setting.