client-java/site/apidocs/binlog/PumpGrpc.html

418 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_412) on Tue Jun 04 03:40:07 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PumpGrpc (TiKV Java Client 3.3.4-SNAPSHOT API)</title>
<meta name="date" content="2024-06-04">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PumpGrpc (TiKV Java Client 3.3.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PumpGrpc.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">
<ul class="navList">
<li><a href="../binlog/CisternOuterClass.NotifyRespOrBuilder.html" title="interface in binlog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../binlog/PumpGrpc.AsyncService.html" title="interface in binlog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?binlog/PumpGrpc.html" target="_top">Frames</a></li>
<li><a href="PumpGrpc.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">binlog</div>
<h2 title="Class PumpGrpc" class="title">Class PumpGrpc</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>binlog.PumpGrpc</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html?is-external=true" title="class or interface in javax.annotation">@Generated</a>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html?is-external=true#value--" title="class or interface in javax.annotation">value</a>="by gRPC proto compiler (version 1.60.0)",
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html?is-external=true#comments--" title="class or interface in javax.annotation">comments</a>="Source: binlog/pump.proto")
public final class <span class="typeNameLabel">PumpGrpc</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><pre>
Interfaces exported by Pump.
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.AsyncService.html" title="interface in binlog">PumpGrpc.AsyncService</a></span></code>
<div class="block">
Interfaces exported by Pump.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.PumpBlockingStub.html" title="class in binlog">PumpGrpc.PumpBlockingStub</a></span></code>
<div class="block">A stub to allow clients to do synchronous rpc calls to service Pump.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.PumpFutureStub.html" title="class in binlog">PumpGrpc.PumpFutureStub</a></span></code>
<div class="block">A stub to allow clients to do ListenableFuture-style rpc calls to service Pump.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.PumpImplBase.html" title="class in binlog">PumpGrpc.PumpImplBase</a></span></code>
<div class="block">Base class for the server implementation of the service Pump.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.PumpStub.html" title="class in binlog">PumpGrpc.PumpStub</a></span></code>
<div class="block">A stub to allow clients to do asynchronous rpc calls to service Pump.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#SERVICE_NAME">SERVICE_NAME</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static io.grpc.ServerServiceDefinition</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#bindService-binlog.PumpGrpc.AsyncService-">bindService</a></span>(<a href="../binlog/PumpGrpc.AsyncService.html" title="interface in binlog">PumpGrpc.AsyncService</a>&nbsp;service)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static io.grpc.MethodDescriptor&lt;<a href="../binlog/PumpOuterClass.PullBinlogReq.html" title="class in binlog">PumpOuterClass.PullBinlogReq</a>,<a href="../binlog/PumpOuterClass.PullBinlogResp.html" title="class in binlog">PumpOuterClass.PullBinlogResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#getPullBinlogsMethod--">getPullBinlogsMethod</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static io.grpc.ServiceDescriptor</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#getServiceDescriptor--">getServiceDescriptor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static io.grpc.MethodDescriptor&lt;<a href="../binlog/PumpOuterClass.WriteBinlogReq.html" title="class in binlog">PumpOuterClass.WriteBinlogReq</a>,<a href="../binlog/PumpOuterClass.WriteBinlogResp.html" title="class in binlog">PumpOuterClass.WriteBinlogResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#getWriteBinlogMethod--">getWriteBinlogMethod</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../binlog/PumpGrpc.PumpBlockingStub.html" title="class in binlog">PumpGrpc.PumpBlockingStub</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#newBlockingStub-io.grpc.Channel-">newBlockingStub</a></span>(io.grpc.Channel&nbsp;channel)</code>
<div class="block">Creates a new blocking-style stub that supports unary and streaming output calls on the service</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../binlog/PumpGrpc.PumpFutureStub.html" title="class in binlog">PumpGrpc.PumpFutureStub</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#newFutureStub-io.grpc.Channel-">newFutureStub</a></span>(io.grpc.Channel&nbsp;channel)</code>
<div class="block">Creates a new ListenableFuture-style stub that supports unary calls on the service</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../binlog/PumpGrpc.PumpStub.html" title="class in binlog">PumpGrpc.PumpStub</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/PumpGrpc.html#newStub-io.grpc.Channel-">newStub</a></span>(io.grpc.Channel&nbsp;channel)</code>
<div class="block">Creates a new async stub that supports all call types for the service</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="SERVICE_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SERVICE_NAME</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SERVICE_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#binlog.PumpGrpc.SERVICE_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getWriteBinlogMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBinlogMethod</h4>
<pre>public static&nbsp;io.grpc.MethodDescriptor&lt;<a href="../binlog/PumpOuterClass.WriteBinlogReq.html" title="class in binlog">PumpOuterClass.WriteBinlogReq</a>,<a href="../binlog/PumpOuterClass.WriteBinlogResp.html" title="class in binlog">PumpOuterClass.WriteBinlogResp</a>&gt;&nbsp;getWriteBinlogMethod()</pre>
</li>
</ul>
<a name="getPullBinlogsMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPullBinlogsMethod</h4>
<pre>public static&nbsp;io.grpc.MethodDescriptor&lt;<a href="../binlog/PumpOuterClass.PullBinlogReq.html" title="class in binlog">PumpOuterClass.PullBinlogReq</a>,<a href="../binlog/PumpOuterClass.PullBinlogResp.html" title="class in binlog">PumpOuterClass.PullBinlogResp</a>&gt;&nbsp;getPullBinlogsMethod()</pre>
</li>
</ul>
<a name="newStub-io.grpc.Channel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newStub</h4>
<pre>public static&nbsp;<a href="../binlog/PumpGrpc.PumpStub.html" title="class in binlog">PumpGrpc.PumpStub</a>&nbsp;newStub(io.grpc.Channel&nbsp;channel)</pre>
<div class="block">Creates a new async stub that supports all call types for the service</div>
</li>
</ul>
<a name="newBlockingStub-io.grpc.Channel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBlockingStub</h4>
<pre>public static&nbsp;<a href="../binlog/PumpGrpc.PumpBlockingStub.html" title="class in binlog">PumpGrpc.PumpBlockingStub</a>&nbsp;newBlockingStub(io.grpc.Channel&nbsp;channel)</pre>
<div class="block">Creates a new blocking-style stub that supports unary and streaming output calls on the service</div>
</li>
</ul>
<a name="newFutureStub-io.grpc.Channel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newFutureStub</h4>
<pre>public static&nbsp;<a href="../binlog/PumpGrpc.PumpFutureStub.html" title="class in binlog">PumpGrpc.PumpFutureStub</a>&nbsp;newFutureStub(io.grpc.Channel&nbsp;channel)</pre>
<div class="block">Creates a new ListenableFuture-style stub that supports unary calls on the service</div>
</li>
</ul>
<a name="bindService-binlog.PumpGrpc.AsyncService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindService</h4>
<pre>public static final&nbsp;io.grpc.ServerServiceDefinition&nbsp;bindService(<a href="../binlog/PumpGrpc.AsyncService.html" title="interface in binlog">PumpGrpc.AsyncService</a>&nbsp;service)</pre>
</li>
</ul>
<a name="getServiceDescriptor--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getServiceDescriptor</h4>
<pre>public static&nbsp;io.grpc.ServiceDescriptor&nbsp;getServiceDescriptor()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PumpGrpc.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">
<ul class="navList">
<li><a href="../binlog/CisternOuterClass.NotifyRespOrBuilder.html" title="interface in binlog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../binlog/PumpGrpc.AsyncService.html" title="interface in binlog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?binlog/PumpGrpc.html" target="_top">Frames</a></li>
<li><a href="PumpGrpc.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2024 PingCAP. All rights reserved.</small></p>
</body>
</html>