blob: f4812a557dc18a4f68e9b487cfe49c402291846f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>StoreBuilder (kafka 3.6.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.state, interface: StoreBuilder">
<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 evenRowColor = "even-row-color";
var oddRowColor = "odd-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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" 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>&nbsp;<a href="package-summary.html">org.apache.kafka.streams.state</a></div>
<h1 title="Interface StoreBuilder" class="title">Interface StoreBuilder&lt;T extends <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - the type of store to build</dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">StoreBuilder&lt;T extends <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>&gt;</span></div>
<div class="block">Build a <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor"><code>StateStore</code></a> wrapped with optional caching and logging.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-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">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<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-tab2 method-summary-table-tab3"><code><a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Build the store as defined by the builder.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#logConfig()" class="member-name-link">logConfig</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a Map containing any log configs that will be used when creating the changelog for the <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor"><code>StateStore</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#loggingEnabled()" class="member-name-link">loggingEnabled</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#name()" class="member-name-link">name</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Return the name of this state store builder.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withCachingDisabled()" class="member-name-link">withCachingDisabled</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Disable caching on the store.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withCachingEnabled()" class="member-name-link">withCachingEnabled</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Enable caching on the store.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withLoggingDisabled()" class="member-name-link">withLoggingDisabled</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Disable the changelog for store built by this <a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state"><code>StoreBuilder</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withLoggingEnabled(java.util.Map)" class="member-name-link">withLoggingEnabled</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;config)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Maintain a changelog for any changes made to the store.</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="withCachingEnabled()">
<h3>withCachingEnabled</h3>
<div class="member-signature"><span class="return-type"><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</span>&nbsp;<span class="element-name">withCachingEnabled</span>()</div>
<div class="block">Enable caching on the store.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>this</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="withCachingDisabled()">
<h3>withCachingDisabled</h3>
<div class="member-signature"><span class="return-type"><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</span>&nbsp;<span class="element-name">withCachingDisabled</span>()</div>
<div class="block">Disable caching on the store.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>this</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="withLoggingEnabled(java.util.Map)">
<h3>withLoggingEnabled</h3>
<div class="member-signature"><span class="return-type"><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</span>&nbsp;<span class="element-name">withLoggingEnabled</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;config)</span></div>
<div class="block">Maintain a changelog for any changes made to the store.
Use the provided config to set the config of the changelog topic.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - config applied to the changelog topic</dd>
<dt>Returns:</dt>
<dd>this</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="withLoggingDisabled()">
<h3>withLoggingDisabled</h3>
<div class="member-signature"><span class="return-type"><a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state">StoreBuilder</a>&lt;<a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a>&gt;</span>&nbsp;<span class="element-name">withLoggingDisabled</span>()</div>
<div class="block">Disable the changelog for store built by this <a href="StoreBuilder.html" title="interface in org.apache.kafka.streams.state"><code>StoreBuilder</code></a>.
This will turn off fault-tolerance for your store.
By default the changelog is enabled.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>this</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="build()">
<h3>build</h3>
<div class="member-signature"><span class="return-type"><a href="StoreBuilder.html" title="type parameter in StoreBuilder">T</a></span>&nbsp;<span class="element-name">build</span>()</div>
<div class="block">Build the store as defined by the builder.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the built <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor"><code>StateStore</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="logConfig()">
<h3>logConfig</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">logConfig</span>()</div>
<div class="block">Returns a Map containing any log configs that will be used when creating the changelog for the <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor"><code>StateStore</code></a>.
<p>
Note: any unrecognized configs will be ignored by the Kafka brokers.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Map containing any log configs to be used when creating the changelog for the <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor"><code>StateStore</code></a>
If <code>loggingEnabled</code> returns false, this function will always return an empty map</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="loggingEnabled()">
<h3>loggingEnabled</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">loggingEnabled</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor"><code>StateStore</code></a> should have logging enabled</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="name()">
<h3>name</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">name</span>()</div>
<div class="block">Return the name of this state store builder.
This must be a valid Kafka topic name; valid characters are ASCII alphanumerics, '.', '_' and '-'.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the name of this state store builder</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>