659 lines
28 KiB
HTML
659 lines
28 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class Health.HealthClient
|
|
| gRPC C# </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class Health.HealthClient
|
|
| gRPC C# ">
|
|
<meta name="generator" content="docfx 2.36.0.0">
|
|
|
|
<link rel="shortcut icon" href="../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="../logo.svg" 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"></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Grpc.Health.V1.Health.HealthClient">
|
|
|
|
|
|
<h1 id="Grpc_Health_V1_Health_HealthClient" data-uid="Grpc.Health.V1.Health.HealthClient" class="text-break">Class Health.HealthClient
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Client for Health</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><a class="xref" href="Grpc.Core.ClientBase.html">ClientBase</a></div>
|
|
<div class="level2"><a class="xref" href="Grpc.Core.ClientBase-1.html">ClientBase</a><<a class="xref" href="Grpc.Health.V1.Health.HealthClient.html">Health.HealthClient</a>></div>
|
|
<div class="level3"><span class="xref">Health.HealthClient</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Grpc.Core.ClientBase-1.html#Grpc_Core_ClientBase_1_WithHost_System_String_">ClientBase<Health.HealthClient>.WithHost(String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Grpc.Core.ClientBase.html#Grpc_Core_ClientBase_CallInvoker">ClientBase.CallInvoker</a>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Health.V1.html">Grpc.Health.V1</a></h6>
|
|
<h6><strong>Assembly</strong>: Grpc.HealthCheck.dll</h6>
|
|
<h5 id="Grpc_Health_V1_Health_HealthClient_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class HealthClient : ClientBase<Health.HealthClient></code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
<a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
|
|
<h4 id="Grpc_Health_V1_Health_HealthClient__ctor" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor">HealthClient()</h4>
|
|
<div class="markdown level1 summary"><p>Protected parameterless constructor to allow creation of test doubles.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected HealthClient()</code></pre>
|
|
</div>
|
|
<a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Creates a new client for Health that uses a custom <code>CallInvoker</code>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public HealthClient(CallInvoker callInvoker)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.CallInvoker.html">CallInvoker</a></td>
|
|
<td><span class="parametername">callInvoker</span></td>
|
|
<td><p>The callInvoker to use to make remote calls.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Creates a new client for Health</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public HealthClient(ChannelBase channel)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ChannelBase.html">ChannelBase</a></td>
|
|
<td><span class="parametername">channel</span></td>
|
|
<td><p>The channel to use to make remote calls.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Health_V1_Health_HealthClient__ctor_" data-uid="Grpc.Health.V1.Health.HealthClient.#ctor*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Protected constructor to allow creation of configured clients.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected HealthClient(ClientBase.ClientBaseConfiguration configuration)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ClientBase.ClientBaseConfiguration.html">ClientBase.ClientBaseConfiguration</a></td>
|
|
<td><span class="parametername">configuration</span></td>
|
|
<td><p>The client configuration.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<a id="Grpc_Health_V1_Health_HealthClient_Check_" data-uid="Grpc.Health.V1.Health.HealthClient.Check*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
|
|
NOT_FOUND.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual HealthCheckResponse Check(HealthCheckRequest request, CallOptions options)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request to send to the server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>The options for the call.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a></td>
|
|
<td><p>The response received from the server.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Health_V1_Health_HealthClient_Check_" data-uid="Grpc.Health.V1.Health.HealthClient.Check*"></a>
|
|
<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<DateTime>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
|
|
NOT_FOUND.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<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>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request to send to the server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
|
|
<td><span class="parametername">headers</span></td>
|
|
<td><p>The initial metadata to send with the call. This parameter is optional.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTime</span>></td>
|
|
<td><span class="parametername">deadline</span></td>
|
|
<td><p>An optional deadline for the call. The call will be cancelled if deadline is hit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>An optional token for canceling the call.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a></td>
|
|
<td><p>The response received from the server.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Health_V1_Health_HealthClient_CheckAsync_" data-uid="Grpc.Health.V1.Health.HealthClient.CheckAsync*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
|
|
NOT_FOUND.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncUnaryCall<HealthCheckResponse> CheckAsync(HealthCheckRequest request, CallOptions options)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request to send to the server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>The options for the call.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.AsyncUnaryCall-1.html">AsyncUnaryCall</a><<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>></td>
|
|
<td><p>The call object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Health_V1_Health_HealthClient_CheckAsync_" data-uid="Grpc.Health.V1.Health.HealthClient.CheckAsync*"></a>
|
|
<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<DateTime>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>If the requested service is unknown, the call will fail with status
|
|
NOT_FOUND.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncUnaryCall<HealthCheckResponse> CheckAsync(HealthCheckRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request to send to the server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
|
|
<td><span class="parametername">headers</span></td>
|
|
<td><p>The initial metadata to send with the call. This parameter is optional.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTime</span>></td>
|
|
<td><span class="parametername">deadline</span></td>
|
|
<td><p>An optional deadline for the call. The call will be cancelled if deadline is hit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>An optional token for canceling the call.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.AsyncUnaryCall-1.html">AsyncUnaryCall</a><<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>></td>
|
|
<td><p>The call object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Health_V1_Health_HealthClient_NewInstance_" data-uid="Grpc.Health.V1.Health.HealthClient.NewInstance*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Creates a new instance of client from given <code>ClientBaseConfiguration</code>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override Health.HealthClient NewInstance(ClientBase.ClientBaseConfiguration configuration)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ClientBase.ClientBaseConfiguration.html">ClientBase.ClientBaseConfiguration</a></td>
|
|
<td><span class="parametername">configuration</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.Health.HealthClient.html">Health.HealthClient</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">Grpc.Core.ClientBase<Grpc.Health.V1.Health.HealthClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)</span></div>
|
|
<a id="Grpc_Health_V1_Health_HealthClient_Watch_" data-uid="Grpc.Health.V1.Health.HealthClient.Watch*"></a>
|
|
<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>
|
|
<div class="markdown level1 summary"><p>Performs a watch for the serving status of the requested service.
|
|
The server will immediately send back a message indicating the current
|
|
serving status. It will then subsequently send a new message whenever
|
|
the service's serving status changes.</p>
|
|
<p>If the requested service is unknown when the call is received, the
|
|
server will send a message setting the serving status to
|
|
SERVICE_UNKNOWN but will <em>not</em> terminate the call. If at some
|
|
future point, the serving status of the service becomes known, the
|
|
server will send a new message with the service's serving status.</p>
|
|
<p>If the call terminates with status UNIMPLEMENTED, then clients
|
|
should assume this method is not supported and should not retry the
|
|
call. If the call terminates with any other status (including OK),
|
|
clients should retry the call with appropriate exponential backoff.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncServerStreamingCall<HealthCheckResponse> Watch(HealthCheckRequest request, CallOptions options)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request to send to the server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td><p>The options for the call.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.AsyncServerStreamingCall-1.html">AsyncServerStreamingCall</a><<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>></td>
|
|
<td><p>The call object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Health_V1_Health_HealthClient_Watch_" data-uid="Grpc.Health.V1.Health.HealthClient.Watch*"></a>
|
|
<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<DateTime>, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Performs a watch for the serving status of the requested service.
|
|
The server will immediately send back a message indicating the current
|
|
serving status. It will then subsequently send a new message whenever
|
|
the service's serving status changes.</p>
|
|
<p>If the requested service is unknown when the call is received, the
|
|
server will send a message setting the serving status to
|
|
SERVICE_UNKNOWN but will <em>not</em> terminate the call. If at some
|
|
future point, the serving status of the service becomes known, the
|
|
server will send a new message with the service's serving status.</p>
|
|
<p>If the call terminates with status UNIMPLEMENTED, then clients
|
|
should assume this method is not supported and should not retry the
|
|
call. If the call terminates with any other status (including OK),
|
|
clients should retry the call with appropriate exponential backoff.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncServerStreamingCall<HealthCheckResponse> Watch(HealthCheckRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Health.V1.HealthCheckRequest.html">HealthCheckRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request to send to the server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
|
|
<td><span class="parametername">headers</span></td>
|
|
<td><p>The initial metadata to send with the call. This parameter is optional.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTime</span>></td>
|
|
<td><span class="parametername">deadline</span></td>
|
|
<td><p>An optional deadline for the call. The call will be cancelled if deadline is hit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.CancellationToken</span></td>
|
|
<td><span class="parametername">cancellationToken</span></td>
|
|
<td><p>An optional token for canceling the call.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.AsyncServerStreamingCall-1.html">AsyncServerStreamingCall</a><<a class="xref" href="Grpc.Health.V1.HealthCheckResponse.html">HealthCheckResponse</a>></td>
|
|
<td><p>The call object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</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">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</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>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</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>
|