| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.16) on Sun Oct 23 14:10:58 GMT 2022 --> |
| <title>Metrics.MetricPublisherOrBuilder (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-10-23"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Metrics.MetricPublisherOrBuilder (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":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"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| 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="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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </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> <a href="package-summary.html">org.apache.heron.proto.system</a></div> |
| <h2 title="Interface Metrics.MetricPublisherOrBuilder" class="title">Interface Metrics.MetricPublisherOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>com.google.protobuf.MessageLiteOrBuilder</code>, <code>com.google.protobuf.MessageOrBuilder</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="Metrics.MetricPublisher.html" title="class in org.apache.heron.proto.system">Metrics.MetricPublisher</a></code>, <code><a href="Metrics.MetricPublisher.Builder.html" title="class in org.apache.heron.proto.system">Metrics.MetricPublisher.Builder</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="Metrics.html" title="class in org.apache.heron.proto.system">Metrics</a></dd> |
| </dl> |
| <hr> |
| <pre>public static interface <span class="typeNameLabel">Metrics.MetricPublisherOrBuilder</span> |
| extends com.google.protobuf.MessageOrBuilder</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <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> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentName()">getComponentName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| like Tail-FlatMap or __stmgr__</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>com.google.protobuf.ByteString</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentNameBytes()">getComponentNameBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| like Tail-FlatMap or __stmgr__</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHostname()">getHostname</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required string hostname = 1;</code></div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>com.google.protobuf.ByteString</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHostnameBytes()">getHostnameBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required string hostname = 1;</code></div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstanceId()">getInstanceId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| In case of regular instances, it is their instance_id |
| For stmgr, it is the stmgr id</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>com.google.protobuf.ByteString</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstanceIdBytes()">getInstanceIdBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| In case of regular instances, it is their instance_id |
| For stmgr, it is the stmgr id</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstanceIndex()">getInstanceIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| The index of the instance with respect |
| to that component_name</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPort()">getPort</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required int32 port = 2;</code></div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasComponentName()">hasComponentName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| like Tail-FlatMap or __stmgr__</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasHostname()">hasHostname</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required string hostname = 1;</code></div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasInstanceId()">hasInstanceId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| In case of regular instances, it is their instance_id |
| For stmgr, it is the stmgr id</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasInstanceIndex()">hasInstanceIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| The index of the instance with respect |
| to that component_name</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPort()">hasPort</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required int32 port = 2;</code></div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder</h3> |
| <code>isInitialized</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.MessageOrBuilder</h3> |
| <code>findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="hasHostname()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasHostname</h4> |
| <pre class="methodSignature">boolean hasHostname()</pre> |
| <div class="block"><code>required string hostname = 1;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the hostname field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHostname()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostname</h4> |
| <pre class="methodSignature">java.lang.String getHostname()</pre> |
| <div class="block"><code>required string hostname = 1;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The hostname.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHostnameBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostnameBytes</h4> |
| <pre class="methodSignature">com.google.protobuf.ByteString getHostnameBytes()</pre> |
| <div class="block"><code>required string hostname = 1;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The bytes for hostname.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasPort()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPort</h4> |
| <pre class="methodSignature">boolean hasPort()</pre> |
| <div class="block"><code>required int32 port = 2;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the port field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPort()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre class="methodSignature">int getPort()</pre> |
| <div class="block"><code>required int32 port = 2;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The port.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasComponentName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasComponentName</h4> |
| <pre class="methodSignature">boolean hasComponentName()</pre> |
| <div class="block"><pre> |
| like Tail-FlatMap or __stmgr__ |
| </pre> |
| |
| <code>required string component_name = 3;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the componentName field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentName</h4> |
| <pre class="methodSignature">java.lang.String getComponentName()</pre> |
| <div class="block"><pre> |
| like Tail-FlatMap or __stmgr__ |
| </pre> |
| |
| <code>required string component_name = 3;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The componentName.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentNameBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentNameBytes</h4> |
| <pre class="methodSignature">com.google.protobuf.ByteString getComponentNameBytes()</pre> |
| <div class="block"><pre> |
| like Tail-FlatMap or __stmgr__ |
| </pre> |
| |
| <code>required string component_name = 3;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The bytes for componentName.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasInstanceId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasInstanceId</h4> |
| <pre class="methodSignature">boolean hasInstanceId()</pre> |
| <div class="block"><pre> |
| In case of regular instances, it is their instance_id |
| For stmgr, it is the stmgr id |
| </pre> |
| |
| <code>required string instance_id = 4;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the instanceId field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInstanceId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstanceId</h4> |
| <pre class="methodSignature">java.lang.String getInstanceId()</pre> |
| <div class="block"><pre> |
| In case of regular instances, it is their instance_id |
| For stmgr, it is the stmgr id |
| </pre> |
| |
| <code>required string instance_id = 4;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The instanceId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInstanceIdBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstanceIdBytes</h4> |
| <pre class="methodSignature">com.google.protobuf.ByteString getInstanceIdBytes()</pre> |
| <div class="block"><pre> |
| In case of regular instances, it is their instance_id |
| For stmgr, it is the stmgr id |
| </pre> |
| |
| <code>required string instance_id = 4;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The bytes for instanceId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasInstanceIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasInstanceIndex</h4> |
| <pre class="methodSignature">boolean hasInstanceIndex()</pre> |
| <div class="block"><pre> |
| The index of the instance with respect |
| to that component_name |
| </pre> |
| |
| <code>required int32 instance_index = 5;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the instanceIndex field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInstanceIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInstanceIndex</h4> |
| <pre class="methodSignature">int getInstanceIndex()</pre> |
| <div class="block"><pre> |
| The index of the instance with respect |
| to that component_name |
| </pre> |
| |
| <code>required int32 instance_index = 5;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The instanceIndex.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </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="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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |