Grpc.Core.StatusCode.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Enum StatusCode
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Enum StatusCode
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Core.StatusCode">
  73. <h1 id="Grpc_Core_StatusCode" data-uid="Grpc.Core.StatusCode" class="text-break">Enum StatusCode
  74. </h1>
  75. <div class="markdown level0 summary"><p>Result of a remote procedure call.
  76. Based on grpc_status_code from grpc/status.h</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  80. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  81. <h5 id="Grpc_Core_StatusCode_syntax">Syntax</h5>
  82. <div class="codewrapper">
  83. <pre><code class="lang-csharp hljs">public enum StatusCode</code></pre>
  84. </div>
  85. <h3 id="fields">Fields
  86. </h3>
  87. <table class="table table-bordered table-striped table-condensed">
  88. <thead>
  89. <tr>
  90. <th>Name</th>
  91. <th>Description</th>
  92. </tr>
  93. <thead>
  94. <tbody>
  95. <tr>
  96. <td id="Grpc_Core_StatusCode_Aborted">Aborted</td>
  97. <td><p>The operation was aborted, typically due to a concurrency issue
  98. like sequencer check failures, transaction aborts, etc.</p>
  99. </td>
  100. </tr>
  101. <tr>
  102. <td id="Grpc_Core_StatusCode_AlreadyExists">AlreadyExists</td>
  103. <td><p>Some entity that we attempted to create (e.g., file or directory) already exists.</p>
  104. </td>
  105. </tr>
  106. <tr>
  107. <td id="Grpc_Core_StatusCode_Cancelled">Cancelled</td>
  108. <td><p>The operation was cancelled (typically by the caller).</p>
  109. </td>
  110. </tr>
  111. <tr>
  112. <td id="Grpc_Core_StatusCode_DataLoss">DataLoss</td>
  113. <td><p>Unrecoverable data loss or corruption.</p>
  114. </td>
  115. </tr>
  116. <tr>
  117. <td id="Grpc_Core_StatusCode_DeadlineExceeded">DeadlineExceeded</td>
  118. <td><p>Deadline expired before operation could complete. For operations
  119. that change the state of the system, this error may be returned
  120. even if the operation has completed successfully. For example, a
  121. successful response from a server could have been delayed long
  122. enough for the deadline to expire.</p>
  123. </td>
  124. </tr>
  125. <tr>
  126. <td id="Grpc_Core_StatusCode_FailedPrecondition">FailedPrecondition</td>
  127. <td><p>Operation was rejected because the system is not in a state
  128. required for the operation&apos;s execution. For example, directory
  129. to be deleted may be non-empty, an rmdir operation is applied to
  130. a non-directory, etc.</p>
  131. </td>
  132. </tr>
  133. <tr>
  134. <td id="Grpc_Core_StatusCode_Internal">Internal</td>
  135. <td><p>Internal errors. Means some invariants expected by underlying
  136. system has been broken. If you see one of these errors,
  137. something is very broken.</p>
  138. </td>
  139. </tr>
  140. <tr>
  141. <td id="Grpc_Core_StatusCode_InvalidArgument">InvalidArgument</td>
  142. <td><p>Client specified an invalid argument. Note that this differs
  143. from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
  144. that are problematic regardless of the state of the system
  145. (e.g., a malformed file name).</p>
  146. </td>
  147. </tr>
  148. <tr>
  149. <td id="Grpc_Core_StatusCode_NotFound">NotFound</td>
  150. <td><p>Some requested entity (e.g., file or directory) was not found.</p>
  151. </td>
  152. </tr>
  153. <tr>
  154. <td id="Grpc_Core_StatusCode_OK">OK</td>
  155. <td><p>Not an error; returned on success.</p>
  156. </td>
  157. </tr>
  158. <tr>
  159. <td id="Grpc_Core_StatusCode_OutOfRange">OutOfRange</td>
  160. <td><p>Operation was attempted past the valid range. E.g., seeking or
  161. reading past end of file.</p>
  162. </td>
  163. </tr>
  164. <tr>
  165. <td id="Grpc_Core_StatusCode_PermissionDenied">PermissionDenied</td>
  166. <td><p>The caller does not have permission to execute the specified
  167. operation. PERMISSION_DENIED must not be used for rejections
  168. caused by exhausting some resource (use RESOURCE_EXHAUSTED
  169. instead for those errors). PERMISSION_DENIED must not be
  170. used if the caller can not be identified (use UNAUTHENTICATED
  171. instead for those errors).</p>
  172. </td>
  173. </tr>
  174. <tr>
  175. <td id="Grpc_Core_StatusCode_ResourceExhausted">ResourceExhausted</td>
  176. <td><p>Some resource has been exhausted, perhaps a per-user quota, or
  177. perhaps the entire file system is out of space.</p>
  178. </td>
  179. </tr>
  180. <tr>
  181. <td id="Grpc_Core_StatusCode_Unauthenticated">Unauthenticated</td>
  182. <td><p>The request does not have valid authentication credentials for the operation.</p>
  183. </td>
  184. </tr>
  185. <tr>
  186. <td id="Grpc_Core_StatusCode_Unavailable">Unavailable</td>
  187. <td><p>The service is currently unavailable. This is a most likely a
  188. transient condition and may be corrected by retrying with
  189. a backoff. Note that it is not always safe to retry
  190. non-idempotent operations.</p>
  191. </td>
  192. </tr>
  193. <tr>
  194. <td id="Grpc_Core_StatusCode_Unimplemented">Unimplemented</td>
  195. <td><p>Operation is not implemented or not supported/enabled in this service.</p>
  196. </td>
  197. </tr>
  198. <tr>
  199. <td id="Grpc_Core_StatusCode_Unknown">Unknown</td>
  200. <td><p>Unknown error. An example of where this error may be returned is
  201. if a Status value received from another address space belongs to
  202. an error-space that is not known in this address space. Also
  203. errors raised by APIs that do not return enough error information
  204. may be converted to this error.</p>
  205. </td>
  206. </tr>
  207. </tbody>
  208. </thead></thead></table>
  209. </article>
  210. </div>
  211. <div class="hidden-sm col-md-2" role="complementary">
  212. <div class="sideaffix">
  213. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  214. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  215. </nav>
  216. </div>
  217. </div>
  218. </div>
  219. </div>
  220. <footer>
  221. <div class="grad-bottom"></div>
  222. <div class="footer">
  223. <div class="container">
  224. <span class="pull-right">
  225. <a href="#top">Back to top</a>
  226. </span>
  227. <span>Generated by <strong>DocFX</strong></span>
  228. </div>
  229. </div>
  230. </footer>
  231. </div>
  232. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  233. <script type="text/javascript" src="../styles/docfx.js"></script>
  234. <script type="text/javascript" src="../styles/main.js"></script>
  235. </body>
  236. </html>