blob: a2d3295ad8011257126e01eb2001c2fc876246b4 [file] [log] [blame]
<!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_292) on Tue Jun 15 06:02:07 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder (Apache Hadoop Common 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<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="ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder (Apache Hadoop Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.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="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProto.Builder.html" title="class in org.apache.hadoop.ipc.protobuf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngineProtos.html" title="class in org.apache.hadoop.ipc.protobuf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html" target="_top">Frames</a></li>
<li><a href="ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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">org.apache.hadoop.ipc.protobuf</div>
<h2 title="Interface ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder" class="title">Interface ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.apache.hadoop.thirdparty.protobuf.MessageLiteOrBuilder, org.apache.hadoop.thirdparty.protobuf.MessageOrBuilder</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProto.html" title="class in org.apache.hadoop.ipc.protobuf">ProtobufRpcEngine2Protos.RequestHeaderProto</a>, <a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProto.Builder.html" title="class in org.apache.hadoop.ipc.protobuf">ProtobufRpcEngine2Protos.RequestHeaderProto.Builder</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.html" title="class in org.apache.hadoop.ipc.protobuf">ProtobufRpcEngine2Protos</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder</span>
extends org.apache.hadoop.thirdparty.protobuf.MessageOrBuilder</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#getClientProtocolVersion--">getClientProtocolVersion</a></span>()</code>
<div class="block">
protocol version of class declaring the called method</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><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="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#getDeclaringClassProtocolName--">getDeclaringClassProtocolName</a></span>()</code>
<div class="block">
RPCs for a particular interface (ie protocol) are done using a
IPC connection that is setup using rpcProxy.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.thirdparty.protobuf.ByteString</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#getDeclaringClassProtocolNameBytes--">getDeclaringClassProtocolNameBytes</a></span>()</code>
<div class="block">
RPCs for a particular interface (ie protocol) are done using a
IPC connection that is setup using rpcProxy.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><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="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#getMethodName--">getMethodName</a></span>()</code>
<div class="block">
Name of the RPC method</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.thirdparty.protobuf.ByteString</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#getMethodNameBytes--">getMethodNameBytes</a></span>()</code>
<div class="block">
Name of the RPC method</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#hasClientProtocolVersion--">hasClientProtocolVersion</a></span>()</code>
<div class="block">
protocol version of class declaring the called method</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#hasDeclaringClassProtocolName--">hasDeclaringClassProtocolName</a></span>()</code>
<div class="block">
RPCs for a particular interface (ie protocol) are done using a
IPC connection that is setup using rpcProxy.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html#hasMethodName--">hasMethodName</a></span>()</code>
<div class="block">
Name of the RPC method</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.thirdparty.protobuf.MessageOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.thirdparty.protobuf.MessageOrBuilder</h3>
<code>findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.thirdparty.protobuf.MessageLiteOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.thirdparty.protobuf.MessageLiteOrBuilder</h3>
<code>isInitialized</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="hasMethodName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMethodName</h4>
<pre>boolean&nbsp;hasMethodName()</pre>
<div class="block"><pre>
Name of the RPC method
</pre>
<code>required string methodName = 1;</code></div>
</li>
</ul>
<a name="getMethodName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethodName</h4>
<pre><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>&nbsp;getMethodName()</pre>
<div class="block"><pre>
Name of the RPC method
</pre>
<code>required string methodName = 1;</code></div>
</li>
</ul>
<a name="getMethodNameBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethodNameBytes</h4>
<pre>org.apache.hadoop.thirdparty.protobuf.ByteString&nbsp;getMethodNameBytes()</pre>
<div class="block"><pre>
Name of the RPC method
</pre>
<code>required string methodName = 1;</code></div>
</li>
</ul>
<a name="hasDeclaringClassProtocolName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasDeclaringClassProtocolName</h4>
<pre>boolean&nbsp;hasDeclaringClassProtocolName()</pre>
<div class="block"><pre>
RPCs for a particular interface (ie protocol) are done using a
IPC connection that is setup using rpcProxy.
The rpcProxy's has a declared protocol name that is
sent form client to server at connection time.
Each Rpc call also sends a protocol name
(called declaringClassprotocolName). This name is usually the same
as the connection protocol name except in some cases.
For example metaProtocols such ProtocolInfoProto which get metainfo
about the protocol reuse the connection but need to indicate that
the actual protocol is different (i.e. the protocol is
ProtocolInfoProto) since they reuse the connection; in this case
the declaringClassProtocolName field is set to the ProtocolInfoProto
</pre>
<code>required string declaringClassProtocolName = 2;</code></div>
</li>
</ul>
<a name="getDeclaringClassProtocolName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaringClassProtocolName</h4>
<pre><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>&nbsp;getDeclaringClassProtocolName()</pre>
<div class="block"><pre>
RPCs for a particular interface (ie protocol) are done using a
IPC connection that is setup using rpcProxy.
The rpcProxy's has a declared protocol name that is
sent form client to server at connection time.
Each Rpc call also sends a protocol name
(called declaringClassprotocolName). This name is usually the same
as the connection protocol name except in some cases.
For example metaProtocols such ProtocolInfoProto which get metainfo
about the protocol reuse the connection but need to indicate that
the actual protocol is different (i.e. the protocol is
ProtocolInfoProto) since they reuse the connection; in this case
the declaringClassProtocolName field is set to the ProtocolInfoProto
</pre>
<code>required string declaringClassProtocolName = 2;</code></div>
</li>
</ul>
<a name="getDeclaringClassProtocolNameBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaringClassProtocolNameBytes</h4>
<pre>org.apache.hadoop.thirdparty.protobuf.ByteString&nbsp;getDeclaringClassProtocolNameBytes()</pre>
<div class="block"><pre>
RPCs for a particular interface (ie protocol) are done using a
IPC connection that is setup using rpcProxy.
The rpcProxy's has a declared protocol name that is
sent form client to server at connection time.
Each Rpc call also sends a protocol name
(called declaringClassprotocolName). This name is usually the same
as the connection protocol name except in some cases.
For example metaProtocols such ProtocolInfoProto which get metainfo
about the protocol reuse the connection but need to indicate that
the actual protocol is different (i.e. the protocol is
ProtocolInfoProto) since they reuse the connection; in this case
the declaringClassProtocolName field is set to the ProtocolInfoProto
</pre>
<code>required string declaringClassProtocolName = 2;</code></div>
</li>
</ul>
<a name="hasClientProtocolVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasClientProtocolVersion</h4>
<pre>boolean&nbsp;hasClientProtocolVersion()</pre>
<div class="block"><pre>
protocol version of class declaring the called method
</pre>
<code>required uint64 clientProtocolVersion = 3;</code></div>
</li>
</ul>
<a name="getClientProtocolVersion--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getClientProtocolVersion</h4>
<pre>long&nbsp;getClientProtocolVersion()</pre>
<div class="block"><pre>
protocol version of class declaring the called method
</pre>
<code>required uint64 clientProtocolVersion = 3;</code></div>
</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/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.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="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProto.Builder.html" title="class in org.apache.hadoop.ipc.protobuf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/ipc/protobuf/ProtobufRpcEngineProtos.html" title="class in org.apache.hadoop.ipc.protobuf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/ipc/protobuf/ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.html" target="_top">Frames</a></li>
<li><a href="ProtobufRpcEngine2Protos.RequestHeaderProtoOrBuilder.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>