| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>TopologyAPI.InputStreamOrBuilder (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.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.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TopologyAPI.InputStreamOrBuilder (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}; |
| 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.api.generated</a></div> |
| <h2 title="Interface TopologyAPI.InputStreamOrBuilder" class="title">Interface TopologyAPI.InputStreamOrBuilder</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="TopologyAPI.InputStream.html" title="class in org.apache.heron.api.generated">TopologyAPI.InputStream</a></code>, <code><a href="TopologyAPI.InputStream.Builder.html" title="class in org.apache.heron.api.generated">TopologyAPI.InputStream.Builder</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="TopologyAPI.html" title="class in org.apache.heron.api.generated">TopologyAPI</a></dd> |
| </dl> |
| <hr> |
| <pre>public static interface <span class="typeNameLabel">TopologyAPI.InputStreamOrBuilder</span> |
| extends com.google.protobuf.MessageOrBuilder</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <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>com.google.protobuf.ByteString</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomGroupingObject()">getCustomGroupingObject</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| we should refactor when upgrading to protobuf v3.0 (#1181)</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="TopologyAPI.StreamSchema.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamSchema</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupingFields()">getGroupingFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>optional .heron.proto.api.StreamSchema grouping_fields = 3;</code></div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="TopologyAPI.StreamSchemaOrBuilder.html" title="interface in org.apache.heron.api.generated">TopologyAPI.StreamSchemaOrBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupingFieldsOrBuilder()">getGroupingFieldsOrBuilder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>optional .heron.proto.api.StreamSchema grouping_fields = 3;</code></div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGtype()">getGtype</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required .heron.proto.api.Grouping gtype = 2;</code></div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStream()">getStream</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required .heron.proto.api.StreamId stream = 1;</code></div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="TopologyAPI.StreamIdOrBuilder.html" title="interface in org.apache.heron.api.generated">TopologyAPI.StreamIdOrBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStreamOrBuilder()">getStreamOrBuilder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required .heron.proto.api.StreamId stream = 1;</code></div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="TopologyAPI.CustomGroupingObjectType.html" title="enum in org.apache.heron.api.generated">TopologyAPI.CustomGroupingObjectType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>optional .heron.proto.api.CustomGroupingObjectType type = 5;</code></div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCustomGroupingObject()">hasCustomGroupingObject</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"> |
| we should refactor when upgrading to protobuf v3.0 (#1181)</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="#hasGroupingFields()">hasGroupingFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>optional .heron.proto.api.StreamSchema grouping_fields = 3;</code></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="#hasGtype()">hasGtype</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required .heron.proto.api.Grouping gtype = 2;</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="#hasStream()">hasStream</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>required .heron.proto.api.StreamId stream = 1;</code></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="#hasType()">hasType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>optional .heron.proto.api.CustomGroupingObjectType type = 5;</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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="hasStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasStream</h4> |
| <pre class="methodSignature">boolean hasStream()</pre> |
| <div class="block"><code>required .heron.proto.api.StreamId stream = 1;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the stream field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStream</h4> |
| <pre class="methodSignature"><a href="TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a> getStream()</pre> |
| <div class="block"><code>required .heron.proto.api.StreamId stream = 1;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStreamOrBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamOrBuilder</h4> |
| <pre class="methodSignature"><a href="TopologyAPI.StreamIdOrBuilder.html" title="interface in org.apache.heron.api.generated">TopologyAPI.StreamIdOrBuilder</a> getStreamOrBuilder()</pre> |
| <div class="block"><code>required .heron.proto.api.StreamId stream = 1;</code></div> |
| </li> |
| </ul> |
| <a id="hasGtype()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasGtype</h4> |
| <pre class="methodSignature">boolean hasGtype()</pre> |
| <div class="block"><code>required .heron.proto.api.Grouping gtype = 2;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the gtype field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getGtype()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGtype</h4> |
| <pre class="methodSignature"><a href="TopologyAPI.Grouping.html" title="enum in org.apache.heron.api.generated">TopologyAPI.Grouping</a> getGtype()</pre> |
| <div class="block"><code>required .heron.proto.api.Grouping gtype = 2;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The gtype.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasGroupingFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasGroupingFields</h4> |
| <pre class="methodSignature">boolean hasGroupingFields()</pre> |
| <div class="block"><code>optional .heron.proto.api.StreamSchema grouping_fields = 3;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the groupingFields field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getGroupingFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupingFields</h4> |
| <pre class="methodSignature"><a href="TopologyAPI.StreamSchema.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamSchema</a> getGroupingFields()</pre> |
| <div class="block"><code>optional .heron.proto.api.StreamSchema grouping_fields = 3;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The groupingFields.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getGroupingFieldsOrBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGroupingFieldsOrBuilder</h4> |
| <pre class="methodSignature"><a href="TopologyAPI.StreamSchemaOrBuilder.html" title="interface in org.apache.heron.api.generated">TopologyAPI.StreamSchemaOrBuilder</a> getGroupingFieldsOrBuilder()</pre> |
| <div class="block"><code>optional .heron.proto.api.StreamSchema grouping_fields = 3;</code></div> |
| </li> |
| </ul> |
| <a id="hasCustomGroupingObject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasCustomGroupingObject</h4> |
| <pre class="methodSignature">boolean hasCustomGroupingObject()</pre> |
| <div class="block"><pre> |
| we should refactor when upgrading to protobuf v3.0 (#1181) |
| </pre> |
| |
| <code>optional bytes custom_grouping_object = 4;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the customGroupingObject field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCustomGroupingObject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCustomGroupingObject</h4> |
| <pre class="methodSignature">com.google.protobuf.ByteString getCustomGroupingObject()</pre> |
| <div class="block"><pre> |
| we should refactor when upgrading to protobuf v3.0 (#1181) |
| </pre> |
| |
| <code>optional bytes custom_grouping_object = 4;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The customGroupingObject.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasType</h4> |
| <pre class="methodSignature">boolean hasType()</pre> |
| <div class="block"><code>optional .heron.proto.api.CustomGroupingObjectType type = 5;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the type field is set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre class="methodSignature"><a href="TopologyAPI.CustomGroupingObjectType.html" title="enum in org.apache.heron.api.generated">TopologyAPI.CustomGroupingObjectType</a> getType()</pre> |
| <div class="block"><code>optional .heron.proto.api.CustomGroupingObjectType type = 5;</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The type.</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> |
