Modified: tinkerpop/site/dotnetdocs/3.5.5-SNAPSHOT/index.json URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.5.5-SNAPSHOT/index.json?rev=1906091&r1=1906090&r2=1906091&view=diff ============================================================================== --- tinkerpop/site/dotnetdocs/3.5.5-SNAPSHOT/index.json (original) +++ tinkerpop/site/dotnetdocs/3.5.5-SNAPSHOT/index.json Mon Dec 19 21:22:32 2022 @@ -2,7 +2,7 @@ "api/Gremlin.Net.Driver.ConnectionPoolSettings.html": { "href": "api/Gremlin.Net.Driver.ConnectionPoolSettings.html", "title": "Class ConnectionPoolSettings | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class ConnectionPoolSettings Holds settings for the Gremlin.Net.Driver.ConnectionPool . Inheritance System.Object ConnectionPoolSettings Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public class ConnectionPoolSettings Properties MaxInProcessPerConnection Gets or sets the maximum number of in-flight requests that can occur on a connection. Declaration public int MaxInProcessPerConnection { get; set; } Property Value Type Description System.Int32 Remarks The default value is 32. A is thrown if this limit is reached on all connections when a new request comes in. Exceptions Type Condition System.ArgumentOutOfRangeException The specified number is less than or equal to zero. PoolSi ze Gets or sets the size of the connection pool. Declaration public int PoolSize { get; set; } Property Value Type Description System.Int32 Remarks The default value is 4. Exceptions Type Condition System.ArgumentOutOfRangeException The specified pool size is less than or equal to zero. ReconnectionAttempts Gets or sets the number of attempts to get an open connection from the pool to submit a request. Declaration public int ReconnectionAttempts { get; set; } Property Value Type Description System.Int32 Remarks The driver always tries to reconnect to a server in the background after it has noticed that a connection is dead. This setting only specifies how often the driver will retry to get an open connection from its pool when no open connection is available to submit a request. These retries give the driver time to establish new connections to the server that might have been unavailable temporarily or that might have closed the connections, e.g., because they were idle for some tim e. The default value is 4. A is thrown if the server can still not be reached after this many retry attempts. Setting this to zero means that the exception is thrown immediately when no open connection is available to submit a request. The driver will however still try to reconnect to the server in the background for subsequent requests. Exceptions Type Condition System.ArgumentOutOfRangeException The number of attempts specified is less than zero. ReconnectionBaseDelay Gets or sets the base delay used for the exponential backoff for the reconnection attempts. Declaration public TimeSpan ReconnectionBaseDelay { get; set; } Property Value Type Description System.TimeSpan Remarks The driver employs an exponential backoff strategy that uses this base delay for its reconnection attempts. With a base delay of 100 ms for example, retries happen after 100 ms, 200 ms, 400 ms, 800 ms, and so on, assuming that enough ReconnectionAttempts are configured. The default value is 1 second. Exceptio ns Type Condition System.ArgumentOutOfRangeException The specified delay is negative or zero." + "keywords": "Class ConnectionPoolSettings Holds settings for the Gremlin.Net.Driver.ConnectionPool . Inheritance System.Object ConnectionPoolSettings Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public class ConnectionPoolSettings Properties EnableUserAgentOnConnect Gets or sets whether a connection pool will send a user agent during web socket handshakes Declaration public bool EnableUserAgentOnConnect { get; set; } Property Value Type Description System.Boolean Remarks The default value is true. When enabled, user agents will only be sent during the web socket handshake. User agent follows the form: [Application Name] [GLV Name].[Version] [Language Runtime Version] [OS].[Version] [CPU Arc hitecture] MaxInProcessPerConnection Gets or sets the maximum number of in-flight requests that can occur on a connection. Declaration public int MaxInProcessPerConnection { get; set; } Property Value Type Description System.Int32 Remarks The default value is 32. A is thrown if this limit is reached on all connections when a new request comes in. Exceptions Type Condition System.ArgumentOutOfRangeException The specified number is less than or equal to zero. PoolSize Gets or sets the size of the connection pool. Declaration public int PoolSize { get; set; } Property Value Type Description System.Int32 Remarks The default value is 4. Exceptions Type Condition System.ArgumentOutOfRangeException The specified pool size is less than or equal to zero. ReconnectionAttempts Gets or sets the number of attempts to get an open connection from the pool to submit a request. Declaration public int ReconnectionAttempts { get; set; } Property Value Type Description System.Int32 Remarks The driver a lways tries to reconnect to a server in the background after it has noticed that a connection is dead. This setting only specifies how often the driver will retry to get an open connection from its pool when no open connection is available to submit a request. These retries give the driver time to establish new connections to the server that might have been unavailable temporarily or that might have closed the connections, e.g., because they were idle for some time. The default value is 4. A is thrown if the server can still not be reached after this many retry attempts. Setting this to zero means that the exception is thrown immediately when no open connection is available to submit a request. The driver will however still try to reconnect to the server in the background for subsequent requests. Exceptions Type Condition System.ArgumentOutOfRangeException The number of attempts specified is less than zero. ReconnectionBaseDelay Gets or sets the base delay used for the exponential b ackoff for the reconnection attempts. Declaration public TimeSpan ReconnectionBaseDelay { get; set; } Property Value Type Description System.TimeSpan Remarks The driver employs an exponential backoff strategy that uses this base delay for its reconnection attempts. With a base delay of 100 ms for example, retries happen after 100 ms, 200 ms, 400 ms, 800 ms, and so on, assuming that enough ReconnectionAttempts are configured. The default value is 1 second. Exceptions Type Condition System.ArgumentOutOfRangeException The specified delay is negative or zero." }, "api/Gremlin.Net.Driver.Exceptions.ConnectionClosedException.html": { "href": "api/Gremlin.Net.Driver.Exceptions.ConnectionClosedException.html", @@ -37,12 +37,12 @@ "api/Gremlin.Net.Driver.GremlinClient.html": { "href": "api/Gremlin.Net.Driver.GremlinClient.html", "title": "Class GremlinClient | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class GremlinClient Provides a mechanism for submitting Gremlin requests to one Gremlin Server. Inheritance System.Object GremlinClient Implements IGremlinClient System.IDisposable Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public class GremlinClient : IGremlinClient, IDisposable Constructors GremlinClient(GremlinServer, GraphSONReader, GraphSONWriter, ConnectionPoolSettings, Action<ClientWebSocketOptions>, String) Initializes a new instance of the GremlinClient class for the specified Gremlin Server. Declaration [Obsolete(\"This constructor is obsolete. Use the constructor that takes a IMessageSerializer instead.\")] public GremlinClient(GremlinServer gremlinServer, GraphSON Reader graphSONReader, GraphSONWriter graphSONWriter, ConnectionPoolSettings connectionPoolSettings = null, Action<ClientWebSocketOptions> webSocketConfiguration = null, string sessionId = null) Parameters Type Name Description GremlinServer gremlinServer The GremlinServer the requests should be sent to. GraphSONReader graphSONReader A instance to read received GraphSON data. GraphSONWriter graphSONWriter a instance to write GraphSON data. ConnectionPoolSettings connectionPoolSettings The ConnectionPoolSettings for the connection pool. System.Action < ClientWebSocketOptions > webSocketConfiguration A delegate that will be invoked with the object used to configure WebSocket connections. System.String sessionId The session Id if Gremlin Client in session mode, defaults to null as session-less Client. GremlinClient(GremlinServer, GraphSONReader, GraphSONWriter, String, ConnectionPoolSettings, Action<ClientWebSocketOptions>, String) Initializes a new instance of the GremlinClient class for the specified Gremlin Server. Declaration [Obsolete(\"This constructor is obsolete. Use the constructor that takes a IMessageSerializer instead.\")] public GremlinClient(GremlinServer gremlinServer, GraphSONReader graphSONReader, GraphSONWriter graphSONWriter, string mimeType, ConnectionPoolSettings connectionPoolSettings = null, Action<ClientWebSocketOptions> webSocketConfiguration = null, string sessionId = null) Parameters Type Name Description GremlinServer gremlinServer The GremlinServer the requests should be sent to. GraphSONReader graphSONReader A instance to read received GraphSON data. GraphSONWriter graphSONWriter a instance to write GraphSON data. System.String mimeType The GraphSON version mime type, defaults to latest supported by the server. ConnectionPoolSettings connectionPoolSettings The ConnectionPoolSettings for the connection pool. System.Action < ClientWebSocketOptions > webSocketConfiguration A delegate that will be invoked with the object used to configur e WebSocket connections. System.String sessionId The session Id if Gremlin Client in session mode, defaults to null as session-less Client. GremlinClient(GremlinServer, IMessageSerializer, ConnectionPoolSettings, Action<ClientWebSocketOptions>, String, Boolean) Initializes a new instance of the GremlinClient class for the specified Gremlin Server. Declaration public GremlinClient(GremlinServer gremlinServer, IMessageSerializer messageSerializer = null, ConnectionPoolSettings connectionPoolSettings = null, Action<ClientWebSocketOptions> webSocketConfiguration = null, string sessionId = null, bool disableCompression = false) Parameters Type Name Description GremlinServer gremlinServer The GremlinServer the requests should be sent to. IMessageSerializer messageSerializer A IMessageSerializer instance to serialize messages sent to and received from the server. ConnectionPoolSettings connectionPoolSettings The ConnectionPoolSettings for the connection pool. System.Action < ClientWebSocke tOptions > webSocketConfiguration A delegate that will be invoked with the object used to configure WebSocket connections. System.String sessionId The session Id if Gremlin Client in session mode, defaults to null as session-less Client. System.Boolean disableCompression Whether to disable compression. Compression is only supported since .NET 6. There it is also enabled by default. Note that compression might make your application susceptible to attacks like CRIME/BREACH. Compression should therefore be turned off if your application sends sensitive data to the server as well as data that could potentially be controlled by an untrusted user. Properties NrConnections Gets the number of open connections. Declaration public int NrConnections { get; } Property Value Type Description System.Int32 Methods Dispose() Declaration public void Dispose() Dispose(Boolean) Releases the resources used by the GremlinClient instance. Declaration protected virtual void Dispose(bool disposing) Paramet ers Type Name Description System.Boolean disposing Specifies whether managed resources should be released. SubmitAsync<T>(RequestMessage) Declaration public async Task<ResultSet<T>> SubmitAsync<T>(RequestMessage requestMessage) Parameters Type Name Description RequestMessage requestMessage Returns Type Description System.Threading.Tasks.Task < ResultSet <T>> Type Parameters Name Description T Implements IGremlinClient System.IDisposable" + "keywords": "Class GremlinClient Provides a mechanism for submitting Gremlin requests to one Gremlin Server. Inheritance System.Object GremlinClient Implements IGremlinClient System.IDisposable Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public class GremlinClient : IGremlinClient, IDisposable Constructors GremlinClient(GremlinServer, GraphSONReader, GraphSONWriter, ConnectionPoolSettings, Action<ClientWebSocketOptions>, String) Initializes a new instance of the GremlinClient class for the specified Gremlin Server. Declaration [Obsolete(\"This constructor is obsolete. Use the constructor that takes a IMessageSerializer instead.\")] public GremlinClient(GremlinServer gremlinServer, GraphSON Reader graphSONReader, GraphSONWriter graphSONWriter, ConnectionPoolSettings connectionPoolSettings = null, Action<ClientWebSocketOptions> webSocketConfiguration = null, string sessionId = null) Parameters Type Name Description GremlinServer gremlinServer The GremlinServer the requests should be sent to. GraphSONReader graphSONReader A instance to read received GraphSON data. GraphSONWriter graphSONWriter a instance to write GraphSON data. ConnectionPoolSettings connectionPoolSettings The ConnectionPoolSettings for the connection pool. System.Action < ClientWebSocketOptions > webSocketConfiguration A delegate that will be invoked with the object used to configure WebSocket connections. System.String sessionId The session Id if Gremlin Client in session mode, defaults to null as session-less Client. GremlinClient(GremlinServer, GraphSONReader, GraphSONWriter, String, ConnectionPoolSettings, Action<ClientWebSocketOptions>, String) Initializes a new instance of the GremlinClient class for the specified Gremlin Server. Declaration [Obsolete(\"This constructor is obsolete. Use the constructor that takes a IMessageSerializer instead.\")] public GremlinClient(GremlinServer gremlinServer, GraphSONReader graphSONReader, GraphSONWriter graphSONWriter, string mimeType, ConnectionPoolSettings connectionPoolSettings = null, Action<ClientWebSocketOptions> webSocketConfiguration = null, string sessionId = null) Parameters Type Name Description GremlinServer gremlinServer The GremlinServer the requests should be sent to. GraphSONReader graphSONReader A instance to read received GraphSON data. GraphSONWriter graphSONWriter a instance to write GraphSON data. System.String mimeType The GraphSON version mime type, defaults to latest supported by the server. ConnectionPoolSettings connectionPoolSettings The ConnectionPoolSettings for the connection pool. System.Action < ClientWebSocketOptions > webSocketConfiguration A delegate that will be invoked with the object used to configur e WebSocket connections. System.String sessionId The session Id if Gremlin Client in session mode, defaults to null as session-less Client. GremlinClient(GremlinServer, IMessageSerializer, ConnectionPoolSettings, Action<ClientWebSocketOptions>, String, Boolean, ILoggerFactory) Initializes a new instance of the GremlinClient class for the specified Gremlin Server. Declaration public GremlinClient(GremlinServer gremlinServer, IMessageSerializer messageSerializer = null, ConnectionPoolSettings connectionPoolSettings = null, Action<ClientWebSocketOptions> webSocketConfiguration = null, string sessionId = null, bool disableCompression = false, ILoggerFactory loggerFactory = null) Parameters Type Name Description GremlinServer gremlinServer The GremlinServer the requests should be sent to. IMessageSerializer messageSerializer A IMessageSerializer instance to serialize messages sent to and received from the server. ConnectionPoolSettings connectionPoolSettings The ConnectionPoolSettings fo r the connection pool. System.Action < ClientWebSocketOptions > webSocketConfiguration A delegate that will be invoked with the object used to configure WebSocket connections. System.String sessionId The session Id if Gremlin Client in session mode, defaults to null as session-less Client. System.Boolean disableCompression Whether to disable compression. Compression is only supported since .NET 6. There it is also enabled by default. Note that compression might make your application susceptible to attacks like CRIME/BREACH. Compression should therefore be turned off if your application sends sensitive data to the server as well as data that could potentially be controlled by an untrusted user. ILoggerFactory loggerFactory A factory to create loggers. If not provided, then nothing will be logged. Properties NrConnections Gets the number of open connections. Declaration public int NrConnections { get; } Property Value Type Description System.Int32 Methods Dispose() Declaration public void Dispose() Dispose(Boolean) Releases the resources used by the GremlinClient instance. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Specifies whether managed resources should be released. SubmitAsync<T>(RequestMessage, CancellationToken) Declaration public async Task<ResultSet<T>> SubmitAsync<T>(RequestMessage requestMessage, CancellationToken cancellationToken = null) Parameters Type Name Description RequestMessage requestMessage CancellationToken cancellationToken Returns Type Description System.Threading.Tasks.Task < ResultSet <T>> Type Parameters Name Description T Implements IGremlinClient System.IDisposable" }, "api/Gremlin.Net.Driver.GremlinClientExtensions.html": { "href": "api/Gremlin.Net.Driver.GremlinClientExtensions.html", "title": "Class GremlinClientExtensions | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class GremlinClientExtensions Provides extension methods for the IGremlinClient interface. Inheritance System.Object GremlinClientExtensions Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public static class GremlinClientExtensions Methods SubmitAsync(IGremlinClient, RequestMessage) Submits a request message as an asynchronous operation without returning the result received from the Gremlin Server. Declaration public static async Task SubmitAsync(this IGremlinClient gremlinClient, RequestMessage requestMessage) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. RequestMessage requestMessage The to send. Returns Type Descript ion System.Threading.Tasks.Task The task object representing the asynchronous operation. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred. SubmitAsync(IGremlinClient, String, Dictionary<String, Object>) Submits a request message that consists of a script with bindings as an asynchronous operation without returning the result received from the Gremlin Server. Declaration public static async Task SubmitAsync(this IGremlinClient gremlinClient, string requestScript, Dictionary<string, object> bindings = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. System.String requestScript The Gremlin request script to send. Dictionary < System.String , System.Object > bindings Bindings for parameters used in the requestScript. Returns Type Description System.Threading.Tasks.Task The task object representing the asynchronous operation. Exceptions T ype Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred. SubmitAsync<T>(IGremlinClient, String, Dictionary<String, Object>) Submits a request message that consists of a script with bindings as an asynchronous operation. Declaration public static async Task<ResultSet<T>> SubmitAsync<T>(this IGremlinClient gremlinClient, string requestScript, Dictionary<string, object> bindings = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. System.String requestScript The Gremlin request script to send. Dictionary < System.String , System.Object > bindings Bindings for parameters used in the requestScript. Returns Type Description System.Threading.Tasks.Task < ResultSet <T>> A ResultSet<T> containing the data and status attributes returned from the server. Type Parameters Name Description T The type of the expected results. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred. SubmitWithSingleResultAsync<T>(IGremlinClient, RequestMessage) Submits a request message as an asynchronous operation where only a single result gets returned. Declaration public static async Task<T> SubmitWithSingleResultAsync<T>(this IGremlinClient gremlinClient, RequestMessage requestMessage) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. RequestMessage requestMessage The to send. Returns Type Description System.Threading.Tasks.Task <T> A single result received from the Gremlin Server. Type Parameters Name Description T The type of the expected result. Remarks If multiple results are received from Gremlin Server, then only the first gets returned. Use SubmitAsync<T>(IGremlinClient, String, Dictionary<String, Object>) instead when you expect a collection of results. Exceptions Type Condition ResponseException Thrown when a respo nse is received from Gremlin Server that indicates that an error occurred. SubmitWithSingleResultAsync<T>(IGremlinClient, String, Dictionary<String, Object>) Submits a request message that consists of a script with bindings as an asynchronous operation where only a single result gets returned. Declaration public static async Task<T> SubmitWithSingleResultAsync<T>(this IGremlinClient gremlinClient, string requestScript, Dictionary<string, object> bindings = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. System.String requestScript The Gremlin request script to send. Dictionary < System.String , System.Object > bindings Bindings for parameters used in the requestScript. Returns Type Description System.Threading.Tasks.Task <T> A single result received from the Gremlin Server. Type Parameters Name Description T The type of the expected result. Remarks If multiple results are received from Gremlin Server, then only the fir st gets returned. Use SubmitAsync<T>(IGremlinClient, String, Dictionary<String, Object>) instead when you expect a collection of results. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred." + "keywords": "Class GremlinClientExtensions Provides extension methods for the IGremlinClient interface. Inheritance System.Object GremlinClientExtensions Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public static class GremlinClientExtensions Methods SubmitAsync(IGremlinClient, RequestMessage, CancellationToken) Submits a request message as an asynchronous operation without returning the result received from the Gremlin Server. Declaration public static async Task SubmitAsync(this IGremlinClient gremlinClient, RequestMessage requestMessage, CancellationToken cancellationToken = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. R equestMessage requestMessage The to send. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task The task object representing the asynchronous operation. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred. SubmitAsync(IGremlinClient, String, Dictionary<String, Object>, CancellationToken) Submits a request message that consists of a script with bindings as an asynchronous operation without returning the result received from the Gremlin Server. Declaration public static async Task SubmitAsync(this IGremlinClient gremlinClient, string requestScript, Dictionary<string, object> bindings = null, CancellationToken cancellationToken = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. System.String requestScript The Gremlin request script to send. Dic tionary < System.String , System.Object > bindings Bindings for parameters used in the requestScript. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task The task object representing the asynchronous operation. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred. SubmitAsync<T>(IGremlinClient, String, Dictionary<String, Object>, CancellationToken) Submits a request message that consists of a script with bindings as an asynchronous operation. Declaration public static async Task<ResultSet<T>> SubmitAsync<T>(this IGremlinClient gremlinClient, string requestScript, Dictionary<string, object> bindings = null, CancellationToken cancellationToken = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. System.String requestScript The Gremlin request s cript to send. Dictionary < System.String , System.Object > bindings Bindings for parameters used in the requestScript. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task < ResultSet <T>> A ResultSet<T> containing the data and status attributes returned from the server. Type Parameters Name Description T The type of the expected results. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred. SubmitWithSingleResultAsync<T>(IGremlinClient, RequestMessage, CancellationToken) Submits a request message as an asynchronous operation where only a single result gets returned. Declaration public static async Task<T> SubmitWithSingleResultAsync<T>(this IGremlinClient gremlinClient, RequestMessage requestMessage, CancellationToken cancellationToken = null) Parameters Type Name Description IGremlinClient gremlinClie nt The IGremlinClient that submits the request. RequestMessage requestMessage The to send. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task <T> A single result received from the Gremlin Server. Type Parameters Name Description T The type of the expected result. Remarks If multiple results are received from Gremlin Server, then only the first gets returned. Use SubmitAsync<T>(IGremlinClient, String, Dictionary<String, Object>, CancellationToken) instead when you expect a collection of results. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred. SubmitWithSingleResultAsync<T>(IGremlinClient, String, Dictionary<String, Object>, CancellationToken) Submits a request message that consists of a script with bindings as an asynchronous operation where only a single result gets returned. Declaration public s tatic async Task<T> SubmitWithSingleResultAsync<T>(this IGremlinClient gremlinClient, string requestScript, Dictionary<string, object> bindings = null, CancellationToken cancellationToken = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. System.String requestScript The Gremlin request script to send. Dictionary < System.String , System.Object > bindings Bindings for parameters used in the requestScript. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task <T> A single result received from the Gremlin Server. Type Parameters Name Description T The type of the expected result. Remarks If multiple results are received from Gremlin Server, then only the first gets returned. Use SubmitAsync<T>(IGremlinClient, String, Dictionary<String, Object>, CancellationToken) instead when you expect a collection of results. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred." }, "api/Gremlin.Net.Driver.GremlinServer.html": { "href": "api/Gremlin.Net.Driver.GremlinServer.html", @@ -57,12 +57,12 @@ "api/Gremlin.Net.Driver.IGremlinClient.html": { "href": "api/Gremlin.Net.Driver.IGremlinClient.html", "title": "Interface IGremlinClient | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Interface IGremlinClient Provides a mechanism for submitting Gremlin requests. Inherited Members System.IDisposable.Dispose() Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public interface IGremlinClient : IDisposable Methods SubmitAsync<T>(RequestMessage) Submits a request message as an asynchronous operation. Declaration Task<ResultSet<T>> SubmitAsync<T>(RequestMessage requestMessage) Parameters Type Name Description RequestMessage requestMessage The to send. Returns Type Description System.Threading.Tasks.Task < ResultSet <T>> A ResultSet<T> containing the data and status attributes returned from the server. Type Parameters Name Description T The type of the expected results. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicates that an error occurred." + "keywords": "Interface IGremlinClient Provides a mechanism for submitting Gremlin requests. Inherited Members System.IDisposable.Dispose() Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public interface IGremlinClient : IDisposable Methods SubmitAsync<T>(RequestMessage, CancellationToken) Submits a request message as an asynchronous operation. Declaration Task<ResultSet<T>> SubmitAsync<T>(RequestMessage requestMessage, CancellationToken cancellationToken = null) Parameters Type Name Description RequestMessage requestMessage The to send. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task < ResultSet <T>> A ResultSet<T> containing the data and status attributes returned from the server. Type Parameters Name Description T The type of the expected results. Exceptions Type Condition ResponseException Thrown when a response is received from Gremlin Server that indicate s that an error occurred." }, "api/Gremlin.Net.Driver.IMessageSerializer.html": { "href": "api/Gremlin.Net.Driver.IMessageSerializer.html", "title": "Interface IMessageSerializer | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Interface IMessageSerializer Serializes data to and from Gremlin Server. Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public interface IMessageSerializer Methods DeserializeMessageAsync(Byte[]) Deserializes a from a byte array. Declaration Task<ResponseMessage<List<object>>> DeserializeMessageAsync(byte[] message) Parameters Type Name Description System.Byte [] message The serialized message to deserialize. Returns Type Description System.Threading.Tasks.Task < ResponseMessage < List < System.Object >>> The deserialized . SerializeMessageAsync(RequestMessage) Serializes a . Declaration Task<byte[]> SerializeMessageAsync(RequestMessage requestMessage) Parameters Type Name Description RequestMessage requestMessage The to serialize. Returns Type Description System.Threading.Tasks.Task < System.Byte []> The serialized message." + "keywords": "Interface IMessageSerializer Serializes data to and from Gremlin Server. Namespace : Gremlin.Net.Driver Assembly : cs.temp.dll.dll Syntax public interface IMessageSerializer Methods DeserializeMessageAsync(Byte[], CancellationToken) Deserializes a from a byte array. Declaration Task<ResponseMessage<List<object>>> DeserializeMessageAsync(byte[] message, CancellationToken cancellationToken = null) Parameters Type Name Description System.Byte [] message The serialized message to deserialize. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task < ResponseMessage < List < System.Object >>> The deserialized . SerializeMessageAsync(RequestMessage, CancellationToken) Serializes a . Declaration Task<byte[]> SerializeMessageAsync(RequestMessage requestMessage, CancellationToken cancellationToken = null) Parameters Type Name Description RequestMessage requestMessage The to seriali ze. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task < System.Byte []> The serialized message." }, "api/Gremlin.Net.Driver.Messages.html": { "href": "api/Gremlin.Net.Driver.Messages.html", @@ -102,7 +102,7 @@ "api/Gremlin.Net.Driver.Remote.DriverRemoteConnection.html": { "href": "api/Gremlin.Net.Driver.Remote.DriverRemoteConnection.html", "title": "Class DriverRemoteConnection | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class DriverRemoteConnection A implementation for Gremlin Server. Inheritance System.Object DriverRemoteConnection Implements System.IDisposable Namespace : Gremlin.Net.Driver.Remote Assembly : cs.temp.dll.dll Syntax public class DriverRemoteConnection : IRemoteConnection, IDisposable Constructors DriverRemoteConnection(IGremlinClient) Initializes a new using \"g\" as the default remote TraversalSource name. Declaration public DriverRemoteConnection(IGremlinClient client) Parameters Type Name Description IGremlinClient client The IGremlinClient that will be used for the connection. Exceptions Type Condition System.ArgumentNullException Thrown when client is null. DriverRemoteConnection(IGremlinClient, String) Initializes a new . Declaration public DriverRemoteConnection(IGremlinClient client, string traversalSource) Parameters Type Name Description IGremlinClient client The IGremlinClient that will be used for the connection. System.String traversalSource The name o f the traversal source on the server to bind to. Exceptions Type Condition System.ArgumentNullException Thrown when client is null. DriverRemoteConnection(String, Int32) Initializes a new using \"g\" as the default remote TraversalSource name. Declaration public DriverRemoteConnection(string host, int port) Parameters Type Name Description System.String host The host to connect to. System.Int32 port The port to connect to. Exceptions Type Condition System.ArgumentNullException Thrown when client is null. DriverRemoteConnection(String, Int32, String) Initializes a new . Declaration public DriverRemoteConnection(string host, int port, string traversalSource) Parameters Type Name Description System.String host The host to connect to. System.Int32 port The port to connect to. System.String traversalSource The name of the traversal source on the server to bind to. Exceptions Type Condition System.ArgumentNullException Thrown when client is null. Properties IsSessionBound Declaration publ ic bool IsSessionBound { get; } Property Value Type Description System.Boolean Methods Dispose() Declaration public void Dispose() SubmitAsync<S, E>(Bytecode) Submits for evaluation to a remote Gremlin Server. Declaration public async Task<ITraversal<S, E>> SubmitAsync<S, E>(Bytecode bytecode) Parameters Type Name Description Bytecode bytecode The to submit. Returns Type Description System.Threading.Tasks.Task < ITraversal <S, E>> A allowing to access the results and side-effects. Type Parameters Name Description S E Tx(GraphTraversalSource) Declaration public RemoteTransaction Tx(GraphTraversalSource g) Parameters Type Name Description GraphTraversalSource g Returns Type Description RemoteTransaction Implements System.IDisposable" + "keywords": "Class DriverRemoteConnection A implementation for Gremlin Server. Inheritance System.Object DriverRemoteConnection Implements System.IDisposable Namespace : Gremlin.Net.Driver.Remote Assembly : cs.temp.dll.dll Syntax public class DriverRemoteConnection : IRemoteConnection, IDisposable Constructors DriverRemoteConnection(IGremlinClient, String) Initializes a new . Declaration public DriverRemoteConnection(IGremlinClient client, string traversalSource = \"g\") Parameters Type Name Description IGremlinClient client The IGremlinClient that will be used for the connection. System.String traversalSource The name of the traversal source on the server to bind to. Exceptions Type Condition System.ArgumentNullException Thrown when client or the traversalSource is null. DriverRemoteConnection(String, Int32, String, ILoggerFactory) Initializes a new . Declaration public DriverRemoteConnection(string host, int port, string traversalSource = \"g\", ILoggerFactory loggerFactory = null) Parameters Type Name Description System.String host The host to connect to. System.Int32 port The port to connect to. System.String traversalSource The name of the traversal source on the server to bind to. ILoggerFactory loggerFactory A factory to create loggers. If not provided, then nothing will be logged. Exceptions Type Condition System.ArgumentNullException Thrown when client is null. Properties IsSessionBound Declaration public bool IsSessionBound { get; } Property Value Type Description System.Boolean Methods Dispose() Declaration public void Dispose() SubmitAsync<S, E>(Bytecode, CancellationToken) Submits for evaluation to a remote Gremlin Server. Declaration public async Task<ITraversal<S, E>> SubmitAsync<S, E>(Bytecode bytecode, CancellationToken cancellationToken = null) Parameters Type Name Description Bytecode bytecode The to submit. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.T hreading.Tasks.Task < ITraversal <S, E>> A allowing to access the results and side-effects. Type Parameters Name Description S E Tx(GraphTraversalSource) Declaration public RemoteTransaction Tx(GraphTraversalSource g) Parameters Type Name Description GraphTraversalSource g Returns Type Description RemoteTransaction Implements System.IDisposable" }, "api/Gremlin.Net.Driver.Remote.html": { "href": "api/Gremlin.Net.Driver.Remote.html", @@ -127,17 +127,17 @@ "api/Gremlin.Net.Process.Remote.IRemoteConnection.html": { "href": "api/Gremlin.Net.Process.Remote.IRemoteConnection.html", "title": "Interface IRemoteConnection | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Interface IRemoteConnection A simple abstraction of a \"connection\" to a \"server\". Namespace : Gremlin.Net.Process.Remote Assembly : cs.temp.dll.dll Syntax public interface IRemoteConnection Properties IsSessionBound Determines if the connection is bound to a session. Declaration bool IsSessionBound { get; } Property Value Type Description System.Boolean Methods SubmitAsync<S, E>(Bytecode) Submits to a server and returns a . Declaration Task<ITraversal<S, E>> SubmitAsync<S, E>(Bytecode bytecode) Parameters Type Name Description Bytecode bytecode The to send. Returns Type Description System.Threading.Tasks.Task < ITraversal <S, E>> The with the results and optional side-effects. Type Parameters Name Description S E Tx(GraphTraversalSource) Creates a RemoteTransaction in the context of a designed to work with remote semantics. Declaration RemoteTransaction Tx(GraphTraversalSource graphTraversalSource) Parameters Type Name Description GraphTraversalSource graphTrave rsalSource The providing the context for the RemoteTransaction . Returns Type Description RemoteTransaction The created RemoteTransaction ." + "keywords": "Interface IRemoteConnection A simple abstraction of a \"connection\" to a \"server\". Namespace : Gremlin.Net.Process.Remote Assembly : cs.temp.dll.dll Syntax public interface IRemoteConnection Properties IsSessionBound Determines if the connection is bound to a session. Declaration bool IsSessionBound { get; } Property Value Type Description System.Boolean Methods SubmitAsync<S, E>(Bytecode, CancellationToken) Submits to a server and returns a . Declaration Task<ITraversal<S, E>> SubmitAsync<S, E>(Bytecode bytecode, CancellationToken cancellationToken = null) Parameters Type Name Description Bytecode bytecode The to send. CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task < ITraversal <S, E>> The with the results and optional side-effects. Type Parameters Name Description S E Tx(GraphTraversalSource) Creates a RemoteTransaction in the context of a designed to work wi th remote semantics. Declaration RemoteTransaction Tx(GraphTraversalSource graphTraversalSource) Parameters Type Name Description GraphTraversalSource graphTraversalSource The providing the context for the RemoteTransaction . Returns Type Description RemoteTransaction The created RemoteTransaction ." }, "api/Gremlin.Net.Process.Remote.RemoteStrategy.html": { "href": "api/Gremlin.Net.Process.Remote.RemoteStrategy.html", "title": "Class RemoteStrategy | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class RemoteStrategy Reconstructs a by submitting it to a remote server via an IRemoteConnection instance. Inheritance System.Object RemoteStrategy Namespace : Gremlin.Net.Process.Remote Assembly : cs.temp.dll.dll Syntax public class RemoteStrategy : ITraversalStrategy Constructors RemoteStrategy(IRemoteConnection) Initializes a new instance of the RemoteStrategy class. Declaration public RemoteStrategy(IRemoteConnection remoteConnection) Parameters Type Name Description IRemoteConnection remoteConnection The IRemoteConnection that should be used. Methods Apply<S, E>(ITraversal<S, E>) Declaration public void Apply<S, E>(ITraversal<S, E> traversal) Parameters Type Name Description ITraversal <S, E> traversal Type Parameters Name Description S E ApplyAsync<S, E>(ITraversal<S, E>) Declaration public async Task ApplyAsync<S, E>(ITraversal<S, E> traversal) Parameters Type Name Description ITraversal <S, E> traversal Returns Type Description System.Threading.Tasks.Task Ty pe Parameters Name Description S E" + "keywords": "Class RemoteStrategy Reconstructs a by submitting it to a remote server via an IRemoteConnection instance. Inheritance System.Object RemoteStrategy Namespace : Gremlin.Net.Process.Remote Assembly : cs.temp.dll.dll Syntax public class RemoteStrategy : ITraversalStrategy Constructors RemoteStrategy(IRemoteConnection) Initializes a new instance of the RemoteStrategy class. Declaration public RemoteStrategy(IRemoteConnection remoteConnection) Parameters Type Name Description IRemoteConnection remoteConnection The IRemoteConnection that should be used. Methods Apply<S, E>(ITraversal<S, E>) Declaration public void Apply<S, E>(ITraversal<S, E> traversal) Parameters Type Name Description ITraversal <S, E> traversal Type Parameters Name Description S E ApplyAsync<S, E>(ITraversal<S, E>, CancellationToken) Declaration public async Task ApplyAsync<S, E>(ITraversal<S, E> traversal, CancellationToken cancellationToken = null) Parameters Type Name Description ITraversal <S, E> tr aversal CancellationToken cancellationToken Returns Type Description System.Threading.Tasks.Task Type Parameters Name Description S E" }, "api/Gremlin.Net.Process.Remote.RemoteTransaction.html": { "href": "api/Gremlin.Net.Process.Remote.RemoteTransaction.html", "title": "Class RemoteTransaction | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class RemoteTransaction A controller for a remote transaction that is constructed from g.Tx() . Calling Begin() on this object will produce a new GraphTraversalSource that is bound to a remote transaction over which multiple traversals may be executed in that context. Calling CommitAsync() or RollbackAsync() will then close the transaction and thus, the session. This feature only works with transaction enabled graphs. Inheritance System.Object RemoteTransaction Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Process.Remote Assembly : cs.temp.dll.dll Syntax public class RemoteTransaction Constructors RemoteTransaction(IRemoteConnection, GraphTraversalSource) Initializes a new instance of the RemoteTransaction class. Decla ration public RemoteTransaction(IRemoteConnection connection, GraphTraversalSource g) Parameters Type Name Description IRemoteConnection connection The session bound connection that will be used to control this transaction. GraphTraversalSource g The graph traversal source from which a session bound traversal source will be created. Methods Begin() Spawns a that is bound to a remote session which enables a transaction. Declaration public GraphTraversalSource Begin() Returns Type Description GraphTraversalSource A bound to a remote session. Exceptions Type Condition System.InvalidOperationException Thrown if this transaction is already bound to a session. CommitAsync() Commits the transaction. Declaration public async Task CommitAsync() Returns Type Description System.Threading.Tasks.Task RollbackAsync() Rolls back the transaction. Declaration public async Task RollbackAsync() Returns Type Description System.Threading.Tasks.Task" + "keywords": "Class RemoteTransaction A controller for a remote transaction that is constructed from g.Tx() . Calling Begin() on this object will produce a new GraphTraversalSource that is bound to a remote transaction over which multiple traversals may be executed in that context. Calling CommitAsync() or RollbackAsync() will then close the transaction and thus, the session. This feature only works with transaction enabled graphs. Inheritance System.Object RemoteTransaction Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Process.Remote Assembly : cs.temp.dll.dll Syntax public class RemoteTransaction Constructors RemoteTransaction(IRemoteConnection, GraphTraversalSource) Initializes a new instance of the RemoteTransaction class. Decla ration public RemoteTransaction(IRemoteConnection connection, GraphTraversalSource g) Parameters Type Name Description IRemoteConnection connection The session bound connection that will be used to control this transaction. GraphTraversalSource g The graph traversal source from which a session bound traversal source will be created. Methods Begin() Spawns a that is bound to a remote session which enables a transaction. Declaration public GraphTraversalSource Begin() Returns Type Description GraphTraversalSource A bound to a remote session. Exceptions Type Condition System.InvalidOperationException Thrown if this transaction is already bound to a session. CommitAsync(CancellationToken) Commits the transaction. Declaration public async Task CommitAsync(CancellationToken cancellationToken = null) Parameters Type Name Description CancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task Rollback Async() Rolls back the transaction. Declaration public async Task RollbackAsync() Returns Type Description System.Threading.Tasks.Task" }, "api/Gremlin.Net.Process.Traversal.__.html": { "href": "api/Gremlin.Net.Process.Traversal.__.html", @@ -167,7 +167,7 @@ "api/Gremlin.Net.Process.Traversal.Bytecode.html": { "href": "api/Gremlin.Net.Process.Traversal.Bytecode.html", "title": "Class Bytecode | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class Bytecode A language agnostic representation of ITraversal mutations. Inheritance System.Object Bytecode Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Process.Traversal Assembly : cs.temp.dll.dll Syntax public class Bytecode Remarks Bytecode is simply a list of ordered instructions. Bytecode can be serialized between environments and machines by way of a GraphSON representation. Thus, Gremlin.Net can create bytecode in C# and ship it to Gremlin-Java for evaluation in Java. Constructors Bytecode() Initializes a new instance of the Bytecode class. Declaration public Bytecode() Bytecode(Bytecode) Initializes a new instance of the Bytecode class. Declaration public Bytecode(Bytecode byteCode) Parameters Type Name Desc ription Bytecode byteCode Already existing Bytecode that should be cloned. Properties SourceInstructions Gets the traversal source instructions. Declaration public List<Instruction> SourceInstructions { get; } Property Value Type Description List < Instruction > StepInstructions Gets the ITraversal instructions. Declaration public List<Instruction> StepInstructions { get; } Property Value Type Description List < Instruction > Methods AddSource(String, Object[]) Add a traversal source instruction to the bytecode. Declaration public void AddSource(string sourceName, params object[] args) Parameters Type Name Description System.String sourceName The traversal source method name (e.g. withSack()). System.Object [] args The traversal source method arguments. AddStep(String, Object[]) Adds a ITraversal instruction to the bytecode. Declaration public void AddStep(string stepName, params object[] args) Parameters Type Name Description System.String stepName The traversal method name (e.g. o ut()). System.Object [] args The traversal method arguments." + "keywords": "Class Bytecode A language agnostic representation of ITraversal mutations. Inheritance System.Object Bytecode Inherited Members 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) Namespace : Gremlin.Net.Process.Traversal Assembly : cs.temp.dll.dll Syntax public class Bytecode Remarks Bytecode is simply a list of ordered instructions. Bytecode can be serialized between environments and machines by way of a GraphSON representation. Thus, Gremlin.Net can create bytecode in C# and ship it to Gremlin-Java for evaluation in Java. Constructors Bytecode() Initializes a new instance of the Bytecode class. Declaration public Bytecode() Bytecode(Bytecode) Initializes a new instance of the Bytecode class. Declaration public Bytecode(Bytecode byteCode) Parameters Type Name Description Bytecode byteCode Already existing Bytecode that should be cloned. Properties SourceInstructions Gets the traversal source instructions. Declaration public List<Instruction> SourceInstructions { get; } Property Value Type Description List < Instruction > StepInstructions Gets the ITraversal instructions. Declaration public List<Instruction> StepInstructions { get; } Property Value Type Description List < Instruction > Methods AddSource(String, Object[]) Add a traversal source instruction to the bytecode. Declaration public void AddSource(string sourceName, params object[] args) Parameters Type Name Description System.String sourceName The traversal source method name (e.g. withSack()). System.Object [] args The traversal source method arguments. AddStep(String, Object[]) Adds a ITraversal instruction to the bytecode. Declaration public void AddStep(string stepName, params object[] args) Parameters Type Name Description System.String stepName The traversal method name (e.g. out()). System.Object [] a rgs The traversal method arguments. ToString() Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString()" }, "api/Gremlin.Net.Process.Traversal.Cardinality.html": { "href": "api/Gremlin.Net.Process.Traversal.Cardinality.html", @@ -187,7 +187,7 @@ "api/Gremlin.Net.Process.Traversal.DefaultTraversal-2.html": { "href": "api/Gremlin.Net.Process.Traversal.DefaultTraversal-2.html", "title": "Class DefaultTraversal<S, E> | Apache TinkerPop - Gremlin.NET API Docs", - "keywords": "Class DefaultTraversal<S, E> A traversal represents a directed walk over a graph. Inheritance System.Object DefaultTraversal<S, E> GraphTraversal<S, E> Implements ITraversal <S, E> ITraversal IEnumerator IEnumerator <E> Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Process.Traversal Assembly : cs.temp.dll.dll Syntax public abstract class DefaultTraversal<S, E> : ITraversal<S, E>, ITraversal, IEnumerator, IEnumerator<E> Type Parameters Name Description S E Properties Bytecode Gets the Bytecode representation of this traversal. Declaration public Bytecode Bytecode { get; protected set; } Property Value Type Description Bytecode Current Declaration public E Current { get; } Property Value Type Description E IsAnonymous De termines if this traversal was spawned anonymously or not. Declaration public bool IsAnonymous { get; protected set; } Property Value Type Description System.Boolean TraversalStrategies Gets or sets the ITraversalStrategy strategies of this traversal. Declaration protected ICollection<ITraversalStrategy> TraversalStrategies { get; set; } Property Value Type Description ICollection < ITraversalStrategy > Traversers Gets or sets the Traverser 's of this traversal that hold the results of the traversal. Declaration public IEnumerable<Traverser> Traversers { get; set; } Property Value Type Description IEnumerable < Traverser > Methods Dispose() Declaration public void Dispose() HasNext() Declaration public bool HasNext() Returns Type Description System.Boolean Iterate() Iterates all Traverser instances in the traversal. Declaration public ITraversal<S, E> Iterate() Returns Type Description ITraversal <S, E> The fully drained traversal. MoveNext() Declaration public bool MoveNext() Retur ns Type Description System.Boolean Next() Gets the next result from the traversal. Declaration public E Next() Returns Type Description E The result. Next(Int32) Gets the next n-number of results from the traversal. Declaration public IEnumerable<E> Next(int amount) Parameters Type Name Description System.Int32 amount The number of results to get. Returns Type Description IEnumerable <E> The n-results. NextTraverser() Gets the next Traverser . Declaration public Traverser NextTraverser() Returns Type Description Traverser The next Traverser . Promise<TReturn>(Func<ITraversal<S, E>, TReturn>) Starts a promise to execute a function on the current traversal that will be completed in the future. Declaration public async Task<TReturn> Promise<TReturn>(Func<ITraversal<S, E>, TReturn> callback) Parameters Type Name Description System.Func < ITraversal <S, E>, TReturn> callback The function to execute on the current traversal. Returns Type Description System.Threading.Tasks.Task <TReturn> T he result of the executed callback . Type Parameters Name Description TReturn The return type of the callback . Reset() Reset is not supported. Declaration public void Reset() Exceptions Type Condition System.NotSupportedException Thrown always as this operation is not supported. ToList() Puts all the results into a . Declaration public IList<E> ToList() Returns Type Description IList <E> The results in a list. ToSet() Puts all the results into a . Declaration public ISet<E> ToSet() Returns Type Description ISet <E> The results in a set. Explicit Interface Implementations ITraversal.Iterate() Declaration ITraversal ITraversal.Iterate() Returns Type Description ITraversal Implements ITraversal<S, E> ITraversal IEnumerator IEnumerator<>" + "keywords": "Class DefaultTraversal<S, E> A traversal represents a directed walk over a graph. Inheritance System.Object DefaultTraversal<S, E> GraphTraversal<S, E> Implements ITraversal <S, E> ITraversal IEnumerator IEnumerator <E> Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ToString() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Process.Traversal Assembly : cs.temp.dll.dll Syntax public abstract class DefaultTraversal<S, E> : ITraversal<S, E>, ITraversal, IEnumerator, IEnumerator<E> Type Parameters Name Description S E Properties Bytecode Gets the Bytecode representation of this traversal. Declaration public Bytecode Bytecode { get; protected set; } Property Value Type Description Bytecode Current Declaration public E Current { get; } Property Value Type Description E IsAnonymous De termines if this traversal was spawned anonymously or not. Declaration public bool IsAnonymous { get; protected set; } Property Value Type Description System.Boolean TraversalStrategies Gets or sets the ITraversalStrategy strategies of this traversal. Declaration protected ICollection<ITraversalStrategy> TraversalStrategies { get; set; } Property Value Type Description ICollection < ITraversalStrategy > Traversers Gets or sets the Traverser 's of this traversal that hold the results of the traversal. Declaration public IEnumerable<Traverser> Traversers { get; set; } Property Value Type Description IEnumerable < Traverser > Methods Dispose() Declaration public void Dispose() HasNext() Declaration public bool HasNext() Returns Type Description System.Boolean Iterate() Iterates all Traverser instances in the traversal. Declaration public ITraversal<S, E> Iterate() Returns Type Description ITraversal <S, E> The fully drained traversal. MoveNext() Declaration public bool MoveNext() Retur ns Type Description System.Boolean Next() Gets the next result from the traversal. Declaration public E Next() Returns Type Description E The result. Next(Int32) Gets the next n-number of results from the traversal. Declaration public IEnumerable<E> Next(int amount) Parameters Type Name Description System.Int32 amount The number of results to get. Returns Type Description IEnumerable <E> The n-results. NextTraverser() Gets the next Traverser . Declaration public Traverser NextTraverser() Returns Type Description Traverser The next Traverser . Promise<TReturn>(Func<ITraversal<S, E>, TReturn>, CancellationToken) Starts a promise to execute a function on the current traversal that will be completed in the future. Declaration public async Task<TReturn> Promise<TReturn>(Func<ITraversal<S, E>, TReturn> callback, CancellationToken cancellationToken = null) Parameters Type Name Description System.Func < ITraversal <S, E>, TReturn> callback The function to execute on the current traversal. C ancellationToken cancellationToken The token to cancel the operation. The default value is None. Returns Type Description System.Threading.Tasks.Task <TReturn> The result of the executed callback . Type Parameters Name Description TReturn The return type of the callback . Reset() Reset is not supported. Declaration public void Reset() Exceptions Type Condition System.NotSupportedException Thrown always as this operation is not supported. ToList() Puts all the results into a . Declaration public IList<E> ToList() Returns Type Description IList <E> The results in a list. ToSet() Puts all the results into a . Declaration public ISet<E> ToSet() Returns Type Description ISet <E> The results in a set. Explicit Interface Implementations ITraversal.Iterate() Declaration ITraversal ITraversal.Iterate() Returns Type Description ITraversal Implements ITraversal<S, E> ITraversal IEnumerator IEnumerator<>" }, "api/Gremlin.Net.Process.Traversal.Direction.html": { "href": "api/Gremlin.Net.Process.Traversal.Direction.html", @@ -212,7 +212,7 @@ "api/Gremlin.Net.Process.Traversal.GraphTraversal-2.html": { "href": "api/Gremlin.Net.Process.Traversal.GraphTraversal-2.html", "title": "Class GraphTraversal<S, E> | Apache TinkerPop - Gremlin.NET API Docs",
[... 486 lines stripped ...]
