| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>Suppressed (kafka 4.0.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <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"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.7.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <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"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </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="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Suppressed<K></span></div> |
| </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="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="Suppressed.BufferConfig.html" class="type-name-link" 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>>></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="Suppressed.EagerBufferConfig.html" class="type-name-link" title="interface in org.apache.kafka.streams.kstream">Suppressed.EagerBufferConfig</a></code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="Suppressed.StrictBufferConfig.html" class="type-name-link" title="interface in org.apache.kafka.streams.kstream">Suppressed.StrictBufferConfig</a></code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <K> <a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><wbr><K></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#untilTimeLimit(java.time.Duration,org.apache.kafka.streams.kstream.Suppressed.BufferConfig)" class="member-name-link">untilTimeLimit</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/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></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Configure the suppression to wait <code>timeToWaitForMoreEvents</code> amount of time after receiving a record |
| before emitting it further downstream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><wbr><<a href="Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><?>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#untilWindowCloses(org.apache.kafka.streams.kstream.Suppressed.StrictBufferConfig)" class="member-name-link">untilWindowCloses</a><wbr>(<a href="Suppressed.StrictBufferConfig.html" title="interface in org.apache.kafka.streams.kstream">Suppressed.StrictBufferConfig</a> bufferConfig)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Configure the suppression to emit only the "final results" from the window.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Suppressed.html" title="interface in org.apache.kafka.streams.kstream">Suppressed</a><wbr><<a href="Suppressed.html" title="type parameter in Suppressed">K</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withName(java.lang.String)" class="member-name-link">withName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Use the specified name for the suppression node in the topology.</div> |
| </div> |
| </div> |
| </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="element-name">untilWindowCloses</span><wbr><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. |
| |
| <p>By default, all Streams operators emit results whenever new results are available. |
| This includes windowed operations. |
| |
| <p>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. |
| |
| <p>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="element-name">untilTimeLimit</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/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 meantime, 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="element-name">withName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/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> |
| </div> |
| </div> |
| </body> |
| </html> |
