Grpc.Core.Metadata.Entry.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  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>Class Metadata.Entry
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Metadata.Entry
  11. | gRPC for .NET ">
  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.Metadata.Entry">
  73. <h1 id="Grpc_Core_Metadata_Entry" data-uid="Grpc.Core.Metadata.Entry" class="text-break">Class Metadata.Entry
  74. </h1>
  75. <div class="markdown level0 summary"><p>Metadata entry</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><span class="xref">Metadata.Entry</span></div>
  82. </div>
  83. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  84. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  85. <h5 id="Grpc_Core_Metadata_Entry_syntax">Syntax</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">public class Entry : object</code></pre>
  88. </div>
  89. <h3 id="constructors">Constructors
  90. </h3>
  91. <a id="Grpc_Core_Metadata_Entry__ctor_" data-uid="Grpc.Core.Metadata.Entry.#ctor*"></a>
  92. <h4 id="Grpc_Core_Metadata_Entry__ctor_System_String_System_Byte___" data-uid="Grpc.Core.Metadata.Entry.#ctor(System.String,System.Byte[])">Entry(String, Byte[])</h4>
  93. <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a> struct with a binary value.</p>
  94. </div>
  95. <div class="markdown level1 conceptual"></div>
  96. <h5 class="decalaration">Declaration</h5>
  97. <div class="codewrapper">
  98. <pre><code class="lang-csharp hljs">public Entry(string key, byte[] valueBytes)</code></pre>
  99. </div>
  100. <h5 class="parameters">Parameters</h5>
  101. <table class="table table-bordered table-striped table-condensed">
  102. <thead>
  103. <tr>
  104. <th>Type</th>
  105. <th>Name</th>
  106. <th>Description</th>
  107. </tr>
  108. </thead>
  109. <tbody>
  110. <tr>
  111. <td><span class="xref">System.String</span></td>
  112. <td><span class="parametername">key</span></td>
  113. <td><p>Metadata key. Gets converted to lowercase. Needs to have suffix indicating a binary valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens and dots.</p>
  114. </td>
  115. </tr>
  116. <tr>
  117. <td><span class="xref">System.Byte</span>[]</td>
  118. <td><span class="parametername">valueBytes</span></td>
  119. <td><p>Value bytes.</p>
  120. </td>
  121. </tr>
  122. </tbody>
  123. </table>
  124. <a id="Grpc_Core_Metadata_Entry__ctor_" data-uid="Grpc.Core.Metadata.Entry.#ctor*"></a>
  125. <h4 id="Grpc_Core_Metadata_Entry__ctor_System_String_System_String_" data-uid="Grpc.Core.Metadata.Entry.#ctor(System.String,System.String)">Entry(String, String)</h4>
  126. <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a> struct with an ASCII value.</p>
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public Entry(string key, string value)</code></pre>
  132. </div>
  133. <h5 class="parameters">Parameters</h5>
  134. <table class="table table-bordered table-striped table-condensed">
  135. <thead>
  136. <tr>
  137. <th>Type</th>
  138. <th>Name</th>
  139. <th>Description</th>
  140. </tr>
  141. </thead>
  142. <tbody>
  143. <tr>
  144. <td><span class="xref">System.String</span></td>
  145. <td><span class="parametername">key</span></td>
  146. <td><p>Metadata key. Gets converted to lowercase. Must not use suffix indicating a binary valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens and dots.</p>
  147. </td>
  148. </tr>
  149. <tr>
  150. <td><span class="xref">System.String</span></td>
  151. <td><span class="parametername">value</span></td>
  152. <td><p>Value string. Only ASCII characters are allowed.</p>
  153. </td>
  154. </tr>
  155. </tbody>
  156. </table>
  157. <h3 id="properties">Properties
  158. </h3>
  159. <a id="Grpc_Core_Metadata_Entry_IsBinary_" data-uid="Grpc.Core.Metadata.Entry.IsBinary*"></a>
  160. <h4 id="Grpc_Core_Metadata_Entry_IsBinary" data-uid="Grpc.Core.Metadata.Entry.IsBinary">IsBinary</h4>
  161. <div class="markdown level1 summary"><p>Returns <code>true</code> if this entry is a binary-value entry.</p>
  162. </div>
  163. <div class="markdown level1 conceptual"></div>
  164. <h5 class="decalaration">Declaration</h5>
  165. <div class="codewrapper">
  166. <pre><code class="lang-csharp hljs">public bool IsBinary { get; }</code></pre>
  167. </div>
  168. <h5 class="propertyValue">Property Value</h5>
  169. <table class="table table-bordered table-striped table-condensed">
  170. <thead>
  171. <tr>
  172. <th>Type</th>
  173. <th>Description</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. <tr>
  178. <td><span class="xref">System.Boolean</span></td>
  179. <td></td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. <a id="Grpc_Core_Metadata_Entry_Key_" data-uid="Grpc.Core.Metadata.Entry.Key*"></a>
  184. <h4 id="Grpc_Core_Metadata_Entry_Key" data-uid="Grpc.Core.Metadata.Entry.Key">Key</h4>
  185. <div class="markdown level1 summary"><p>Gets the metadata entry key.</p>
  186. </div>
  187. <div class="markdown level1 conceptual"></div>
  188. <h5 class="decalaration">Declaration</h5>
  189. <div class="codewrapper">
  190. <pre><code class="lang-csharp hljs">public string Key { get; }</code></pre>
  191. </div>
  192. <h5 class="propertyValue">Property Value</h5>
  193. <table class="table table-bordered table-striped table-condensed">
  194. <thead>
  195. <tr>
  196. <th>Type</th>
  197. <th>Description</th>
  198. </tr>
  199. </thead>
  200. <tbody>
  201. <tr>
  202. <td><span class="xref">System.String</span></td>
  203. <td></td>
  204. </tr>
  205. </tbody>
  206. </table>
  207. <a id="Grpc_Core_Metadata_Entry_Value_" data-uid="Grpc.Core.Metadata.Entry.Value*"></a>
  208. <h4 id="Grpc_Core_Metadata_Entry_Value" data-uid="Grpc.Core.Metadata.Entry.Value">Value</h4>
  209. <div class="markdown level1 summary"><p>Gets the string value of this metadata entry.</p>
  210. </div>
  211. <div class="markdown level1 conceptual"></div>
  212. <h5 class="decalaration">Declaration</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">public string Value { get; }</code></pre>
  215. </div>
  216. <h5 class="propertyValue">Property Value</h5>
  217. <table class="table table-bordered table-striped table-condensed">
  218. <thead>
  219. <tr>
  220. <th>Type</th>
  221. <th>Description</th>
  222. </tr>
  223. </thead>
  224. <tbody>
  225. <tr>
  226. <td><span class="xref">System.String</span></td>
  227. <td></td>
  228. </tr>
  229. </tbody>
  230. </table>
  231. <a id="Grpc_Core_Metadata_Entry_ValueBytes_" data-uid="Grpc.Core.Metadata.Entry.ValueBytes*"></a>
  232. <h4 id="Grpc_Core_Metadata_Entry_ValueBytes" data-uid="Grpc.Core.Metadata.Entry.ValueBytes">ValueBytes</h4>
  233. <div class="markdown level1 summary"><p>Gets the binary value of this metadata entry.</p>
  234. </div>
  235. <div class="markdown level1 conceptual"></div>
  236. <h5 class="decalaration">Declaration</h5>
  237. <div class="codewrapper">
  238. <pre><code class="lang-csharp hljs">public byte[] ValueBytes { get; }</code></pre>
  239. </div>
  240. <h5 class="propertyValue">Property Value</h5>
  241. <table class="table table-bordered table-striped table-condensed">
  242. <thead>
  243. <tr>
  244. <th>Type</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><span class="xref">System.Byte</span>[]</td>
  251. <td></td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <h3 id="methods">Methods
  256. </h3>
  257. <a id="Grpc_Core_Metadata_Entry_ToString_" data-uid="Grpc.Core.Metadata.Entry.ToString*"></a>
  258. <h4 id="Grpc_Core_Metadata_Entry_ToString" data-uid="Grpc.Core.Metadata.Entry.ToString">ToString()</h4>
  259. <div class="markdown level1 summary"><p>Returns a <see cref="!:System.String"></see> that represents the current <a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a>.</p>
  260. </div>
  261. <div class="markdown level1 conceptual"></div>
  262. <h5 class="decalaration">Declaration</h5>
  263. <div class="codewrapper">
  264. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  265. </div>
  266. <h5 class="returns">Returns</h5>
  267. <table class="table table-bordered table-striped table-condensed">
  268. <thead>
  269. <tr>
  270. <th>Type</th>
  271. <th>Description</th>
  272. </tr>
  273. </thead>
  274. <tbody>
  275. <tr>
  276. <td><span class="xref">System.String</span></td>
  277. <td></td>
  278. </tr>
  279. </tbody>
  280. </table>
  281. </article>
  282. </div>
  283. <div class="hidden-sm col-md-2" role="complementary">
  284. <div class="sideaffix">
  285. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  286. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  287. </nav>
  288. </div>
  289. </div>
  290. </div>
  291. </div>
  292. <footer>
  293. <div class="grad-bottom"></div>
  294. <div class="footer">
  295. <div class="container">
  296. <span class="pull-right">
  297. <a href="#top">Back to top</a>
  298. </span>
  299. <span>Generated by <strong>DocFX</strong></span>
  300. </div>
  301. </div>
  302. </footer>
  303. </div>
  304. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  305. <script type="text/javascript" src="../styles/docfx.js"></script>
  306. <script type="text/javascript" src="../styles/main.js"></script>
  307. </body>
  308. </html>