java-sdk/docs/io/dapr/DaprClientGrpc.html

415 lines
19 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (13.0.2) on Thu Apr 09 18:34:28 PDT 2020 -->
<title>DaprClientGrpc (dapr-sdk-parent 0.4.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-09">
<meta name="description" content="declaration: package: io.dapr, class: DaprClientGrpc">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DaprClientGrpc.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.dapr</a></div>
<h1 title="Class DaprClientGrpc" class="title">Class DaprClientGrpc</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">io.dapr.DaprClientGrpc</div>
</div>
<section class="description">
<hr>
<pre>@Generated(value="by gRPC proto compiler (version 1.25.0)",
comments="Source: daprclient.proto")
public final class <span class="typeNameLabel">DaprClientGrpc</span>
extends java.lang.Object</pre>
<div class="block"><pre>
User Code definitions
</pre></div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li class="blockList">
<section class="nestedClassSummary"><a id="nested.class.summary">
<!-- -->
</a>
<h2>Nested Class Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="DaprClientGrpc.DaprClientBlockingStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientBlockingStub</a></span></code></th>
<td class="colLast">
<div class="block">
User Code definitions</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="DaprClientGrpc.DaprClientFutureStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientFutureStub</a></span></code></th>
<td class="colLast">
<div class="block">
User Code definitions</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="DaprClientGrpc.DaprClientImplBase.html" title="class in io.dapr">DaprClientGrpc.DaprClientImplBase</a></span></code></th>
<td class="colLast">
<div class="block">
User Code definitions</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="DaprClientGrpc.DaprClientStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientStub</a></span></code></th>
<td class="colLast">
<div class="block">
User Code definitions</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li class="blockList">
<section class="fieldSummary"><a id="field.summary">
<!-- -->
</a>
<h2>Field Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SERVICE_NAME">SERVICE_NAME</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>static io.grpc.MethodDescriptor&lt;com.google.protobuf.Empty,&#8203;<a href="DaprClientProtos.GetBindingsSubscriptionsEnvelope.html" title="class in io.dapr">DaprClientProtos.GetBindingsSubscriptionsEnvelope</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGetBindingsSubscriptionsMethod()">getGetBindingsSubscriptionsMethod</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static io.grpc.MethodDescriptor&lt;com.google.protobuf.Empty,&#8203;<a href="DaprClientProtos.GetTopicSubscriptionsEnvelope.html" title="class in io.dapr">DaprClientProtos.GetTopicSubscriptionsEnvelope</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGetTopicSubscriptionsMethod()">getGetTopicSubscriptionsMethod</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>static io.grpc.MethodDescriptor&lt;<a href="DaprClientProtos.BindingEventEnvelope.html" title="class in io.dapr">DaprClientProtos.BindingEventEnvelope</a>,&#8203;<a href="DaprClientProtos.BindingResponseEnvelope.html" title="class in io.dapr">DaprClientProtos.BindingResponseEnvelope</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOnBindingEventMethod()">getOnBindingEventMethod</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>static io.grpc.MethodDescriptor&lt;<a href="DaprClientProtos.InvokeEnvelope.html" title="class in io.dapr">DaprClientProtos.InvokeEnvelope</a>,&#8203;com.google.protobuf.Any&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOnInvokeMethod()">getOnInvokeMethod</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>static io.grpc.MethodDescriptor&lt;<a href="DaprClientProtos.CloudEventEnvelope.html" title="class in io.dapr">DaprClientProtos.CloudEventEnvelope</a>,&#8203;com.google.protobuf.Empty&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOnTopicEventMethod()">getOnTopicEventMethod</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>static io.grpc.ServiceDescriptor</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServiceDescriptor()">getServiceDescriptor</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>static <a href="DaprClientGrpc.DaprClientBlockingStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientBlockingStub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newBlockingStub(io.grpc.Channel)">newBlockingStub</a></span>&#8203;(io.grpc.Channel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Creates a new blocking-style stub that supports unary and streaming output calls on the service</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>static <a href="DaprClientGrpc.DaprClientFutureStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientFutureStub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newFutureStub(io.grpc.Channel)">newFutureStub</a></span>&#8203;(io.grpc.Channel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Creates a new ListenableFuture-style stub that supports unary calls on the service</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>static <a href="DaprClientGrpc.DaprClientStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientStub</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newStub(io.grpc.Channel)">newStub</a></span>&#8203;(io.grpc.Channel&nbsp;channel)</code></th>
<td class="colLast">
<div class="block">Creates a new async stub that supports all call types for the service</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<li class="blockList">
<section class="fieldDetails"><a id="field.detail">
<!-- -->
</a>
<h2>Field Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="SERVICE_NAME">SERVICE_NAME</a></h3>
<div class="memberSignature"><span class="modifiers">public static final</span>&nbsp;<span class="returnType">java.lang.String</span>&nbsp;<span class="memberName">SERVICE_NAME</span></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#io.dapr.DaprClientGrpc.SERVICE_NAME">Constant Field Values</a></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="getOnInvokeMethod()">getOnInvokeMethod</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">io.grpc.MethodDescriptor&lt;<a href="DaprClientProtos.InvokeEnvelope.html" title="class in io.dapr">DaprClientProtos.InvokeEnvelope</a>,&#8203;com.google.protobuf.Any&gt;</span>&nbsp;<span class="memberName">getOnInvokeMethod</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getGetTopicSubscriptionsMethod()">getGetTopicSubscriptionsMethod</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">io.grpc.MethodDescriptor&lt;com.google.protobuf.Empty,&#8203;<a href="DaprClientProtos.GetTopicSubscriptionsEnvelope.html" title="class in io.dapr">DaprClientProtos.GetTopicSubscriptionsEnvelope</a>&gt;</span>&nbsp;<span class="memberName">getGetTopicSubscriptionsMethod</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getGetBindingsSubscriptionsMethod()">getGetBindingsSubscriptionsMethod</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">io.grpc.MethodDescriptor&lt;com.google.protobuf.Empty,&#8203;<a href="DaprClientProtos.GetBindingsSubscriptionsEnvelope.html" title="class in io.dapr">DaprClientProtos.GetBindingsSubscriptionsEnvelope</a>&gt;</span>&nbsp;<span class="memberName">getGetBindingsSubscriptionsMethod</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getOnBindingEventMethod()">getOnBindingEventMethod</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">io.grpc.MethodDescriptor&lt;<a href="DaprClientProtos.BindingEventEnvelope.html" title="class in io.dapr">DaprClientProtos.BindingEventEnvelope</a>,&#8203;<a href="DaprClientProtos.BindingResponseEnvelope.html" title="class in io.dapr">DaprClientProtos.BindingResponseEnvelope</a>&gt;</span>&nbsp;<span class="memberName">getOnBindingEventMethod</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getOnTopicEventMethod()">getOnTopicEventMethod</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">io.grpc.MethodDescriptor&lt;<a href="DaprClientProtos.CloudEventEnvelope.html" title="class in io.dapr">DaprClientProtos.CloudEventEnvelope</a>,&#8203;com.google.protobuf.Empty&gt;</span>&nbsp;<span class="memberName">getOnTopicEventMethod</span>()</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="newStub(io.grpc.Channel)">newStub</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="DaprClientGrpc.DaprClientStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientStub</a></span>&nbsp;<span class="memberName">newStub</span>&#8203;(<span class="arguments">io.grpc.Channel&nbsp;channel)</span></div>
<div class="block">Creates a new async stub that supports all call types for the service</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="newBlockingStub(io.grpc.Channel)">newBlockingStub</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="DaprClientGrpc.DaprClientBlockingStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientBlockingStub</a></span>&nbsp;<span class="memberName">newBlockingStub</span>&#8203;(<span class="arguments">io.grpc.Channel&nbsp;channel)</span></div>
<div class="block">Creates a new blocking-style stub that supports unary and streaming output calls on the service</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="newFutureStub(io.grpc.Channel)">newFutureStub</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="DaprClientGrpc.DaprClientFutureStub.html" title="class in io.dapr">DaprClientGrpc.DaprClientFutureStub</a></span>&nbsp;<span class="memberName">newFutureStub</span>&#8203;(<span class="arguments">io.grpc.Channel&nbsp;channel)</span></div>
<div class="block">Creates a new ListenableFuture-style stub that supports unary calls on the service</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getServiceDescriptor()">getServiceDescriptor</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">io.grpc.ServiceDescriptor</span>&nbsp;<span class="memberName">getServiceDescriptor</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DaprClientGrpc.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
</footer>
</body>
</html>