Grpc.Health.V1.Health.HealthClient.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658
  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 Health.HealthClient
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Health.HealthClient
  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.Health.V1.Health.HealthClient">
  73. <h1 id="Grpc_Health_V1_Health_HealthClient" data-uid="Grpc.Health.V1.Health.HealthClient" class="text-break">Class Health.HealthClient
  74. </h1>
  75. <div class="markdown level0 summary"><p>Client for Health</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"><a class="xref" href="Grpc.Core.ClientBase.html">ClientBase</a></div>
  82. <div class="level2"><a class="xref" href="Grpc.Core.ClientBase-1.html">ClientBase</a>&lt;<a class="xref" href="Grpc.Health.V1.Health.HealthClient.html">Health.HealthClient</a>&gt;</div>
  83. <div class="level3"><span class="xref">Health.HealthClient</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="Grpc.Core.ClientBase-1.html#Grpc_Core_ClientBase_1_WithHost_System_String_">ClientBase&lt;Health.HealthClient&gt;.WithHost(String)</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="Grpc.Core.ClientBase.html#Grpc_Core_ClientBase_CallInvoker">ClientBase.CallInvoker</a>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.GetHashCode()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.GetType()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.MemberwiseClone()</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  110. </div>
  111. <div>
  112. <span class="xref">System.Object.ToString()</span>
  113. </div>
  114. </div>
  115. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Health.V1.html">Grpc.Health.V1</a></h6>
  116. <h6><strong>Assembly</strong>: Grpc.HealthCheck.dll</h6>
  117. <h5 id="Grpc_Health_V1_Health_HealthClient_syntax">Syntax</h5>
  118. <div class="codewrapper">
  119. <pre><code class="lang-csharp hljs">public class HealthClient : ClientBase&lt;Health.HealthClient&gt;</code></pre>
  120. </div>
  121. <h3 id="constructors">Constructors
  122. </h3>
  123. <a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
  124. <h4 id="Grpc_Health_V1_Health_HealthClient__ctor" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor">HealthClient()</h4>
  125. <div class="markdown level1 summary"><p>Protected parameterless constructor to allow creation of test doubles.</p>
  126. </div>
  127. <div class="markdown level1 conceptual"></div>
  128. <h5 class="decalaration">Declaration</h5>
  129. <div class="codewrapper">
  130. <pre><code class="lang-csharp hljs">protected HealthClient()</code></pre>
  131. </div>
  132. <a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
  133. <h4 id="Grpc_Health_V1_Health_HealthClient__ctor_Grpc_Core_CallInvoker_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor(Grpc.Core.CallInvoker)">HealthClient(CallInvoker)</h4>
  134. <div class="markdown level1 summary"><p>Creates a new client for Health that uses a custom <code>CallInvoker</code>.</p>
  135. </div>
  136. <div class="markdown level1 conceptual"></div>
  137. <h5 class="decalaration">Declaration</h5>
  138. <div class="codewrapper">
  139. <pre><code class="lang-csharp hljs">public HealthClient(CallInvoker callInvoker)</code></pre>
  140. </div>
  141. <h5 class="parameters">Parameters</h5>
  142. <table class="table table-bordered table-striped table-condensed">
  143. <thead>
  144. <tr>
  145. <th>Type</th>
  146. <th>Name</th>
  147. <th>Description</th>
  148. </tr>
  149. </thead>
  150. <tbody>
  151. <tr>
  152. <td><a class="xref" href="Grpc.Core.CallInvoker.html">CallInvoker</a></td>
  153. <td><span class="parametername">callInvoker</span></td>
  154. <td><p>The callInvoker to use to make remote calls.</p>
  155. </td>
  156. </tr>
  157. </tbody>
  158. </table>
  159. <a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
  160. <h4 id="Grpc_Health_V1_Health_HealthClient__ctor_Grpc_Core_ChannelBase_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor(Grpc.Core.ChannelBase)">HealthClient(ChannelBase)</h4>
  161. <div class="markdown level1 summary"><p>Creates a new client for Health</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 HealthClient(ChannelBase channel)</code></pre>
  167. </div>
  168. <h5 class="parameters">Parameters</h5>
  169. <table class="table table-bordered table-striped table-condensed">
  170. <thead>
  171. <tr>
  172. <th>Type</th>
  173. <th>Name</th>
  174. <th>Description</th>
  175. </tr>
  176. </thead>
  177. <tbody>
  178. <tr>
  179. <td><a class="xref" href="Grpc.Core.ChannelBase.html">ChannelBase</a></td>
  180. <td><span class="parametername">channel</span></td>
  181. <td><p>The channel to use to make remote calls.</p>
  182. </td>
  183. </tr>
  184. </tbody>
  185. </table>
  186. <a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
  187. <h4 id="Grpc_Health_V1_Health_HealthClient__ctor_Grpc_Core_ClientBase_ClientBaseConfiguration_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor(Grpc.Core.ClientBase.ClientBaseConfiguration)">HealthClient(ClientBase.ClientBaseConfiguration)</h4>
  188. <div class="markdown level1 summary"><p>Protected constructor to allow creation of configured clients.</p>
  189. </div>
  190. <div class="markdown level1 conceptual"></div>
  191. <h5 class="decalaration">Declaration</h5>
  192. <div class="codewrapper">
  193. <pre><code class="lang-csharp hljs">protected HealthClient(ClientBase.ClientBaseConfiguration configuration)</code></pre>
  194. </div>
  195. <h5 class="parameters">Parameters</h5>
  196. <table class="table table-bordered table-striped table-condensed">
  197. <thead>
  198. <tr>
  199. <th>Type</th>
  200. <th>Name</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><a class="xref" href="Grpc.Core.ClientBase.ClientBaseConfiguration.html">ClientBase.ClientBaseConfiguration</a></td>
  207. <td><span class="parametername">configuration</span></td>
  208. <td><p>The client configuration.</p>
  209. </td>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <h3 id="methods">Methods
  214. </h3>
  215. <a id="Grpc_Health_V1_Health_HealthClient_Check_" data-uid="Grpc.Health.V1.Health.HealthClient.Check*"></a>
  216. <h4 id="Grpc_Health_V1_Health_HealthClient_Check_Grpc_Health_V1_HealthCheckRequest_Grpc_Core_CallOptions_" data-uid="Grpc.Health.V1.Health.HealthClient.Check(Grpc.Health.V1.HealthCheckRequest,Grpc.Core.CallOptions)">Check(HealthCheckRequest, CallOptions)</h4>
  217. <div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
  218. NOT_FOUND.</p>
  219. </div>
  220. <div class="markdown level1 conceptual"></div>
  221. <h5 class="decalaration">Declaration</h5>
  222. <div class="codewrapper">
  223. <pre><code class="lang-csharp hljs">public virtual HealthCheckResponse Check(HealthCheckRequest request, CallOptions options)</code></pre>
  224. </div>
  225. <h5 class="parameters">Parameters</h5>
  226. <table class="table table-bordered table-striped table-condensed">
  227. <thead>
  228. <tr>
  229. <th>Type</th>
  230. <th>Name</th>
  231. <th>Description</th>
  232. </tr>
  233. </thead>
  234. <tbody>
  235. <tr>
  236. <td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
  237. <td><span class="parametername">request</span></td>
  238. <td><p>The request to send to the server.</p>
  239. </td>
  240. </tr>
  241. <tr>
  242. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  243. <td><span class="parametername">options</span></td>
  244. <td><p>The options for the call.</p>
  245. </td>
  246. </tr>
  247. </tbody>
  248. </table>
  249. <h5 class="returns">Returns</h5>
  250. <table class="table table-bordered table-striped table-condensed">
  251. <thead>
  252. <tr>
  253. <th>Type</th>
  254. <th>Description</th>
  255. </tr>
  256. </thead>
  257. <tbody>
  258. <tr>
  259. <td><a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a></td>
  260. <td><p>The response received from the server.</p>
  261. </td>
  262. </tr>
  263. </tbody>
  264. </table>
  265. <a id="Grpc_Health_V1_Health_HealthClient_Check_" data-uid="Grpc.Health.V1.Health.HealthClient.Check*"></a>
  266. <h4 id="Grpc_Health_V1_Health_HealthClient_Check_Grpc_Health_V1_HealthCheckRequest_Grpc_Core_Metadata_System_Nullable_System_DateTime__System_Threading_CancellationToken_" data-uid="Grpc.Health.V1.Health.HealthClient.Check(Grpc.Health.V1.HealthCheckRequest,Grpc.Core.Metadata,System.Nullable{System.DateTime},System.Threading.CancellationToken)">Check(HealthCheckRequest, Metadata, Nullable&lt;DateTime&gt;, CancellationToken)</h4>
  267. <div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
  268. NOT_FOUND.</p>
  269. </div>
  270. <div class="markdown level1 conceptual"></div>
  271. <h5 class="decalaration">Declaration</h5>
  272. <div class="codewrapper">
  273. <pre><code class="lang-csharp hljs">public virtual HealthCheckResponse Check(HealthCheckRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  274. </div>
  275. <h5 class="parameters">Parameters</h5>
  276. <table class="table table-bordered table-striped table-condensed">
  277. <thead>
  278. <tr>
  279. <th>Type</th>
  280. <th>Name</th>
  281. <th>Description</th>
  282. </tr>
  283. </thead>
  284. <tbody>
  285. <tr>
  286. <td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
  287. <td><span class="parametername">request</span></td>
  288. <td><p>The request to send to the server.</p>
  289. </td>
  290. </tr>
  291. <tr>
  292. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  293. <td><span class="parametername">headers</span></td>
  294. <td><p>The initial metadata to send with the call. This parameter is optional.</p>
  295. </td>
  296. </tr>
  297. <tr>
  298. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTime</span>&gt;</td>
  299. <td><span class="parametername">deadline</span></td>
  300. <td><p>An optional deadline for the call. The call will be cancelled if deadline is hit.</p>
  301. </td>
  302. </tr>
  303. <tr>
  304. <td><span class="xref">System.Threading.CancellationToken</span></td>
  305. <td><span class="parametername">cancellationToken</span></td>
  306. <td><p>An optional token for canceling the call.</p>
  307. </td>
  308. </tr>
  309. </tbody>
  310. </table>
  311. <h5 class="returns">Returns</h5>
  312. <table class="table table-bordered table-striped table-condensed">
  313. <thead>
  314. <tr>
  315. <th>Type</th>
  316. <th>Description</th>
  317. </tr>
  318. </thead>
  319. <tbody>
  320. <tr>
  321. <td><a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a></td>
  322. <td><p>The response received from the server.</p>
  323. </td>
  324. </tr>
  325. </tbody>
  326. </table>
  327. <a id="Grpc_Health_V1_Health_HealthClient_CheckAsync_" data-uid="Grpc.Health.V1.Health.HealthClient.CheckAsync*"></a>
  328. <h4 id="Grpc_Health_V1_Health_HealthClient_CheckAsync_Grpc_Health_V1_HealthCheckRequest_Grpc_Core_CallOptions_" data-uid="Grpc.Health.V1.Health.HealthClient.CheckAsync(Grpc.Health.V1.HealthCheckRequest,Grpc.Core.CallOptions)">CheckAsync(HealthCheckRequest, CallOptions)</h4>
  329. <div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
  330. NOT_FOUND.</p>
  331. </div>
  332. <div class="markdown level1 conceptual"></div>
  333. <h5 class="decalaration">Declaration</h5>
  334. <div class="codewrapper">
  335. <pre><code class="lang-csharp hljs">public virtual AsyncUnaryCall&lt;HealthCheckResponse&gt; CheckAsync(HealthCheckRequest request, CallOptions options)</code></pre>
  336. </div>
  337. <h5 class="parameters">Parameters</h5>
  338. <table class="table table-bordered table-striped table-condensed">
  339. <thead>
  340. <tr>
  341. <th>Type</th>
  342. <th>Name</th>
  343. <th>Description</th>
  344. </tr>
  345. </thead>
  346. <tbody>
  347. <tr>
  348. <td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
  349. <td><span class="parametername">request</span></td>
  350. <td><p>The request to send to the server.</p>
  351. </td>
  352. </tr>
  353. <tr>
  354. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  355. <td><span class="parametername">options</span></td>
  356. <td><p>The options for the call.</p>
  357. </td>
  358. </tr>
  359. </tbody>
  360. </table>
  361. <h5 class="returns">Returns</h5>
  362. <table class="table table-bordered table-striped table-condensed">
  363. <thead>
  364. <tr>
  365. <th>Type</th>
  366. <th>Description</th>
  367. </tr>
  368. </thead>
  369. <tbody>
  370. <tr>
  371. <td><a class="xref" href="Grpc.Core.AsyncUnaryCall-1.html">AsyncUnaryCall</a>&lt;<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>&gt;</td>
  372. <td><p>The call object.</p>
  373. </td>
  374. </tr>
  375. </tbody>
  376. </table>
  377. <a id="Grpc_Health_V1_Health_HealthClient_CheckAsync_" data-uid="Grpc.Health.V1.Health.HealthClient.CheckAsync*"></a>
  378. <h4 id="Grpc_Health_V1_Health_HealthClient_CheckAsync_Grpc_Health_V1_HealthCheckRequest_Grpc_Core_Metadata_System_Nullable_System_DateTime__System_Threading_CancellationToken_" data-uid="Grpc.Health.V1.Health.HealthClient.CheckAsync(Grpc.Health.V1.HealthCheckRequest,Grpc.Core.Metadata,System.Nullable{System.DateTime},System.Threading.CancellationToken)">CheckAsync(HealthCheckRequest, Metadata, Nullable&lt;DateTime&gt;, CancellationToken)</h4>
  379. <div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
  380. NOT_FOUND.</p>
  381. </div>
  382. <div class="markdown level1 conceptual"></div>
  383. <h5 class="decalaration">Declaration</h5>
  384. <div class="codewrapper">
  385. <pre><code class="lang-csharp hljs">public virtual AsyncUnaryCall&lt;HealthCheckResponse&gt; CheckAsync(HealthCheckRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  386. </div>
  387. <h5 class="parameters">Parameters</h5>
  388. <table class="table table-bordered table-striped table-condensed">
  389. <thead>
  390. <tr>
  391. <th>Type</th>
  392. <th>Name</th>
  393. <th>Description</th>
  394. </tr>
  395. </thead>
  396. <tbody>
  397. <tr>
  398. <td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
  399. <td><span class="parametername">request</span></td>
  400. <td><p>The request to send to the server.</p>
  401. </td>
  402. </tr>
  403. <tr>
  404. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  405. <td><span class="parametername">headers</span></td>
  406. <td><p>The initial metadata to send with the call. This parameter is optional.</p>
  407. </td>
  408. </tr>
  409. <tr>
  410. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTime</span>&gt;</td>
  411. <td><span class="parametername">deadline</span></td>
  412. <td><p>An optional deadline for the call. The call will be cancelled if deadline is hit.</p>
  413. </td>
  414. </tr>
  415. <tr>
  416. <td><span class="xref">System.Threading.CancellationToken</span></td>
  417. <td><span class="parametername">cancellationToken</span></td>
  418. <td><p>An optional token for canceling the call.</p>
  419. </td>
  420. </tr>
  421. </tbody>
  422. </table>
  423. <h5 class="returns">Returns</h5>
  424. <table class="table table-bordered table-striped table-condensed">
  425. <thead>
  426. <tr>
  427. <th>Type</th>
  428. <th>Description</th>
  429. </tr>
  430. </thead>
  431. <tbody>
  432. <tr>
  433. <td><a class="xref" href="Grpc.Core.AsyncUnaryCall-1.html">AsyncUnaryCall</a>&lt;<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>&gt;</td>
  434. <td><p>The call object.</p>
  435. </td>
  436. </tr>
  437. </tbody>
  438. </table>
  439. <a id="Grpc_Health_V1_Health_HealthClient_NewInstance_" data-uid="Grpc.Health.V1.Health.HealthClient.NewInstance*"></a>
  440. <h4 id="Grpc_Health_V1_Health_HealthClient_NewInstance_Grpc_Core_ClientBase_ClientBaseConfiguration_" data-uid="Grpc.Health.V1.Health.HealthClient.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)">NewInstance(ClientBase.ClientBaseConfiguration)</h4>
  441. <div class="markdown level1 summary"><p>Creates a new instance of client from given <code>ClientBaseConfiguration</code>.</p>
  442. </div>
  443. <div class="markdown level1 conceptual"></div>
  444. <h5 class="decalaration">Declaration</h5>
  445. <div class="codewrapper">
  446. <pre><code class="lang-csharp hljs">protected override Health.HealthClient NewInstance(ClientBase.ClientBaseConfiguration configuration)</code></pre>
  447. </div>
  448. <h5 class="parameters">Parameters</h5>
  449. <table class="table table-bordered table-striped table-condensed">
  450. <thead>
  451. <tr>
  452. <th>Type</th>
  453. <th>Name</th>
  454. <th>Description</th>
  455. </tr>
  456. </thead>
  457. <tbody>
  458. <tr>
  459. <td><a class="xref" href="Grpc.Core.ClientBase.ClientBaseConfiguration.html">ClientBase.ClientBaseConfiguration</a></td>
  460. <td><span class="parametername">configuration</span></td>
  461. <td></td>
  462. </tr>
  463. </tbody>
  464. </table>
  465. <h5 class="returns">Returns</h5>
  466. <table class="table table-bordered table-striped table-condensed">
  467. <thead>
  468. <tr>
  469. <th>Type</th>
  470. <th>Description</th>
  471. </tr>
  472. </thead>
  473. <tbody>
  474. <tr>
  475. <td><a class="xref" href="Grpc.Health.V1.Health.HealthClient.html">Health.HealthClient</a></td>
  476. <td></td>
  477. </tr>
  478. </tbody>
  479. </table>
  480. <h5 class="overrides">Overrides</h5>
  481. <div><span class="xref">Grpc.Core.ClientBase&lt;Grpc.Health.V1.Health.HealthClient&gt;.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)</span></div>
  482. <a id="Grpc_Health_V1_Health_HealthClient_Watch_" data-uid="Grpc.Health.V1.Health.HealthClient.Watch*"></a>
  483. <h4 id="Grpc_Health_V1_Health_HealthClient_Watch_Grpc_Health_V1_HealthCheckRequest_Grpc_Core_CallOptions_" data-uid="Grpc.Health.V1.Health.HealthClient.Watch(Grpc.Health.V1.HealthCheckRequest,Grpc.Core.CallOptions)">Watch(HealthCheckRequest, CallOptions)</h4>
  484. <div class="markdown level1 summary"><p>Performs a watch for the serving status of the requested service.
  485. The server will immediately send back a message indicating the current
  486. serving status. It will then subsequently send a new message whenever
  487. the service&apos;s serving status changes.</p>
  488. <p>If the requested service is unknown when the call is received, the
  489. server will send a message setting the serving status to
  490. SERVICE_UNKNOWN but will <em>not</em> terminate the call. If at some
  491. future point, the serving status of the service becomes known, the
  492. server will send a new message with the service&apos;s serving status.</p>
  493. <p>If the call terminates with status UNIMPLEMENTED, then clients
  494. should assume this method is not supported and should not retry the
  495. call. If the call terminates with any other status (including OK),
  496. clients should retry the call with appropriate exponential backoff.</p>
  497. </div>
  498. <div class="markdown level1 conceptual"></div>
  499. <h5 class="decalaration">Declaration</h5>
  500. <div class="codewrapper">
  501. <pre><code class="lang-csharp hljs">public virtual AsyncServerStreamingCall&lt;HealthCheckResponse&gt; Watch(HealthCheckRequest request, CallOptions options)</code></pre>
  502. </div>
  503. <h5 class="parameters">Parameters</h5>
  504. <table class="table table-bordered table-striped table-condensed">
  505. <thead>
  506. <tr>
  507. <th>Type</th>
  508. <th>Name</th>
  509. <th>Description</th>
  510. </tr>
  511. </thead>
  512. <tbody>
  513. <tr>
  514. <td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
  515. <td><span class="parametername">request</span></td>
  516. <td><p>The request to send to the server.</p>
  517. </td>
  518. </tr>
  519. <tr>
  520. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  521. <td><span class="parametername">options</span></td>
  522. <td><p>The options for the call.</p>
  523. </td>
  524. </tr>
  525. </tbody>
  526. </table>
  527. <h5 class="returns">Returns</h5>
  528. <table class="table table-bordered table-striped table-condensed">
  529. <thead>
  530. <tr>
  531. <th>Type</th>
  532. <th>Description</th>
  533. </tr>
  534. </thead>
  535. <tbody>
  536. <tr>
  537. <td><a class="xref" href="Grpc.Core.AsyncServerStreamingCall-1.html">AsyncServerStreamingCall</a>&lt;<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>&gt;</td>
  538. <td><p>The call object.</p>
  539. </td>
  540. </tr>
  541. </tbody>
  542. </table>
  543. <a id="Grpc_Health_V1_Health_HealthClient_Watch_" data-uid="Grpc.Health.V1.Health.HealthClient.Watch*"></a>
  544. <h4 id="Grpc_Health_V1_Health_HealthClient_Watch_Grpc_Health_V1_HealthCheckRequest_Grpc_Core_Metadata_System_Nullable_System_DateTime__System_Threading_CancellationToken_" data-uid="Grpc.Health.V1.Health.HealthClient.Watch(Grpc.Health.V1.HealthCheckRequest,Grpc.Core.Metadata,System.Nullable{System.DateTime},System.Threading.CancellationToken)">Watch(HealthCheckRequest, Metadata, Nullable&lt;DateTime&gt;, CancellationToken)</h4>
  545. <div class="markdown level1 summary"><p>Performs a watch for the serving status of the requested service.
  546. The server will immediately send back a message indicating the current
  547. serving status. It will then subsequently send a new message whenever
  548. the service&apos;s serving status changes.</p>
  549. <p>If the requested service is unknown when the call is received, the
  550. server will send a message setting the serving status to
  551. SERVICE_UNKNOWN but will <em>not</em> terminate the call. If at some
  552. future point, the serving status of the service becomes known, the
  553. server will send a new message with the service&apos;s serving status.</p>
  554. <p>If the call terminates with status UNIMPLEMENTED, then clients
  555. should assume this method is not supported and should not retry the
  556. call. If the call terminates with any other status (including OK),
  557. clients should retry the call with appropriate exponential backoff.</p>
  558. </div>
  559. <div class="markdown level1 conceptual"></div>
  560. <h5 class="decalaration">Declaration</h5>
  561. <div class="codewrapper">
  562. <pre><code class="lang-csharp hljs">public virtual AsyncServerStreamingCall&lt;HealthCheckResponse&gt; Watch(HealthCheckRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  563. </div>
  564. <h5 class="parameters">Parameters</h5>
  565. <table class="table table-bordered table-striped table-condensed">
  566. <thead>
  567. <tr>
  568. <th>Type</th>
  569. <th>Name</th>
  570. <th>Description</th>
  571. </tr>
  572. </thead>
  573. <tbody>
  574. <tr>
  575. <td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
  576. <td><span class="parametername">request</span></td>
  577. <td><p>The request to send to the server.</p>
  578. </td>
  579. </tr>
  580. <tr>
  581. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  582. <td><span class="parametername">headers</span></td>
  583. <td><p>The initial metadata to send with the call. This parameter is optional.</p>
  584. </td>
  585. </tr>
  586. <tr>
  587. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTime</span>&gt;</td>
  588. <td><span class="parametername">deadline</span></td>
  589. <td><p>An optional deadline for the call. The call will be cancelled if deadline is hit.</p>
  590. </td>
  591. </tr>
  592. <tr>
  593. <td><span class="xref">System.Threading.CancellationToken</span></td>
  594. <td><span class="parametername">cancellationToken</span></td>
  595. <td><p>An optional token for canceling the call.</p>
  596. </td>
  597. </tr>
  598. </tbody>
  599. </table>
  600. <h5 class="returns">Returns</h5>
  601. <table class="table table-bordered table-striped table-condensed">
  602. <thead>
  603. <tr>
  604. <th>Type</th>
  605. <th>Description</th>
  606. </tr>
  607. </thead>
  608. <tbody>
  609. <tr>
  610. <td><a class="xref" href="Grpc.Core.AsyncServerStreamingCall-1.html">AsyncServerStreamingCall</a>&lt;<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>&gt;</td>
  611. <td><p>The call object.</p>
  612. </td>
  613. </tr>
  614. </tbody>
  615. </table>
  616. </article>
  617. </div>
  618. <div class="hidden-sm col-md-2" role="complementary">
  619. <div class="sideaffix">
  620. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  621. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  622. </nav>
  623. </div>
  624. </div>
  625. </div>
  626. </div>
  627. <footer>
  628. <div class="grad-bottom"></div>
  629. <div class="footer">
  630. <div class="container">
  631. <span class="pull-right">
  632. <a href="#top">Back to top</a>
  633. </span>
  634. <span>Generated by <strong>DocFX</strong></span>
  635. </div>
  636. </div>
  637. </footer>
  638. </div>
  639. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  640. <script type="text/javascript" src="../styles/docfx.js"></script>
  641. <script type="text/javascript" src="../styles/main.js"></script>
  642. </body>
  643. </html>