Class GraphTraversal<TStart, TEnd>

Graph traversals are the primary way in which graphs are processed.

Inheritance
object
DefaultTraversal<TStart, TEnd>
GraphTraversal<TStart, TEnd>
Implements
ITraversal<TStart, TEnd>
Inherited Members
Namespace: Gremlin.Net.Process.Traversal
Assembly: Gremlin.Net.dll
Syntax
public class GraphTraversal<TStart, TEnd> : DefaultTraversal<TStart, TEnd>, ITraversal<TStart, TEnd>, ITraversal, IEnumerator<TEnd?>, IEnumerator, IDisposable
Type Parameters
Name Description
TStart
TEnd

Constructors

GraphTraversal()

Initializes a new instance of the GraphTraversal<TStart, TEnd> class.

Declaration
public GraphTraversal()

GraphTraversal(ICollection<ITraversalStrategy>, Bytecode)

Initializes a new instance of the GraphTraversal<TStart, TEnd> class.

Declaration
public GraphTraversal(ICollection<ITraversalStrategy> traversalStrategies, Bytecode bytecode)
Parameters
Type Name Description
ICollection<ITraversalStrategy> traversalStrategies

The traversal strategies to be used by this graph traversal at evaluation time.
Bytecode bytecode

The Bytecode associated with the construction of this graph traversal.

Properties

Bytecode

Gets the Bytecode representation of this traversal.

Declaration
public override Bytecode Bytecode { get; }
Property Value
Type Description
Bytecode
Overrides

Methods

AddE(ITraversal)

Adds the addE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> AddE(ITraversal edgeLabelTraversal)
Parameters
Type Name Description
ITraversal edgeLabelTraversal
Returns
Type Description
GraphTraversal<TStart, Edge>

AddE(string)

Adds the addE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> AddE(string edgeLabel)
Parameters
Type Name Description
string edgeLabel
Returns
Type Description
GraphTraversal<TStart, Edge>

AddV()

Adds the addV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> AddV()
Returns
Type Description
GraphTraversal<TStart, Vertex>

AddV(ITraversal)

Adds the addV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> AddV(ITraversal vertexLabelTraversal)
Parameters
Type Name Description
ITraversal vertexLabelTraversal
Returns
Type Description
GraphTraversal<TStart, Vertex>

AddV(string)

Adds the addV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> AddV(string vertexLabel)
Parameters
Type Name Description
string vertexLabel
Returns
Type Description
GraphTraversal<TStart, Vertex>

Aggregate(Scope, string)

Adds the aggregate step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Aggregate(Scope scope, string sideEffectKey)
Parameters
Type Name Description
Scope scope
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

Aggregate(string)

Adds the aggregate step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Aggregate(string sideEffectKey)
Parameters
Type Name Description
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

All(P?)

Adds the all step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> All(P? predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

And(params ITraversal[])

Adds the and step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> And(params ITraversal[] andTraversals)
Parameters
Type Name Description
ITraversal[] andTraversals
Returns
Type Description
GraphTraversal<TStart, TEnd>

Any(P?)

Adds the any step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Any(P? predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

As(string, params string[])

Adds the as step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> As(string stepLabel, params string[] stepLabels)
Parameters
Type Name Description
string stepLabel
string[] stepLabels
Returns
Type Description
GraphTraversal<TStart, TEnd>

AsDate()

Adds the asDate step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, DateTimeOffset> AsDate()
Returns
Type Description
GraphTraversal<TStart, DateTimeOffset>

AsString()

Adds the asString step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> AsString()
Returns
Type Description
GraphTraversal<TStart, string>

AsString<TNewEnd>(Scope)

Adds the asString step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> AsString<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Barrier()

Adds the barrier step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Barrier()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Barrier(IConsumer)

Adds the barrier step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Barrier(IConsumer barrierConsumer)
Parameters
Type Name Description
IConsumer barrierConsumer
Returns
Type Description
GraphTraversal<TStart, TEnd>

Barrier(int)

Adds the barrier step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Barrier(int maxBarrierSize)
Parameters
Type Name Description
int maxBarrierSize
Returns
Type Description
GraphTraversal<TStart, TEnd>

Both(params string?[])

Adds the both step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> Both(params string?[] edgeLabels)
Parameters
Type Name Description
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Vertex>

BothE(params string?[])

Adds the bothE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> BothE(params string?[] edgeLabels)
Parameters
Type Name Description
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Edge>

BothV()

Adds the bothV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> BothV()
Returns
Type Description
GraphTraversal<TStart, Vertex>

Branch<TNewEnd>(IFunction?)

Adds the branch step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Branch<TNewEnd>(IFunction? function)
Parameters
Type Name Description
IFunction function
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Branch<TNewEnd>(ITraversal)

Adds the branch step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Branch<TNewEnd>(ITraversal branchTraversal)
Parameters
Type Name Description
ITraversal branchTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

By()

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By()
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(IComparator comparator)
Parameters
Type Name Description
IComparator comparator
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(IFunction)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(IFunction function)
Parameters
Type Name Description
IFunction function
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(IFunction, IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(IFunction function, IComparator comparator)
Parameters
Type Name Description
IFunction function
IComparator comparator
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(ITraversal)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(ITraversal traversal)
Parameters
Type Name Description
ITraversal traversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(ITraversal, IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(ITraversal traversal, IComparator comparator)
Parameters
Type Name Description
ITraversal traversal
IComparator comparator
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(Order)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(Order order)
Parameters
Type Name Description
Order order
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(T)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(T token)
Parameters
Type Name Description
T token
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(string?)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(string? key)
Parameters
Type Name Description
string key
Returns
Type Description
GraphTraversal<TStart, TEnd>

By(string?, IComparator)

Adds the by step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> By(string? key, IComparator comparator)
Parameters
Type Name Description
string key
IComparator comparator
Returns
Type Description
GraphTraversal<TStart, TEnd>

Call<TNewEnd>(string?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service)
Parameters
Type Name Description
string service
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Call<TNewEnd>(string?, ITraversal?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service, ITraversal? t)
Parameters
Type Name Description
string service
ITraversal t
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Call<TNewEnd>(string?, IDictionary<object, object>?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service, IDictionary<object, object>? m)
Parameters
Type Name Description
string service
IDictionary<object, object> m
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Call<TNewEnd>(string?, IDictionary<object, object>?, ITraversal?)

Adds the call step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Call<TNewEnd>(string? service, IDictionary<object, object>? m, ITraversal? t)
Parameters
Type Name Description
string service
IDictionary<object, object> m
ITraversal t
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Cap<TNewEnd>(string, params string[])

Adds the cap step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Cap<TNewEnd>(string sideEffectKey, params string[] sideEffectKeys)
Parameters
Type Name Description
string sideEffectKey
string[] sideEffectKeys
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Choose<TNewEnd>(IFunction)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(IFunction choiceFunction)
Parameters
Type Name Description
IFunction choiceFunction
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Choose<TNewEnd>(IPredicate, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(IPredicate choosePredicate, ITraversal trueChoice)
Parameters
Type Name Description
IPredicate choosePredicate
ITraversal trueChoice
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Choose<TNewEnd>(IPredicate, ITraversal, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(IPredicate choosePredicate, ITraversal trueChoice, ITraversal falseChoice)
Parameters
Type Name Description
IPredicate choosePredicate
ITraversal trueChoice
ITraversal falseChoice
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Choose<TNewEnd>(ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(ITraversal choiceTraversal)
Parameters
Type Name Description
ITraversal choiceTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Choose<TNewEnd>(ITraversal, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(ITraversal traversalPredicate, ITraversal trueChoice)
Parameters
Type Name Description
ITraversal traversalPredicate
ITraversal trueChoice
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Choose<TNewEnd>(ITraversal, ITraversal, ITraversal)

Adds the choose step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Choose<TNewEnd>(ITraversal traversalPredicate, ITraversal trueChoice, ITraversal falseChoice)
Parameters
Type Name Description
ITraversal traversalPredicate
ITraversal trueChoice
ITraversal falseChoice
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Clone()

Make a copy of a traversal that is reset for iteration.

Declaration
public GraphTraversal<TStart, TEnd> Clone()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Coalesce<TNewEnd>(params ITraversal[])

Adds the coalesce step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Coalesce<TNewEnd>(params ITraversal[] coalesceTraversals)
Parameters
Type Name Description
ITraversal[] coalesceTraversals
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Coin(double)

Adds the coin step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Coin(double probability)
Parameters
Type Name Description
double probability
Returns
Type Description
GraphTraversal<TStart, TEnd>

Combine(object)

Adds the combine step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Combine(object combineObject)
Parameters
Type Name Description
object combineObject
Returns
Type Description
GraphTraversal<TStart, TEnd>

Concat(ITraversal, params ITraversal[]?)

Adds the concat step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string> Concat(ITraversal concatTraversal, params ITraversal[]? otherConcatTraversals)
Parameters
Type Name Description
ITraversal concatTraversal
ITraversal[] otherConcatTraversals
Returns
Type Description
GraphTraversal<TStart, string>

Concat(params string?[])

Adds the concat step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string> Concat(params string?[] concatStrings)
Parameters
Type Name Description
string[] concatStrings
Returns
Type Description
GraphTraversal<TStart, string>

Conjoin(string)

Adds the conjoin step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd?> Conjoin(string delimiter)
Parameters
Type Name Description
string delimiter
Returns
Type Description
GraphTraversal<TStart, TEnd>

ConnectedComponent()

Adds the connectedComponent step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> ConnectedComponent()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Constant<TNewEnd>(TNewEnd)

Adds the constant step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Constant<TNewEnd>(TNewEnd e)
Parameters
Type Name Description
TNewEnd e
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Count()

Adds the count step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, long> Count()
Returns
Type Description
GraphTraversal<TStart, long>

Count(Scope)

Adds the count step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, long> Count(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, long>

CyclicPath()

Adds the cyclicPath step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> CyclicPath()
Returns
Type Description
GraphTraversal<TStart, TEnd>

DateAdd(DT, int)

Adds the dateAdd step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, DateTimeOffset> DateAdd(DT dateToken, int value)
Parameters
Type Name Description
DT dateToken
int value
Returns
Type Description
GraphTraversal<TStart, DateTimeOffset>

DateDiff(ITraversal)

Adds the dateDiff step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, long> DateDiff(ITraversal dateTraversal)
Parameters
Type Name Description
ITraversal dateTraversal
Returns
Type Description
GraphTraversal<TStart, long>

DateDiff(DateTimeOffset)

Adds the dateDiff step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, long> DateDiff(DateTimeOffset value)
Parameters
Type Name Description
DateTimeOffset value
Returns
Type Description
GraphTraversal<TStart, long>

Dedup(Scope, params string?[])

Adds the dedup step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Dedup(Scope scope, params string?[] dedupLabels)
Parameters
Type Name Description
Scope scope
string[] dedupLabels
Returns
Type Description
GraphTraversal<TStart, TEnd>

Dedup(params string?[])

Adds the dedup step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Dedup(params string?[] dedupLabels)
Parameters
Type Name Description
string[] dedupLabels
Returns
Type Description
GraphTraversal<TStart, TEnd>

Difference(object)

Adds the difference step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Difference(object differenceObject)
Parameters
Type Name Description
object differenceObject
Returns
Type Description
GraphTraversal<TStart, TEnd>

Disjunct(object)

Adds the disjunct step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Disjunct(object disjunctObject)
Parameters
Type Name Description
object disjunctObject
Returns
Type Description
GraphTraversal<TStart, TEnd>

Drop()

Adds the drop step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Drop()
Returns
Type Description
GraphTraversal<TStart, TEnd>

E(params object?[]?)

Adds the E step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> E(params object?[]? edgeIdsOrElements)
Parameters
Type Name Description
object[] edgeIdsOrElements
Returns
Type Description
GraphTraversal<TStart, Edge>

Element()

Adds the element step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Element> Element()
Returns
Type Description
GraphTraversal<TStart, Element>

ElementMap<TNewEnd>(params string?[])

Adds the elementMap step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<object, TNewEnd>> ElementMap<TNewEnd>(params string?[] propertyKeys)
Parameters
Type Name Description
string[] propertyKeys
Returns
Type Description
GraphTraversal<TStart, IDictionary<object, TNewEnd>>
Type Parameters
Name Description
TNewEnd

Emit()

Adds the emit step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Emit()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Emit(IPredicate)

Adds the emit step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Emit(IPredicate emitPredicate)
Parameters
Type Name Description
IPredicate emitPredicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Emit(ITraversal)

Adds the emit step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Emit(ITraversal emitTraversal)
Parameters
Type Name Description
ITraversal emitTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

Fail()

Adds the fail step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Fail()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Fail(string?)

Adds the fail step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Fail(string? msg)
Parameters
Type Name Description
string msg
Returns
Type Description
GraphTraversal<TStart, TEnd>

Fail(string?, IDictionary<string, object>)

Adds the fail step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Fail(string? msg, IDictionary<string, object> m)
Parameters
Type Name Description
string msg
IDictionary<string, object> m
Returns
Type Description
GraphTraversal<TStart, TEnd>

Filter(IPredicate?)

Adds the filter step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Filter(IPredicate? predicate)
Parameters
Type Name Description
IPredicate predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Filter(ITraversal)

Adds the filter step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Filter(ITraversal filterTraversal)
Parameters
Type Name Description
ITraversal filterTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

FlatMap<TNewEnd>(IFunction?)

Adds the flatMap step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> FlatMap<TNewEnd>(IFunction? function)
Parameters
Type Name Description
IFunction function
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

FlatMap<TNewEnd>(ITraversal)

Adds the flatMap step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> FlatMap<TNewEnd>(ITraversal flatMapTraversal)
Parameters
Type Name Description
ITraversal flatMapTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Fold()

Adds the fold step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IList<TEnd>> Fold()
Returns
Type Description
GraphTraversal<TStart, IList<TEnd>>

Fold<TNewEnd>(TNewEnd, IBiFunction?)

Adds the fold step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Fold<TNewEnd>(TNewEnd seed, IBiFunction? foldFunction)
Parameters
Type Name Description
TNewEnd seed
IBiFunction foldFunction
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Format(string)

Adds the format step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string> Format(string format)
Parameters
Type Name Description
string format
Returns
Type Description
GraphTraversal<TStart, string>

From(ITraversal)

Adds the from step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> From(ITraversal fromVertex)
Parameters
Type Name Description
ITraversal fromVertex
Returns
Type Description
GraphTraversal<TStart, TEnd>

From(Vertex?)

Adds the from step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> From(Vertex? fromVertex)
Parameters
Type Name Description
Vertex fromVertex
Returns
Type Description
GraphTraversal<TStart, TEnd>

From(string?)

Adds the from step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> From(string? fromStepLabel)
Parameters
Type Name Description
string fromStepLabel
Returns
Type Description
GraphTraversal<TStart, TEnd>

Group(string)

Adds the group step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Group(string sideEffectKey)
Parameters
Type Name Description
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

GroupCount(string)

Adds the groupCount step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> GroupCount(string sideEffectKey)
Parameters
Type Name Description
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

GroupCount<K>()

Adds the groupCount step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<K, long>> GroupCount<K>()
Returns
Type Description
GraphTraversal<TStart, IDictionary<K, long>>
Type Parameters
Name Description
K

Group<K, V>()

Adds the group step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<K, V>> Group<K, V>()
Returns
Type Description
GraphTraversal<TStart, IDictionary<K, V>>
Type Parameters
Name Description
K
V

Has(T, ITraversal)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(T accessor, ITraversal propertyTraversal)
Parameters
Type Name Description
T accessor
ITraversal propertyTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(T, P?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(T accessor, P? predicate)
Parameters
Type Name Description
T accessor
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(T, object?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(T accessor, object? value)
Parameters
Type Name Description
T accessor
object value
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(string?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(string? propertyKey)
Parameters
Type Name Description
string propertyKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(string?, ITraversal)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(string? propertyKey, ITraversal propertyTraversal)
Parameters
Type Name Description
string propertyKey
ITraversal propertyTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(string?, P?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(string? propertyKey, P? predicate)
Parameters
Type Name Description
string propertyKey
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(string?, object?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(string? propertyKey, object? value)
Parameters
Type Name Description
string propertyKey
object value
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(string?, string?, P?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(string? label, string? propertyKey, P? predicate)
Parameters
Type Name Description
string label
string propertyKey
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Has(string?, string?, object?)

Adds the has step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Has(string? label, string? propertyKey, object? value)
Parameters
Type Name Description
string label
string propertyKey
object value
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasId(P?)

Adds the hasId step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasId(P? predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasId(object?, params object?[]?)

Adds the hasId step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasId(object? id, params object?[]? otherIds)
Parameters
Type Name Description
object id
object[] otherIds
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasKey(P?)

Adds the hasKey step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasKey(P? predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasKey(string?, params string?[]?)

Adds the hasKey step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasKey(string? label, params string?[]? otherLabels)
Parameters
Type Name Description
string label
string[] otherLabels
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasLabel(P?)

Adds the hasLabel step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasLabel(P? predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasLabel(string?, params string?[]?)

Adds the hasLabel step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasLabel(string? label, params string?[]? otherLabels)
Parameters
Type Name Description
string label
string[] otherLabels
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasNot(string?)

Adds the hasNot step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasNot(string? propertyKey)
Parameters
Type Name Description
string propertyKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasValue(P?)

Adds the hasValue step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasValue(P? predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

HasValue(object?, params object?[]?)

Adds the hasValue step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> HasValue(object? value, params object?[]? otherValues)
Parameters
Type Name Description
object value
object[] otherValues
Returns
Type Description
GraphTraversal<TStart, TEnd>

Id()

Adds the id step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, object> Id()
Returns
Type Description
GraphTraversal<TStart, object>

Identity()

Adds the identity step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Identity()
Returns
Type Description
GraphTraversal<TStart, TEnd>

In(params string?[])

Adds the in step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> In(params string?[] edgeLabels)
Parameters
Type Name Description
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Vertex>

InE(params string?[])

Adds the inE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> InE(params string?[] edgeLabels)
Parameters
Type Name Description
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Edge>

InV()

Adds the inV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> InV()
Returns
Type Description
GraphTraversal<TStart, Vertex>

Index<TNewEnd>()

Adds the index step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Index<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Inject(params TEnd?[]?)

Adds the inject step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Inject(params TEnd?[]? injections)
Parameters
Type Name Description
TEnd[] injections
Returns
Type Description
GraphTraversal<TStart, TEnd>

Intersect(object)

Adds the intersect step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Intersect(object intersectObject)
Parameters
Type Name Description
object intersectObject
Returns
Type Description
GraphTraversal<TStart, TEnd>

Is(P?)

Adds the is step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Is(P? predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Is(object?)

Adds the is step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Is(object? value)
Parameters
Type Name Description
object value
Returns
Type Description
GraphTraversal<TStart, TEnd>

Key()

Adds the key step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string> Key()
Returns
Type Description
GraphTraversal<TStart, string>

LTrim()

Adds the lTrim step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> LTrim()
Returns
Type Description
GraphTraversal<TStart, string>

LTrim<TNewEnd>(Scope)

Adds the lTrim step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> LTrim<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Label()

Adds the label step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string> Label()
Returns
Type Description
GraphTraversal<TStart, string>

Length()

Adds the length step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, int?> Length()
Returns
Type Description
GraphTraversal<TStart, int?>

Length<TNewEnd>(Scope)

Adds the length step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> Length<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Limit<TNewEnd>(Scope, long)

Adds the limit step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Limit<TNewEnd>(Scope scope, long limit)
Parameters
Type Name Description
Scope scope
long limit
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Limit<TNewEnd>(long)

Adds the limit step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Limit<TNewEnd>(long limit)
Parameters
Type Name Description
long limit
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Local<TNewEnd>(ITraversal)

Adds the local step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Local<TNewEnd>(ITraversal localTraversal)
Parameters
Type Name Description
ITraversal localTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Loops()

Adds the loops step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, int> Loops()
Returns
Type Description
GraphTraversal<TStart, int>

Loops(string?)

Adds the loops step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, int> Loops(string? loopName)
Parameters
Type Name Description
string loopName
Returns
Type Description
GraphTraversal<TStart, int>

Map<TNewEnd>(IFunction?)

Adds the map step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Map<TNewEnd>(IFunction? function)
Parameters
Type Name Description
IFunction function
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Map<TNewEnd>(ITraversal)

Adds the map step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Map<TNewEnd>(ITraversal mapTraversal)
Parameters
Type Name Description
ITraversal mapTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Match<TNewEnd>(params ITraversal[])

Adds the match step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Match<TNewEnd>(params ITraversal[] matchTraversals)
Parameters
Type Name Description
ITraversal[] matchTraversals
Returns
Type Description
GraphTraversal<TStart, IDictionary<string, TNewEnd>>
Type Parameters
Name Description
TNewEnd

Math(string)

Adds the math step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, double> Math(string expression)
Parameters
Type Name Description
string expression
Returns
Type Description
GraphTraversal<TStart, double>

Max<TNewEnd>()

Adds the max step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Max<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Max<TNewEnd>(Scope)

Adds the max step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Max<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Mean<TNewEnd>()

Adds the mean step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Mean<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Mean<TNewEnd>(Scope)

Adds the mean step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Mean<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Merge(object)

Adds the merge step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Merge(object mergeObject)
Parameters
Type Name Description
object mergeObject
Returns
Type Description
GraphTraversal<TStart, TEnd>

MergeE()

Adds the mergeE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> MergeE()
Returns
Type Description
GraphTraversal<TStart, Edge>

MergeE(ITraversal?)

Adds the mergeE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> MergeE(ITraversal? t)
Parameters
Type Name Description
ITraversal t
Returns
Type Description
GraphTraversal<TStart, Edge>

MergeE(IDictionary<object, object>?)

Adds the mergeE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> MergeE(IDictionary<object, object>? m)
Parameters
Type Name Description
IDictionary<object, object> m
Returns
Type Description
GraphTraversal<TStart, Edge>

MergeV()

Adds the mergeV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> MergeV()
Returns
Type Description
GraphTraversal<TStart, Vertex>

MergeV(ITraversal?)

Adds the mergeV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> MergeV(ITraversal? t)
Parameters
Type Name Description
ITraversal t
Returns
Type Description
GraphTraversal<TStart, Vertex>

MergeV(IDictionary<object, object>?)

Adds the mergeV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> MergeV(IDictionary<object, object>? m)
Parameters
Type Name Description
IDictionary<object, object> m
Returns
Type Description
GraphTraversal<TStart, Vertex>

Min<TNewEnd>()

Adds the min step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Min<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Min<TNewEnd>(Scope)

Adds the min step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Min<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

None()

Adds the none step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> None()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Not(ITraversal)

Adds the not step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Not(ITraversal notTraversal)
Parameters
Type Name Description
ITraversal notTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

Option(ITraversal?)

Adds the option step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Option(ITraversal? traversalOption)
Parameters
Type Name Description
ITraversal traversalOption
Returns
Type Description
GraphTraversal<TStart, TEnd>

Option(object, ITraversal?)

Adds the option step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Option(object pickToken, ITraversal? traversalOption)
Parameters
Type Name Description
object pickToken
ITraversal traversalOption
Returns
Type Description
GraphTraversal<TStart, TEnd>

Option(object, IDictionary<object, object>?)

Adds the option step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Option(object pickToken, IDictionary<object, object>? traversalOption)
Parameters
Type Name Description
object pickToken
IDictionary<object, object> traversalOption
Returns
Type Description
GraphTraversal<TStart, TEnd>

Option(object, IDictionary<object, object>, Cardinality)

Adds the option step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Option(object pickToken, IDictionary<object, object> traversalOption, Cardinality cardinality)
Parameters
Type Name Description
object pickToken
IDictionary<object, object> traversalOption
Cardinality cardinality
Returns
Type Description
GraphTraversal<TStart, TEnd>

Optional<TNewEnd>(ITraversal)

Adds the optional step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Optional<TNewEnd>(ITraversal optionalTraversal)
Parameters
Type Name Description
ITraversal optionalTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Or(params ITraversal[])

Adds the or step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Or(params ITraversal[] orTraversals)
Parameters
Type Name Description
ITraversal[] orTraversals
Returns
Type Description
GraphTraversal<TStart, TEnd>

Order()

Adds the order step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Order()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Order(Scope)

Adds the order step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Order(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TEnd>

OtherV()

Adds the otherV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> OtherV()
Returns
Type Description
GraphTraversal<TStart, Vertex>

Out(params string?[])

Adds the out step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> Out(params string?[] edgeLabels)
Parameters
Type Name Description
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Vertex>

OutE(params string?[])

Adds the outE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> OutE(params string?[] edgeLabels)
Parameters
Type Name Description
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Edge>

OutV()

Adds the outV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> OutV()
Returns
Type Description
GraphTraversal<TStart, Vertex>

PageRank()

Adds the pageRank step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> PageRank()
Returns
Type Description
GraphTraversal<TStart, TEnd>

PageRank(double)

Adds the pageRank step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> PageRank(double alpha)
Parameters
Type Name Description
double alpha
Returns
Type Description
GraphTraversal<TStart, TEnd>

Path()

Adds the path step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Path> Path()
Returns
Type Description
GraphTraversal<TStart, Path>

PeerPressure()

Adds the peerPressure step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> PeerPressure()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Product(object)

Adds the product step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Product(object productObject)
Parameters
Type Name Description
object productObject
Returns
Type Description
GraphTraversal<TStart, TEnd>

Profile(string)

Adds the profile step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Profile(string sideEffectKey)
Parameters
Type Name Description
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

Profile<TNewEnd>()

Adds the profile step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Profile<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Program(object)

Adds the program step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Program(object vertexProgram)
Parameters
Type Name Description
object vertexProgram
Returns
Type Description
GraphTraversal<TStart, TEnd>

Project<TNewEnd>(string?, params string?[])

Adds the project step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Project<TNewEnd>(string? projectKey, params string?[] otherProjectKeys)
Parameters
Type Name Description
string projectKey
string[] otherProjectKeys
Returns
Type Description
GraphTraversal<TStart, IDictionary<string, TNewEnd>>
Type Parameters
Name Description
TNewEnd

Properties<TNewEnd>(params string?[])

Adds the properties step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Properties<TNewEnd>(params string?[] propertyKeys)
Parameters
Type Name Description
string[] propertyKeys
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Property(Cardinality, object?, object?, params object?[])

Adds the property step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Property(Cardinality cardinality, object? key, object? value, params object?[] keyValues)
Parameters
Type Name Description
Cardinality cardinality
object key
object value
object[] keyValues
Returns
Type Description
GraphTraversal<TStart, TEnd>

Property(IDictionary)

Adds the property step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Property(IDictionary value)
Parameters
Type Name Description
IDictionary value
Returns
Type Description
GraphTraversal<TStart, TEnd>

Property(object?, object?, params object?[])

Adds the property step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Property(object? key, object? value, params object?[] keyValues)
Parameters
Type Name Description
object key
object value
object[] keyValues
Returns
Type Description
GraphTraversal<TStart, TEnd>

PropertyMap<TNewEnd>(params string?[])

Adds the propertyMap step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<string, TNewEnd>> PropertyMap<TNewEnd>(params string?[] propertyKeys)
Parameters
Type Name Description
string[] propertyKeys
Returns
Type Description
GraphTraversal<TStart, IDictionary<string, TNewEnd>>
Type Parameters
Name Description
TNewEnd

RTrim()

Adds the rTrim step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> RTrim()
Returns
Type Description
GraphTraversal<TStart, string>

RTrim<TNewEnd>(Scope)

Adds the rTrim step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> RTrim<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Range<TNewEnd>(Scope, long, long)

Adds the range step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Range<TNewEnd>(Scope scope, long low, long high)
Parameters
Type Name Description
Scope scope
long low
long high
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Range<TNewEnd>(long, long)

Adds the range step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Range<TNewEnd>(long low, long high)
Parameters
Type Name Description
long low
long high
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Read()

Adds the read step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Read()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Repeat(ITraversal)

Adds the repeat step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Repeat(ITraversal repeatTraversal)
Parameters
Type Name Description
ITraversal repeatTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

Repeat(string, ITraversal)

Adds the repeat step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Repeat(string loopName, ITraversal repeatTraversal)
Parameters
Type Name Description
string loopName
ITraversal repeatTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

Replace(string?, string?)

Adds the replace step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> Replace(string? oldChar, string? newChar)
Parameters
Type Name Description
string oldChar
string newChar
Returns
Type Description
GraphTraversal<TStart, string>

Replace<TNewEnd>(Scope, string?, string?)

Adds the replace step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> Replace<TNewEnd>(Scope scope, string? oldChar, string? newChar)
Parameters
Type Name Description
Scope scope
string oldChar
string newChar
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Reverse()

Adds the reverse step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Reverse()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Sack(IBiFunction)

Adds the sack step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Sack(IBiFunction sackOperator)
Parameters
Type Name Description
IBiFunction sackOperator
Returns
Type Description
GraphTraversal<TStart, TEnd>

Sack<TNewEnd>()

Adds the sack step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Sack<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Sample(Scope, int)

Adds the sample step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Sample(Scope scope, int amountToSample)
Parameters
Type Name Description
Scope scope
int amountToSample
Returns
Type Description
GraphTraversal<TStart, TEnd>

Sample(int)

Adds the sample step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Sample(int amountToSample)
Parameters
Type Name Description
int amountToSample
Returns
Type Description
GraphTraversal<TStart, TEnd>

Select<TNewEnd>(Column)

Adds the select step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, ICollection<TNewEnd>> Select<TNewEnd>(Column column)
Parameters
Type Name Description
Column column
Returns
Type Description
GraphTraversal<TStart, ICollection<TNewEnd>>
Type Parameters
Name Description
TNewEnd

Select<TNewEnd>(ITraversal)

Adds the select step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(ITraversal keyTraversal)
Parameters
Type Name Description
ITraversal keyTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Select<TNewEnd>(Pop, ITraversal)

Adds the select step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(Pop pop, ITraversal keyTraversal)
Parameters
Type Name Description
Pop pop
ITraversal keyTraversal
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Select<TNewEnd>(Pop, string?)

Adds the select step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(Pop pop, string? selectKey)
Parameters
Type Name Description
Pop pop
string selectKey
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Select<TNewEnd>(Pop, string?, string?, params string?[])

Adds the select step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Select<TNewEnd>(Pop pop, string? selectKey1, string? selectKey2, params string?[] otherSelectKeys)
Parameters
Type Name Description
Pop pop
string selectKey1
string selectKey2
string[] otherSelectKeys
Returns
Type Description
GraphTraversal<TStart, IDictionary<string, TNewEnd>>
Type Parameters
Name Description
TNewEnd

Select<TNewEnd>(string?)

Adds the select step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Select<TNewEnd>(string? selectKey)
Parameters
Type Name Description
string selectKey
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Select<TNewEnd>(string?, string?, params string?[])

Adds the select step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<string, TNewEnd>> Select<TNewEnd>(string? selectKey1, string? selectKey2, params string?[] otherSelectKeys)
Parameters
Type Name Description
string selectKey1
string selectKey2
string[] otherSelectKeys
Returns
Type Description
GraphTraversal<TStart, IDictionary<string, TNewEnd>>
Type Parameters
Name Description
TNewEnd

ShortestPath()

Adds the shortestPath step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Path> ShortestPath()
Returns
Type Description
GraphTraversal<TStart, Path>

SideEffect(IConsumer?)

Adds the sideEffect step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> SideEffect(IConsumer? consumer)
Parameters
Type Name Description
IConsumer consumer
Returns
Type Description
GraphTraversal<TStart, TEnd>

SideEffect(ITraversal)

Adds the sideEffect step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> SideEffect(ITraversal sideEffectTraversal)
Parameters
Type Name Description
ITraversal sideEffectTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

SimplePath()

Adds the simplePath step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> SimplePath()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Skip<TNewEnd>(Scope, long)

Adds the skip step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Skip<TNewEnd>(Scope scope, long skip)
Parameters
Type Name Description
Scope scope
long skip
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Skip<TNewEnd>(long)

Adds the skip step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Skip<TNewEnd>(long skip)
Parameters
Type Name Description
long skip
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Split(string?)

Adds the split step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, List<string>?> Split(string? splitChar)
Parameters
Type Name Description
string splitChar
Returns
Type Description
GraphTraversal<TStart, List<string>>

Split<TNewEnd>(Scope, string?)

Adds the split step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, List<TNewEnd>?> Split<TNewEnd>(Scope scope, string? splitChar)
Parameters
Type Name Description
Scope scope
string splitChar
Returns
Type Description
GraphTraversal<TStart, List<TNewEnd>>
Type Parameters
Name Description
TNewEnd

Store(string)

Adds the store step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Store(string sideEffectKey)
Parameters
Type Name Description
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

Subgraph(string)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> Subgraph(string sideEffectKey)
Parameters
Type Name Description
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, Edge>

Substring(int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> Substring(int startIndex)
Parameters
Type Name Description
int startIndex
Returns
Type Description
GraphTraversal<TStart, string>

Substring(int, int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> Substring(int startIndex, int endIndex)
Parameters
Type Name Description
int startIndex
int endIndex
Returns
Type Description
GraphTraversal<TStart, string>

Substring<TNewEnd>(Scope, int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> Substring<TNewEnd>(Scope scope, int startIndex)
Parameters
Type Name Description
Scope scope
int startIndex
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Substring<TNewEnd>(Scope, int, int)

Adds the subgraph step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> Substring<TNewEnd>(Scope scope, int startIndex, int endIndex)
Parameters
Type Name Description
Scope scope
int startIndex
int endIndex
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Sum<TNewEnd>()

Adds the sum step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Sum<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Sum<TNewEnd>(Scope)

Adds the sum step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Sum<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Tail<TNewEnd>()

Adds the tail step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Tail<TNewEnd>(Scope)

Adds the tail step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Tail<TNewEnd>(Scope, long)

Adds the tail step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>(Scope scope, long limit)
Parameters
Type Name Description
Scope scope
long limit
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Tail<TNewEnd>(long)

Adds the tail step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Tail<TNewEnd>(long limit)
Parameters
Type Name Description
long limit
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

TimeLimit(long)

Adds the timeLimit step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> TimeLimit(long timeLimit)
Parameters
Type Name Description
long timeLimit
Returns
Type Description
GraphTraversal<TStart, TEnd>

Times(int)

Adds the times step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Times(int maxLoops)
Parameters
Type Name Description
int maxLoops
Returns
Type Description
GraphTraversal<TStart, TEnd>

To(Direction?, params string?[])

Adds the to step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> To(Direction? direction, params string?[] edgeLabels)
Parameters
Type Name Description
Direction direction
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Vertex>

To(ITraversal)

Adds the to step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> To(ITraversal toVertex)
Parameters
Type Name Description
ITraversal toVertex
Returns
Type Description
GraphTraversal<TStart, TEnd>

To(Vertex?)

Adds the to step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> To(Vertex? toVertex)
Parameters
Type Name Description
Vertex toVertex
Returns
Type Description
GraphTraversal<TStart, TEnd>

To(string?)

Adds the to step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> To(string? toStepLabel)
Parameters
Type Name Description
string toStepLabel
Returns
Type Description
GraphTraversal<TStart, TEnd>

ToE(Direction?, params string?[])

Adds the toE step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Edge> ToE(Direction? direction, params string?[] edgeLabels)
Parameters
Type Name Description
Direction direction
string[] edgeLabels
Returns
Type Description
GraphTraversal<TStart, Edge>

ToLower()

Adds the toLower step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> ToLower()
Returns
Type Description
GraphTraversal<TStart, string>

ToLower<TNewEnd>(Scope)

Adds the toLower step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> ToLower<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

ToUpper()

Adds the toUpper step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> ToUpper()
Returns
Type Description
GraphTraversal<TStart, string>

ToUpper<TNewEnd>(Scope)

Adds the toUpper step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> ToUpper<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

ToV(Direction?)

Adds the toV step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> ToV(Direction? direction)
Parameters
Type Name Description
Direction direction
Returns
Type Description
GraphTraversal<TStart, Vertex>

Tree(string)

Adds the tree step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Tree(string sideEffectKey)
Parameters
Type Name Description
string sideEffectKey
Returns
Type Description
GraphTraversal<TStart, TEnd>

Tree<TNewEnd>()

Adds the tree step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Tree<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Trim()

Adds the trim step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, string?> Trim()
Returns
Type Description
GraphTraversal<TStart, string>

Trim<TNewEnd>(Scope)

Adds the trim step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd?> Trim<TNewEnd>(Scope scope)
Parameters
Type Name Description
Scope scope
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Unfold<TNewEnd>()

Adds the unfold step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Unfold<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Union<TNewEnd>(params ITraversal[])

Adds the union step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Union<TNewEnd>(params ITraversal[] unionTraversals)
Parameters
Type Name Description
ITraversal[] unionTraversals
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Until(IPredicate)

Adds the until step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Until(IPredicate untilPredicate)
Parameters
Type Name Description
IPredicate untilPredicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Until(ITraversal)

Adds the until step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Until(ITraversal untilTraversal)
Parameters
Type Name Description
ITraversal untilTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

V(params object?[]?)

Adds the V step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, Vertex> V(params object?[]? vertexIdsOrElements)
Parameters
Type Name Description
object[] vertexIdsOrElements
Returns
Type Description
GraphTraversal<TStart, Vertex>

ValueMap<TKey, TValue>(bool, params string?[])

Adds the valueMap step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<TKey, TValue>> ValueMap<TKey, TValue>(bool includeTokens, params string?[] propertyKeys)
Parameters
Type Name Description
bool includeTokens
string[] propertyKeys
Returns
Type Description
GraphTraversal<TStart, IDictionary<TKey, TValue>>
Type Parameters
Name Description
TKey
TValue

ValueMap<TKey, TValue>(params string?[])

Adds the valueMap step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, IDictionary<TKey, TValue>> ValueMap<TKey, TValue>(params string?[] propertyKeys)
Parameters
Type Name Description
string[] propertyKeys
Returns
Type Description
GraphTraversal<TStart, IDictionary<TKey, TValue>>
Type Parameters
Name Description
TKey
TValue

Value<TNewEnd>()

Adds the value step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Value<TNewEnd>()
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Values<TNewEnd>(params string?[])

Adds the values step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TNewEnd> Values<TNewEnd>(params string?[] propertyKeys)
Parameters
Type Name Description
string[] propertyKeys
Returns
Type Description
GraphTraversal<TStart, TNewEnd>
Type Parameters
Name Description
TNewEnd

Where(ITraversal)

Adds the where step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Where(ITraversal whereTraversal)
Parameters
Type Name Description
ITraversal whereTraversal
Returns
Type Description
GraphTraversal<TStart, TEnd>

Where(P)

Adds the where step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Where(P predicate)
Parameters
Type Name Description
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

Where(string, P)

Adds the where step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Where(string startKey, P predicate)
Parameters
Type Name Description
string startKey
P predicate
Returns
Type Description
GraphTraversal<TStart, TEnd>

With(string)

Adds the with step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> With(string key)
Parameters
Type Name Description
string key
Returns
Type Description
GraphTraversal<TStart, TEnd>

With(string, object?)

Adds the with step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> With(string key, object? value)
Parameters
Type Name Description
string key
object value
Returns
Type Description
GraphTraversal<TStart, TEnd>

Write()

Adds the write step to this GraphTraversal<TStart, TEnd>.

Declaration
public GraphTraversal<TStart, TEnd> Write()
Returns
Type Description
GraphTraversal<TStart, TEnd>

Implements