grpc_health_checking.html 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <title>gRPC Health Checking &#8212; gRPC Python 1.17.1rc1 documentation</title>
  8. <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  11. <script type="text/javascript" src="_static/jquery.js"></script>
  12. <script type="text/javascript" src="_static/underscore.js"></script>
  13. <script type="text/javascript" src="_static/doctools.js"></script>
  14. <link rel="index" title="Index" href="genindex.html" />
  15. <link rel="search" title="Search" href="search.html" />
  16. <link rel="next" title="gRPC Reflection" href="grpc_reflection.html" />
  17. <link rel="prev" title="gRPC" href="grpc.html" />
  18. <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  19. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  20. </head><body>
  21. <div class="document">
  22. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  23. <div class="sphinxsidebarwrapper">
  24. <h1 class="logo"><a href="index.html">gRPC Python</a></h1>
  25. <p class="blurb">1.17.1rc1</p>
  26. <h3>Navigation</h3>
  27. <p class="caption"><span class="caption-text">Contents:</span></p>
  28. <ul class="current">
  29. <li class="toctree-l1"><a class="reference internal" href="grpc.html">gRPC</a></li>
  30. <li class="toctree-l1 current"><a class="current reference internal" href="#">gRPC Health Checking</a><ul>
  31. <li class="toctree-l2"><a class="reference internal" href="#module-contents">Module Contents</a></li>
  32. </ul>
  33. </li>
  34. <li class="toctree-l1"><a class="reference internal" href="grpc_reflection.html">gRPC Reflection</a></li>
  35. <li class="toctree-l1"><a class="reference internal" href="grpc_testing.html">gRPC Testing</a></li>
  36. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  37. </ul>
  38. <div class="relations">
  39. <h3>Related Topics</h3>
  40. <ul>
  41. <li><a href="index.html">Documentation overview</a><ul>
  42. <li>Previous: <a href="grpc.html" title="previous chapter">gRPC</a></li>
  43. <li>Next: <a href="grpc_reflection.html" title="next chapter">gRPC Reflection</a></li>
  44. </ul></li>
  45. </ul>
  46. </div>
  47. <div id="searchbox" style="display: none" role="search">
  48. <h3>Quick search</h3>
  49. <div class="searchformwrapper">
  50. <form class="search" action="search.html" method="get">
  51. <input type="text" name="q" />
  52. <input type="submit" value="Go" />
  53. <input type="hidden" name="check_keywords" value="yes" />
  54. <input type="hidden" name="area" value="default" />
  55. </form>
  56. </div>
  57. </div>
  58. <script type="text/javascript">$('#searchbox').show(0);</script>
  59. </div>
  60. </div>
  61. <div class="documentwrapper">
  62. <div class="bodywrapper">
  63. <div class="body" role="main">
  64. <div class="section" id="grpc-health-checking">
  65. <h1>gRPC Health Checking<a class="headerlink" href="#grpc-health-checking" title="Permalink to this headline">¶</a></h1>
  66. <div class="section" id="module-contents">
  67. <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
  68. <dl class="class">
  69. <dt id="grpc_health.v1.health.HealthServicer">
  70. <em class="property">class </em><code class="descclassname">grpc_health.v1.health.</code><code class="descname">HealthServicer</code><a class="reference internal" href="_modules/grpc_health/v1/health.html#HealthServicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc_health.v1.health.HealthServicer" title="Permalink to this definition">¶</a></dt>
  71. <dd><p>Servicer handling RPCs for service statuses.</p>
  72. <dl class="method">
  73. <dt id="grpc_health.v1.health.HealthServicer.set">
  74. <code class="descname">set</code><span class="sig-paren">(</span><em>service</em>, <em>status</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_health/v1/health.html#HealthServicer.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc_health.v1.health.HealthServicer.set" title="Permalink to this definition">¶</a></dt>
  75. <dd><p>Sets the status of a service.</p>
  76. <table class="docutils field-list" frame="void" rules="none">
  77. <col class="field-name" />
  78. <col class="field-body" />
  79. <tbody valign="top">
  80. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  81. <li><strong>service</strong> – string, the name of the service.
  82. NOTE, ‘’ must be set.</li>
  83. <li><strong>status</strong> – HealthCheckResponse.status enum value indicating
  84. the status of the service</li>
  85. </ul>
  86. </td>
  87. </tr>
  88. </tbody>
  89. </table>
  90. </dd></dl>
  91. </dd></dl>
  92. </div>
  93. </div>
  94. </div>
  95. </div>
  96. </div>
  97. <div class="clearer"></div>
  98. </div>
  99. <div class="footer">
  100. &copy;2018, The gRPC Authors.
  101. |
  102. <a href="_sources/grpc_health_checking.rst.txt"
  103. rel="nofollow">Page source</a>
  104. </div>
  105. <script type="text/javascript">
  106. var _gaq = _gaq || [];
  107. _gaq.push(['_setAccount', 'UA-60127042-1']);
  108. _gaq.push(['_setDomainName', 'none']);
  109. _gaq.push(['_setAllowLinker', true]);
  110. _gaq.push(['_trackPageview']);
  111. (function() {
  112. var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  113. ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  114. var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  115. })();
  116. </script>
  117. </body>
  118. </html>