| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Suppressed (kafka 3.0.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.streams.kstream, interface: Suppressed"> |
| <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.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="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var data = {"i0":1,"i1":1,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "alt-color"; |
| var rowColor = "row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><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> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.streams.kstream</a></div> |
| <h1 title="Interface Suppressed" class="title">Interface Suppressed<K></h1> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public interface <span class="type-name-label">Suppressed<K></span></pre> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested.class.summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="member-summary"> |
| <table class="summary-table"> |
| <caption><span>Nested Classes</span></caption> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Interface</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color"> |
| <td class="col-first"><code>static interface </code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="Suppressed.BufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.BufferConfig</a><<a href="Suppressed.BufferConfig.html" title="type parameter in Suppressed.BufferConfig">BC</a> extends <a href="Suppressed.BufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.BufferConfig</a><<a href="Suppressed.BufferConfig.html" title="type parameter in Suppressed.BufferConfig">BC</a>>></span></code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="row-color"> |
| <td class="col-first"><code>static interface </code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="Suppressed.EagerBufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.EagerBufferConfig</a></span></code></th> |
| <td class="col-last"> |
| <div class="block">Marker interface for a buffer configuration that will strictly enforce size constraints |
| (bytes and/or number of records) on the buffer, so it is suitable for reducing duplicate |
| results downstream, but does not promise to eliminate them entirely.</div> |
| </td> |
| </tr> |
| <tr class="alt-color"> |
| <td class="col-first"><code>static interface </code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="Suppressed.StrictBufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.StrictBufferConfig</a></span></code></th> |
| <td class="col-last"> |
| <div class="block">Marker interface for a buffer configuration that is "strict" in the sense that it will strictly |
| enforce the time bound and never emit early.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div class="member-summary" id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="table-tab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="table-tab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <table class="summary-table" aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Method</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color" id="i0"> |
| <td class="col-first"><code>static <K> <a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><K></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#untilTimeLimit(java.time.Duration,org.apache.kafka.streams.kstream.Suppressed.BufferConfig)">untilTimeLimit</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> timeToWaitForMoreEvents, |
| <a href="Suppressed.BufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.BufferConfig</a> bufferConfig)</code></th> |
| <td class="col-last"> |
| <div class="block">Configure the suppression to wait <code>timeToWaitForMoreEvents</code> amount of time after receiving a record |
| before emitting it further downstream.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code>static <a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><<a href="Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#untilWindowCloses(org.apache.kafka.streams.kstream.Suppressed.StrictBufferConfig)">untilWindowCloses</a></span>​(<a href="Suppressed.StrictBufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.StrictBufferConfig</a> bufferConfig)</code></th> |
| <td class="col-last"> |
| <div class="block">Configure the suppression to emit only the "final results" from the window.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code><a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><<a href="Suppressed.html" title="type parameter in Suppressed">K</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#withName(java.lang.String)">withName</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></th> |
| <td class="col-last"> |
| <div class="block">Use the specified name for the suppression node in the topology.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="untilWindowCloses(org.apache.kafka.streams.kstream.Suppressed.StrictBufferConfig)"> |
| <h3>untilWindowCloses</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><<a href="Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a>></span> <span class="member-name">untilWindowCloses</span>​(<span class="parameters"><a href="Suppressed.StrictBufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.StrictBufferConfig</a> bufferConfig)</span></div> |
| <div class="block">Configure the suppression to emit only the "final results" from the window. |
| |
| By default all Streams operators emit results whenever new results are available. |
| This includes windowed operations. |
| |
| This configuration will instead emit just one result per key for each window, guaranteeing |
| to deliver only the final result. This option is suitable for use cases in which the business logic |
| requires a hard guarantee that only the final result is propagated. For example, sending alerts. |
| |
| To accomplish this, the operator will buffer events from the window until the window close (that is, |
| until the end-time passes, and additionally until the grace period expires). Since windowed operators |
| are required to reject out-of-order events for a window whose grace period is expired, there is an additional |
| guarantee that the final results emitted from this suppression will match any queryable state upstream.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bufferConfig</code> - A configuration specifying how much space to use for buffering intermediate results. |
| This is required to be a "strict" config, since it would violate the "final results" |
| property to emit early and then issue an update later.</dd> |
| <dt>Returns:</dt> |
| <dd>a "final results" mode suppression configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="untilTimeLimit(java.time.Duration,org.apache.kafka.streams.kstream.Suppressed.BufferConfig)"> |
| <h3>untilTimeLimit</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="type-parameters"><K></span> <span class="return-type"><a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><K></span> <span class="member-name">untilTimeLimit</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> timeToWaitForMoreEvents, |
| <a href="Suppressed.BufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.BufferConfig</a> bufferConfig)</span></div> |
| <div class="block">Configure the suppression to wait <code>timeToWaitForMoreEvents</code> amount of time after receiving a record |
| before emitting it further downstream. If another record for the same key arrives in the mean time, it replaces |
| the first record in the buffer but does <em>not</em> re-start the timer.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - The key type for the KTable to apply this suppression to.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>timeToWaitForMoreEvents</code> - The amount of time to wait, per record, for new events.</dd> |
| <dd><code>bufferConfig</code> - A configuration specifying how much space to use for buffering intermediate results.</dd> |
| <dt>Returns:</dt> |
| <dd>a suppression configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withName(java.lang.String)"> |
| <h3>withName</h3> |
| <div class="member-signature"><span class="return-type"><a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><<a href="Suppressed.html" title="type parameter in Suppressed">K</a>></span> <span class="member-name">withName</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Use the specified name for the suppression node in the topology. |
| <p> |
| This can be used to insert a suppression without changing the rest of the topology names |
| (and therefore not requiring an application reset). |
| <p> |
| Note however, that once a suppression has buffered some records, removing it from the topology would cause |
| the loss of those records. |
| <p> |
| A suppression can be "disabled" with the configuration <code>untilTimeLimit(Duration.ZERO, ...</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name to be used for the suppression node and changelog topic</dd> |
| <dt>Returns:</dt> |
| <dd>The same configuration with the addition of the given <code>name</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottom-nav" id="navbar.bottom"> |
| <div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <span class="skip-nav" id="skip.navbar.bottom"> |
| <!-- --> |
| </span></nav> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
