You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by xi...@apache.org on 2023/01/21 03:08:33 UTC
svn commit: r1906849 [37/44] - in /tinkerpop/site/dotnetdocs/3.6.2: ./ api/ fonts/ images/ styles/
Added: tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.ttf
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.ttf?rev=1906849&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.ttf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.woff
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.woff?rev=1906849&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.woff
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.woff2
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.woff2?rev=1906849&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tinkerpop/site/dotnetdocs/3.6.2/fonts/glyphicons-halflings-regular.woff2
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tinkerpop/site/dotnetdocs/3.6.2/images/favicon.ico
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/images/favicon.ico?rev=1906849&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tinkerpop/site/dotnetdocs/3.6.2/images/favicon.ico
------------------------------------------------------------------------------
svn:executable = *
Propchange: tinkerpop/site/dotnetdocs/3.6.2/images/favicon.ico
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tinkerpop/site/dotnetdocs/3.6.2/images/tinkerpop-character.png
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/images/tinkerpop-character.png?rev=1906849&view=auto
==============================================================================
Binary file - no diff available.
Propchange: tinkerpop/site/dotnetdocs/3.6.2/images/tinkerpop-character.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: tinkerpop/site/dotnetdocs/3.6.2/index.html
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/index.html?rev=1906849&view=auto
==============================================================================
--- tinkerpop/site/dotnetdocs/3.6.2/index.html (added)
+++ tinkerpop/site/dotnetdocs/3.6.2/index.html Sat Jan 21 03:08:31 2023
@@ -0,0 +1,146 @@
+<!DOCTYPE html>
+<!--[if IE]><![endif]-->
+<html>
+
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+ <title>Gremlin.Net | Apache TinkerPop - Gremlin.NET API Docs </title>
+ <meta name="viewport" content="width=device-width">
+ <meta name="title" content="Gremlin.Net | Apache TinkerPop - Gremlin.NET API Docs ">
+ <meta name="generator" content="docfx 2.58.0.0">
+
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="stylesheet" href="styles/docfx.vendor.css">
+ <link rel="stylesheet" href="styles/docfx.css">
+ <link rel="stylesheet" href="styles/main.css">
+ <meta property="docfx:navrel" content="toc.html">
+ <meta property="docfx:tocrel" content="toc.html">
+
+ <meta property="docfx:rel" content="">
+
+ </head>
+ <body data-spy="scroll" data-target="#affix" data-offset="120">
+ <div id="wrapper">
+ <header>
+
+ <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+
+ <a class="navbar-brand" href="index.html">
+ <img id="logo" class="svg" src="images/tinkerpop-character.png" alt="">
+ </a>
+ </div>
+ <div class="collapse navbar-collapse" id="navbar">
+ <form class="navbar-form navbar-right" role="search" id="search">
+ <div class="form-group">
+ <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
+ </div>
+ </form>
+ </div>
+ </div>
+ </nav>
+
+ <div class="subnav navbar navbar-default">
+ <div class="container hide-when-search" id="breadcrumb">
+ <ul class="breadcrumb">
+ <li></li>
+ </ul>
+ </div>
+ </div>
+ </header>
+ <div class="container body-content">
+
+ <div id="search-results">
+ <div class="search-list">Search Results for <span></span></div>
+ <div class="sr-items">
+ <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
+ </div>
+ <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
+ </div>
+ </div>
+ <div role="main" class="container body-content hide-when-search">
+ <div class="article row grid">
+ <div class="col-md-10">
+ <article class="content wrap" id="_content" data-uid="">
+<h1 id="gremlinnet">Gremlin.Net</h1>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<p><a href="https://tinkerpop.apache.org">Apache TinkerPopâ¢</a> is a graph computing framework for both graph databases (OLTP) and graph analytic systems
+(OLAP). <a href="https://tinkerpop.apache.org/gremlin.html">Gremlin</a> is the graph traversal language of TinkerPop. It can be described as a functional,
+data-flow language that enables users to succinctly express complex traversals on (or queries of) their application's
+property graph.</p>
+<p>Gremlin.Net implements Gremlin within the C# language. It targets .NET Standard and can therefore be used on different
+operating systems and with different .NET frameworks, such as .NET Framework and .NET Core.</p>
+<pre><code class="lang-bash">nuget install Gremlin.Net
+</code></pre>
+<p>The Gremlin language allows users to write highly expressive graph traversals and has a broad list of functions that
+cover a wide body of features. The <a href="https://tinkerpop.apache.org/docs/current/reference/#graph-traversal-steps">Reference Documentation</a> describes these functions and other aspects of the
+TinkerPop ecosystem including some specifics on <a href="https://tinkerpop.apache.org/docs/current/reference/#gremlin-dotnet">Gremlin in .NET</a> itself. Most of the examples found in the
+documentation use Groovy language syntax in the <a href="https://tinkerpop.apache.org/docs/current/tutorials/the-gremlin-console/">Gremlin Console</a>. For the most part, these examples
+should generally translate to C# with <a href="https://tinkerpop.apache.org/docs/current/reference/#gremlin-javascript-differences">some logical modification</a>. Given the strong correspondence
+between canonical Gremlin in Java and its variants like C#, there is a limited amount of C#-specific
+documentation and examples. This strong correspondence among variants ensures that the general Gremlin reference
+documentation is applicable to all variants and that users moving between development languages can easily adopt the
+Gremlin variant for that language.</p>
+<p><strong>NOTE</strong> that versions suffixed with "-rc" are considered release candidates (i.e. pre-alpha, alpha, beta, etc.) and thus
+for early testing purposes only.</p>
+</article>
+ </div>
+
+ <div class="hidden-sm col-md-2" role="complementary">
+ <div class="sideaffix">
+ <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
+ <h5>In This Article</h5>
+ <div></div>
+ </nav>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <footer>
+ <div class="grad-bottom"></div>
+ <div class="footer">
+ <div class="container">
+ <span class="pull-right">
+ <a href="#top">Back to top</a>
+ </span>
+ Copyright © 2018 The Apache Software Foundation
+
+ </div>
+ </div>
+ </footer>
+ </div>
+
+ <script type="text/javascript" src="styles/docfx.vendor.js"></script>
+ <script type="text/javascript" src="styles/docfx.js"></script>
+ <script type="text/javascript" src="styles/main.js"></script>
+ </body>
+</html>
Added: tinkerpop/site/dotnetdocs/3.6.2/index.json
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/index.json?rev=1906849&view=auto
==============================================================================
--- tinkerpop/site/dotnetdocs/3.6.2/index.json (added)
+++ tinkerpop/site/dotnetdocs/3.6.2/index.json Sat Jan 21 03:08:31 2023
@@ -0,0 +1,912 @@
+{
+ "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 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 16. 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 8. 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",
+ "title": "Class ConnectionClosedException | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ConnectionClosedException The exception that is thrown for requests that in-flight when the underlyingg websocket is closed by the server. Requests that recieve this exception will be in a non-deteministic state and may need to be retried. Inheritance System.Object System.Exception ConnectionClosedException Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception Inherited Members System.Exception.GetBaseException() System.Exception.ToString() System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) System.Exception.GetType() System.Exception.Message System.Exception.Data System.Exception.InnerException System.Exception.TargetSite System.Exception.StackTrace System.Exception.HelpLink System.Exception.Source System.Exception.HResult System.Exception.SerializeObjectState System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver.Exceptions Assembly : cs.temp.dll.dll Syntax public class ConnectionClosedException : Exception, ISerializable, _Exception Remarks It is recommended to use the same request retry policy that is applied when a System.Net.WebSockets.WebSocketException , System.Net.Sockets.SocketException , System.IO.IOException . Constructors ConnectionClosedException(Nullable<WebSocketCloseStatus>, String) Initializes a new instance of the ConnectionClosedException class. Declaration public ConnectionClosedException(WebSocketCloseStatus? status, string description) Parameters Type Name Description System.Nullable < WebSocketCloseStatus > status System.String description Properties Description Gets the Websocket closure description provided by the server. Declaration public string Description { get; } Property Value Type Description System.String Statu
s Gets the well-known WebSocket close status code provided by the server. Declaration public WebSocketCloseStatus? Status { get; } Property Value Type Description System.Nullable < WebSocketCloseStatus > Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception"
+ },
+ "api/Gremlin.Net.Driver.Exceptions.ConnectionPoolBusyException.html": {
+ "href": "api/Gremlin.Net.Driver.Exceptions.ConnectionPoolBusyException.html",
+ "title": "Class ConnectionPoolBusyException | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ConnectionPoolBusyException The exception that is thrown when all connections in the pool have reached their maximum number of in-flight requests. Inheritance System.Object System.Exception NoConnectionAvailableException ConnectionPoolBusyException Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception Inherited Members System.Exception.GetBaseException() System.Exception.ToString() System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) System.Exception.GetType() System.Exception.Message System.Exception.Data System.Exception.InnerException System.Exception.TargetSite System.Exception.StackTrace System.Exception.HelpLink System.Exception.Source System.Exception.HResult System.Exception.SerializeObjectState System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver.Exceptions Assembly : cs.temp.dll.dll Syntax public class ConnectionPoolBusyException : NoConnectionAvailableException, ISerializable, _Exception Constructors ConnectionPoolBusyException(Int32, Int32) Initializes a new instance of the ConnectionPoolBusyException class. Declaration public ConnectionPoolBusyException(int poolSize, int maxInProcessPerConnection) Parameters Type Name Description System.Int32 poolSize System.Int32 maxInProcessPerConnection Properties MaxInProcessPerConnection Gets the maximum number of in-flight requests that can occur on a connection. Declaration public int MaxInProcessPerConnection { get; } Property Value Type Description System.Int32 PoolSize Gets the size of the connection pool. Declaration public int PoolSize { get; } Property Value Type Description System.Int32 Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception"
+ },
+ "api/Gremlin.Net.Driver.Exceptions.html": {
+ "href": "api/Gremlin.Net.Driver.Exceptions.html",
+ "title": "Namespace Gremlin.Net.Driver.Exceptions | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Namespace Gremlin.Net.Driver.Exceptions Classes ConnectionClosedException The exception that is thrown for requests that in-flight when the underlyingg websocket is closed by the server. Requests that recieve this exception will be in a non-deteministic state and may need to be retried. ConnectionPoolBusyException The exception that is thrown when all connections in the pool have reached their maximum number of in-flight requests. NoConnectionAvailableException The exception that is thrown when no connection is available to service a request. ResponseException The exception that is thrown when a response is received from Gremlin Server that indicates that an error occurred. ServerUnavailableException The exception that is thrown when no connection is available to the GremlinServer ."
+ },
+ "api/Gremlin.Net.Driver.Exceptions.NoConnectionAvailableException.html": {
+ "href": "api/Gremlin.Net.Driver.Exceptions.NoConnectionAvailableException.html",
+ "title": "Class NoConnectionAvailableException | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class NoConnectionAvailableException The exception that is thrown when no connection is available to service a request. Inheritance System.Object System.Exception NoConnectionAvailableException ConnectionPoolBusyException ServerUnavailableException Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception Inherited Members System.Exception.GetBaseException() System.Exception.ToString() System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) System.Exception.GetType() System.Exception.Message System.Exception.Data System.Exception.InnerException System.Exception.TargetSite System.Exception.StackTrace System.Exception.HelpLink System.Exception.Source System.Exception.HResult System.Exception.SerializeObjectState System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.MemberwiseClone() Syste
m.Object.ReferenceEquals(System.Object, System.Object) Namespace : Gremlin.Net.Driver.Exceptions Assembly : cs.temp.dll.dll Syntax public class NoConnectionAvailableException : Exception, ISerializable, _Exception Constructors NoConnectionAvailableException() Initializes a new instance of the NoConnectionAvailableException class. Declaration public NoConnectionAvailableException() NoConnectionAvailableException(String) Initializes a new instance of the NoConnectionAvailableException class. Declaration public NoConnectionAvailableException(string message) Parameters Type Name Description System.String message NoConnectionAvailableException(String, Exception) Initializes a new instance of the NoConnectionAvailableException class. Declaration public NoConnectionAvailableException(string message, Exception inner) Parameters Type Name Description System.String message System.Exception inner Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception"
+ },
+ "api/Gremlin.Net.Driver.Exceptions.ResponseException.html": {
+ "href": "api/Gremlin.Net.Driver.Exceptions.ResponseException.html",
+ "title": "Class ResponseException | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ResponseException The exception that is thrown when a response is received from Gremlin Server that indicates that an error occurred. Inheritance System.Object System.Exception ResponseException Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception Inherited Members System.Exception.GetBaseException() System.Exception.ToString() System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) System.Exception.GetType() System.Exception.Message System.Exception.Data System.Exception.InnerException System.Exception.TargetSite System.Exception.StackTrace System.Exception.HelpLink System.Exception.Source System.Exception.HResult System.Exception.SerializeObjectState System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.O
bject) Namespace : Gremlin.Net.Driver.Exceptions Assembly : cs.temp.dll.dll Syntax public class ResponseException : Exception, ISerializable, _Exception Constructors ResponseException(ResponseStatusCode, IReadOnlyDictionary<String, Object>, String) Initializes a new instance of the ResponseException class. Declaration public ResponseException(ResponseStatusCode statusCode, IReadOnlyDictionary<string, object> statusAttributes, string message) Parameters Type Name Description ResponseStatusCode statusCode The status code returned by the server. System.Collections.Generic.IReadOnlyDictionary < System.String , System.Object > statusAttributes The status attributes from the gremlin response. System.String message The error message string. Properties StatusAttributes Gets the status attributes from the gremlin response Declaration public IReadOnlyDictionary<string, object> StatusAttributes { get; } Property Value Type Description System.Collections.Generic.IReadOnlyDictionary < System.Str
ing , System.Object > StatusCode Gets the status code returned from the server. Declaration public ResponseStatusCode StatusCode { get; } Property Value Type Description ResponseStatusCode Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception"
+ },
+ "api/Gremlin.Net.Driver.Exceptions.ServerUnavailableException.html": {
+ "href": "api/Gremlin.Net.Driver.Exceptions.ServerUnavailableException.html",
+ "title": "Class ServerUnavailableException | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ServerUnavailableException The exception that is thrown when no connection is available to the GremlinServer . Inheritance System.Object System.Exception NoConnectionAvailableException ServerUnavailableException Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception Inherited Members System.Exception.GetBaseException() System.Exception.ToString() System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext) System.Exception.GetType() System.Exception.Message System.Exception.Data System.Exception.InnerException System.Exception.TargetSite System.Exception.StackTrace System.Exception.HelpLink System.Exception.Source System.Exception.HResult System.Exception.SerializeObjectState System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System
.Object, System.Object) Namespace : Gremlin.Net.Driver.Exceptions Assembly : cs.temp.dll.dll Syntax public class ServerUnavailableException : NoConnectionAvailableException, ISerializable, _Exception Constructors ServerUnavailableException() Initializes a new instance of the ServerUnavailableException class. Declaration public ServerUnavailableException() Implements System.Runtime.Serialization.ISerializable System.Runtime.InteropServices._Exception"
+ },
+ "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, 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, 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 RequestMessage 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 scri
pt to send. System.Collections.Generic.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 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 script to send. System.Collections.Generic.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 cancellationToke
n = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. RequestMessage requestMessage The RequestMessage 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 a
synchronous 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, CancellationToken cancellationToken = null) Parameters Type Name Description IGremlinClient gremlinClient The IGremlinClient that submits the request. System.String requestScript The Gremlin request script to send. System.Collections.Generic.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, D
ictionary<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",
+ "title": "Class GremlinServer | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class GremlinServer Represents a Gremlin Server. Inheritance System.Object GremlinServer 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 GremlinServer Constructors GremlinServer(String, Int32, Boolean, String, String) Initializes a new instance of the GremlinServer class with the specified connection parameters. Declaration public GremlinServer(string hostname = \"localhost\", int port = 8182, bool enableSsl = false, string username = null, string password = null) Parameters Type Name Description System.String hostname The hostname of the server. System.Int32 port The port on which Gremlin Server can be reached. System.Boolean enableSsl Specifies whether SSL should be
enabled. System.String username The username to submit on requests that require authentication. System.String password The password to submit on requests that require authentication. Properties Password Gets the password to submit on requests that require authentication. Declaration public string Password { get; } Property Value Type Description System.String Uri Gets the URI of the Gremlin Server. Declaration public Uri Uri { get; } Property Value Type Description System.Uri The WebSocket System.Uri that the Gremlin Server responds to. Username Gets the username to submit on requests that require authentication. Declaration public string Username { get; } Property Value Type Description System.String"
+ },
+ "api/Gremlin.Net.Driver.html": {
+ "href": "api/Gremlin.Net.Driver.html",
+ "title": "Namespace Gremlin.Net.Driver | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Namespace Gremlin.Net.Driver Classes ConnectionPoolSettings Holds settings for the Gremlin.Net.Driver.ConnectionPool . GremlinClient Provides a mechanism for submitting Gremlin requests to one Gremlin Server. GremlinClientExtensions Provides extension methods for the IGremlinClient interface. GremlinServer Represents a Gremlin Server. ResultSet<T> A ResultSet is returned from the submission of a Gremlin script to the server and represents the results provided by the server. ResultSet includes enumerable data and status attributes. Tokens String constants used to configure a RequestMessage . Interfaces IGremlinClient Provides a mechanism for submitting Gremlin requests. IMessageSerializer Serializes data to and from Gremlin Server."
+ },
+ "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, 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 RequestMessage 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 Serve
r that indicates 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[], CancellationToken) Deserializes a ResponseMessage<T> 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 < System.Collections.Generic.List < System.Object >>> The deserialized ResponseMessage<T> . SerializeMessageAsync(RequestMessage, CancellationToken) Serializes a RequestMessage . Declaration Task<byte[]> SerializeMessageAsync(RequestMessage requestMessage, CancellationToken cancellationToken = nul
l) Parameters Type Name Description RequestMessage requestMessage The RequestMessage to serialize. 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",
+ "title": "Namespace Gremlin.Net.Driver.Messages | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Namespace Gremlin.Net.Driver.Messages Classes RequestMessage The model for a request message sent to the server. RequestMessage.Builder Allows to build RequestMessage objects. ResponseMessage<T> The message returned from the server. ResponseResult<T> Represents the result as a response to a RequestMessage sent as part of a ResponseMessage<T> by the server. ResponseStatus Represents status information of a ResponseMessage<T> . Enums ResponseStatusCode Represents the various status codes that Gremlin Server returns."
+ },
+ "api/Gremlin.Net.Driver.Messages.RequestMessage.Builder.html": {
+ "href": "api/Gremlin.Net.Driver.Messages.RequestMessage.Builder.html",
+ "title": "Class RequestMessage.Builder | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class RequestMessage.Builder Allows to build RequestMessage objects. Inheritance System.Object RequestMessage.Builder 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.Messages Assembly : cs.temp.dll.dll Syntax public class Builder Methods AddArgument(String, Object) Adds and argument to the RequestMessage . Declaration public RequestMessage.Builder AddArgument(string key, object value) Parameters Type Name Description System.String key The key of the argument. System.Object value The value of the argument. Returns Type Description RequestMessage.Builder The RequestMessage.Builder . Create() Creates the RequestMessage given the settings provided to the RequestMessage.Builder . Declaration public RequestMessage Creat
e() Returns Type Description RequestMessage The built RequestMessage . OverrideRequestId(Guid) Overrides the request identifier with a specified one, otherwise the RequestMessage.Builder will randomly generate a System.Guid . Declaration public RequestMessage.Builder OverrideRequestId(Guid requestId) Parameters Type Name Description System.Guid requestId The request identifier to use. Returns Type Description RequestMessage.Builder The RequestMessage.Builder . Processor(String) If this value is not set in the builder then the Processor defaults to the standard op processor (empty string). Declaration public RequestMessage.Builder Processor(string processor) Parameters Type Name Description System.String processor The name of the processor. Returns Type Description RequestMessage.Builder The RequestMessage.Builder ."
+ },
+ "api/Gremlin.Net.Driver.Messages.RequestMessage.html": {
+ "href": "api/Gremlin.Net.Driver.Messages.RequestMessage.html",
+ "title": "Class RequestMessage | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class RequestMessage The model for a request message sent to the server. Inheritance System.Object RequestMessage 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.Messages Assembly : cs.temp.dll.dll Syntax public class RequestMessage Properties Arguments Gets arguments of the RequestMessage . Declaration public Dictionary<string, object> Arguments { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , System.Object > Operation Gets the name of the operation that should be executed by the Gremlin Server. Declaration public string Operation { get; } Property Value Type Description System.String The name of the \"operation\" to execute based on the available OpProcessor config
ured in the Gremlin Server. This defaults to \"eval\" which evaluates a request script. Processor Gets the name of the OpProcessor to utilize. Declaration public string Processor { get; } Property Value Type Description System.String The name of the OpProcessor to utilize. This defaults to an empty string which represents the default OpProcessor for evaluating scripts. RequestId Gets the ID of this request message. Declaration public Guid RequestId { get; } Property Value Type Description System.Guid A UUID representing the unique identification for the request. Methods Build(String) Initializes a RequestMessage.Builder to build a RequestMessage . Declaration public static RequestMessage.Builder Build(string operation) Parameters Type Name Description System.String operation The name of the OpProcessor to utilize. Returns Type Description RequestMessage.Builder A RequestMessage.Builder to build a RequestMessage ."
+ },
+ "api/Gremlin.Net.Driver.Messages.ResponseMessage-1.html": {
+ "href": "api/Gremlin.Net.Driver.Messages.ResponseMessage-1.html",
+ "title": "Class ResponseMessage<T> | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ResponseMessage<T> The message returned from the server. Inheritance System.Object ResponseMessage<T> 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.Messages Assembly : cs.temp.dll.dll Syntax public class ResponseMessage<T> Type Parameters Name Description T The type of the data returned. Properties RequestId Gets or sets the identifier of the RequestMessage that generated this ResponseMessage<T> . Declaration public Guid? RequestId { get; set; } Property Value Type Description System.Nullable < System.Guid > Result Gets or sets the result with its data and optional meta information. Declaration public ResponseResult<T> Result { get; set; } Property Value Type Description ResponseResult <T> Status Gets or s
ets status information about this ResponseMessage<T> . Declaration public ResponseStatus Status { get; set; } Property Value Type Description ResponseStatus"
+ },
+ "api/Gremlin.Net.Driver.Messages.ResponseResult-1.html": {
+ "href": "api/Gremlin.Net.Driver.Messages.ResponseResult-1.html",
+ "title": "Class ResponseResult<T> | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ResponseResult<T> Represents the result as a response to a RequestMessage sent as part of a ResponseMessage<T> by the server. Inheritance System.Object ResponseResult<T> 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.Messages Assembly : cs.temp.dll.dll Syntax public class ResponseResult<T> Type Parameters Name Description T The type of the Data . Properties Data Gets or sets the data of this result. Declaration public T Data { get; set; } Property Value Type Description T Meta Gets or sets meta data of this result. Declaration public Dictionary<string, object> Meta { get; set; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , System.Object >"
+ },
+ "api/Gremlin.Net.Driver.Messages.ResponseStatus.html": {
+ "href": "api/Gremlin.Net.Driver.Messages.ResponseStatus.html",
+ "title": "Class ResponseStatus | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ResponseStatus Represents status information of a ResponseMessage<T> . Inheritance System.Object ResponseStatus 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.Messages Assembly : cs.temp.dll.dll Syntax public class ResponseStatus Properties Attributes Gets or sets the attributes System.Collections.Generic.Dictionary<TKey, TValue> with protocol-level information. Declaration public Dictionary<string, object> Attributes { get; set; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , System.Object > Code Gets or sets the ResponseStatusCode . Declaration public ResponseStatusCode Code { get; set; } Property Value Type Description ResponseStatusCode Message Gets or sets the
message which is just a human-readable string usually associated with errors. Declaration public string Message { get; set; } Property Value Type Description System.String"
+ },
+ "api/Gremlin.Net.Driver.Messages.ResponseStatusCode.html": {
+ "href": "api/Gremlin.Net.Driver.Messages.ResponseStatusCode.html",
+ "title": "Enum ResponseStatusCode | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Enum ResponseStatusCode Represents the various status codes that Gremlin Server returns. Namespace : Gremlin.Net.Driver.Messages Assembly : cs.temp.dll.dll Syntax public enum ResponseStatusCode Fields Name Description Authenticate A challenge from the server for the client to authenticate its request. ClientSerializationError The request message contains objects that were not serializable on the client side. Forbidden The server could authenticate the request, but will not fulfill it. This is a general purpose code that would typically be returned if the request is authenticated but not authorized to do what it is doing. InvalidRequestArguments The request message was parseable, but the arguments supplied in the message were in conflict or incomplete. Check the message format and retry the request. MalformedRequest The request message was not properly formatted which means it could not be parsed at all or the \"op\" code was not recognized such that Gremlin Server c
ould properly route it for processing. Check the message format and retry the request. NoContent The server processed the request but there is no result to return (e.g. an Iterator with no elements) there are no messages remaining in this stream. PartialContent The server successfully returned some content, but there is more in the stream to arrive - wait for a SUCCESS to signify the end of the stream. ServerError A general server error occurred that prevented the request from being processed. ServerErrorFailStep A server error that is produced when the fail()-step is triggered. ServerErrorTemporary A server error that indicates that the client should retry the request. A graph will typically return this error when a transaction fails due to a locking exception or some other sort of concurrent modification. In other words, the request was likely valid but the state of the server at the particular time the request arrived could not be processed to success, but could be at a later mom
ent. ServerEvaluationError The request submitted for processing evaluated by the server with errors and could not be processed. Check the script or remote traversal submitted for errors or other problems and then resubmit. ServerSerializationError The server was not capable of serializing an object that was returned from the script supplied on the request. Either transform the object into something Gremlin Server can process within the script or install mapper serialization classes to Gremlin Server. ServerTimeout The server exceeded one of the timeout settings for the request and could therefore only partially responded or did not respond at all. Success The server successfully processed a request to completion - there are no messages remaining in this stream. TooManyRequests Indicates that too many requests have been sent in a given amount of time. Unauthorized The request attempted to access resources that the requesting user did not have access to."
+ },
+ "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, 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",
+ "title": "Namespace Gremlin.Net.Driver.Remote | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Namespace Gremlin.Net.Driver.Remote Classes DriverRemoteConnection A implementation for Gremlin Server."
+ },
+ "api/Gremlin.Net.Driver.ResultSet-1.html": {
+ "href": "api/Gremlin.Net.Driver.ResultSet-1.html",
+ "title": "Class ResultSet<T> | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class ResultSet<T> A ResultSet is returned from the submission of a Gremlin script to the server and represents the results provided by the server. ResultSet includes enumerable data and status attributes. Inheritance System.Object ResultSet<T> Implements System.Collections.Generic.IReadOnlyCollection <T> System.Collections.Generic.IEnumerable <T> System.Collections.IEnumerable 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 sealed class ResultSet<T> : IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable Type Parameters Name Description T Type of the result elements Constructors ResultSet(IReadOnlyCollection<T>, IReadOnlyDictionary<String, Object>) Initializes a new instance
of the ResultSet class for the specified data and status attributes. Declaration public ResultSet(IReadOnlyCollection<T> data, IReadOnlyDictionary<string, object> attributes) Parameters Type Name Description System.Collections.Generic.IReadOnlyCollection <T> data System.Collections.Generic.IReadOnlyDictionary < System.String , System.Object > attributes Properties Count Declaration public int Count { get; } Property Value Type Description System.Int32 StatusAttributes Gets or sets the status attributes from the gremlin response Declaration public IReadOnlyDictionary<string, object> StatusAttributes { get; } Property Value Type Description System.Collections.Generic.IReadOnlyDictionary < System.String , System.Object > Methods GetEnumerator() Declaration public IEnumerator<T> GetEnumerator() Returns Type Description System.Collections.Generic.IEnumerator <T> Implements System.Collections.Generic.IReadOnlyCollection<T> System.Collections.Generic.IEnumerable<T> System.Collections.IEnu
merable"
+ },
+ "api/Gremlin.Net.Driver.Tokens.html": {
+ "href": "api/Gremlin.Net.Driver.Tokens.html",
+ "title": "Class Tokens | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Class Tokens String constants used to configure a RequestMessage . Inheritance System.Object Tokens 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 Tokens Fields ArgsAliases Argument name that allows definition of alias names for Graph and TraversalSource objects on the remote system. Declaration public static string ArgsAliases Field Value Type Description System.String ArgsBatchSize Argument name that allows the definition of the number of items each ResponseMessage should contain from a particular result - overrides the resultIterationBatchSize server setting. Declaration public static string ArgsBatchSize Field Value Type Description System.String ArgsBindings Arg
ument name that allows definition of a map of key/value pairs to apply as variables in the context of the Gremlin request sent to the server. Declaration public static string ArgsBindings Field Value Type Description System.String ArgsEvalTimeout Argument name that allows the override of the server setting that determines the maximum time to wait for a request to execute on the server. Declaration public static string ArgsEvalTimeout Field Value Type Description System.String ArgsGremlin Argument name that corresponds to the Gremlin to evaluate. Declaration public static string ArgsGremlin Field Value Type Description System.String ArgsLanguage Argument name that allows definition of the flavor of Gremlin used (e.g. gremlin-groovy) to process the request. Declaration public static string ArgsLanguage Field Value Type Description System.String ArgsSasl Argument name for the response to the server authentication challenge. This value is dependent on the SASL authentication mechanism r
equired by the server. Declaration public static string ArgsSasl Field Value Type Description System.String ArgsSession Argument name that allows to define the id of session. Declaration public static string ArgsSession Field Value Type Description System.String ArgsUserAgent Argument name that allows a value that is a custom string that the user can pass to a server that might accept it for purpose of identifying the kind of client it came from. Declaration public static string ArgsUserAgent Field Value Type Description System.String OpsAuthentication Operation used by the client to authenticate itself. Declaration public static string OpsAuthentication Field Value Type Description System.String OpsBytecode Operation used for a request that contains the Bytecode representation of a Traversal. Declaration public static string OpsBytecode Field Value Type Description System.String OpsClose Operation used to get all the keys of all side-effects as produced by a previously executed Tra
versal. Declaration public static string OpsClose Field Value Type Description System.String OpsEval Operation used to evaluate a Gremlin script provided as a string. Declaration public static string OpsEval Field Value Type Description System.String ProcessorSession Session OpProcessor. Declaration public static string ProcessorSession Field Value Type Description System.String ProcessorTraversal Default OpProcessor. Declaration public static string ProcessorTraversal Field Value Type Description System.String RequestId The key for the unique identifier of the request. Declaration public static string RequestId Field Value Type Description System.String"
+ },
+ "api/Gremlin.Net.Process.Remote.html": {
+ "href": "api/Gremlin.Net.Process.Remote.html",
+ "title": "Namespace Gremlin.Net.Process.Remote | Apache TinkerPop - Gremlin.NET API Docs",
+ "keywords": "Namespace Gremlin.Net.Process.Remote Classes RemoteStrategy Reconstructs a by submitting it to a remote server via an IRemoteConnection instance. 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. Interfaces IRemoteConnection A simple abstraction of a \"connection\" to a \"server\"."
+ },
+ "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, 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>, 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(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",
+ "title": "Class __ | Apache TinkerPop - Gremlin.NET API Docs",
[... 770 lines stripped ...]
Added: tinkerpop/site/dotnetdocs/3.6.2/logo.svg
URL: http://svn.apache.org/viewvc/tinkerpop/site/dotnetdocs/3.6.2/logo.svg?rev=1906849&view=auto
==============================================================================
--- tinkerpop/site/dotnetdocs/3.6.2/logo.svg (added)
+++ tinkerpop/site/dotnetdocs/3.6.2/logo.svg Sat Jan 21 03:08:31 2023
@@ -0,0 +1,25 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="38.000000pt" height="38.000000pt" viewBox="0 0 172.000000 172.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by Docfx
+</metadata>
+<g transform="translate(0.000000,172.000000) scale(0.100000,-0.100000)"
+fill="#dddddd" stroke="none">
+<path d="M230 1359 c0 -18 11 -30 44 -48 80 -42 81 -45 81 -441 0 -400 -1
+-404 -79 -436 -36 -15 -46 -24 -46 -43 0 -23 2 -24 61 -17 34 3 88 6 120 6
+l59 0 0 495 0 495 -82 0 c-46 0 -100 3 -120 6 -35 6 -38 5 -38 -17z"/>
+<path d="M618 1373 l-118 -4 0 -493 0 -494 154 -7 c181 -9 235 -3 313 34 68
+33 168 130 207 202 75 136 75 384 1 536 -71 145 -234 240 -399 231 -23 -1 -94
+-4 -158 -5z m287 -119 c68 -24 144 -101 176 -179 22 -54 24 -75 24 -210 0
+-141 -2 -153 -26 -206 -36 -76 -89 -132 -152 -160 -45 -21 -68 -24 -164 -24
+-71 0 -116 4 -123 11 -22 22 -31 175 -28 463 2 208 6 293 15 302 32 32 188 33
+278 3z"/>
+<path d="M1170 1228 c75 -104 110 -337 76 -508 -21 -100 -56 -178 -105 -233
+l-36 -41 34 20 c75 43 160 133 198 212 37 75 38 78 38 191 -1 129 -18 191 -75
+270 -28 38 -136 131 -153 131 -4 0 6 -19 23 -42z"/>
+</g>
+</svg>