30/javadoc/org/apache/kafka/streams/TopologyDescription.Sink.html - kafka-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>TopologyDescription.Sink (kafka 3.0.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.kafka.streams, interface: TopologyDescription, interface: Sink">
 <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":6,"i1":6};
 var tabs = {65535:["t0","All 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:&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">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>&nbsp;<a href="package-summary.html">org.apache.kafka.streams</a></div>
 <h1 title="Interface TopologyDescription.Sink" class="title">Interface TopologyDescription.Sink</h1>
 </div>
 <section class="description">
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="TopologyDescription.Node.html" title="interface in org.apache.kafka.streams">TopologyDescription.Node</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Enclosing interface:</dt>
 <dd><a href="TopologyDescription.html" title="interface in org.apache.kafka.streams">TopologyDescription</a></dd>
 </dl>
 <hr>
 <pre>public static interface <span class="type-name-label">TopologyDescription.Sink</span>
 extends <a href="TopologyDescription.Node.html" title="interface in org.apache.kafka.streams">TopologyDescription.Node</a></pre>
 <div class="block">A sink node of a topology.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== 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="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><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></code></td>
 <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#topic()">topic</a></span>()</code></th>
 <td class="col-last">
 <div class="block">The topic name this sink node is writing to.</div>
 </td>
 </tr>
 <tr class="row-color" id="i1">
 <td class="col-first"><code><a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor">TopicNameExtractor</a></code></td>
 <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#topicNameExtractor()">topicNameExtractor</a></span>()</code></th>
 <td class="col-last">
 <div class="block">The <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a> class that this sink node uses to dynamically extract the topic name to write to.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods.inherited.from.class.org.apache.kafka.streams.TopologyDescription.Node">Methods inherited from interface&nbsp;org.apache.kafka.streams.<a href="TopologyDescription.Node.html" title="interface in org.apache.kafka.streams">TopologyDescription.Node</a></h3>
 <code><a href="TopologyDescription.Node.html#name()">name</a>, <a href="TopologyDescription.Node.html#predecessors()">predecessors</a>, <a href="TopologyDescription.Node.html#successors()">successors</a></code></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="topic()">
 <h3>topic</h3>
 <div class="member-signature"><span class="return-type"><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></span>&nbsp;<span class="member-name">topic</span>()</div>
 <div class="block">The topic name this sink node is writing to.
  Could be <code>null</code> if the topic name can only be dynamically determined based on <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>a topic name</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="topicNameExtractor()">
 <h3>topicNameExtractor</h3>
 <div class="member-signature"><span class="return-type"><a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor">TopicNameExtractor</a></span>&nbsp;<span class="member-name">topicNameExtractor</span>()</div>
 <div class="block">The <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a> class that this sink node uses to dynamically extract the topic name to write to.
  Could be <code>null</code> if the topic name is not dynamically determined.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a> class used get the topic name</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:&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>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <span class="skip-nav" id="skip.navbar.bottom">
 <!--   -->
 </span></nav>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>TopologyDescription.Sink (kafka 3.0.0 API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="description" content="declaration: package: org.apache.kafka.streams, interface: TopologyDescription, interface: Sink">
	<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":6,"i1":6};
	var tabs = {65535:["t0","All 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>Nested \| </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</a></div>
	<h1 title="Interface TopologyDescription.Sink" class="title">Interface TopologyDescription.Sink</h1>
	</div>
	<section class="description">
	<dl class="notes">
	<dt>All Superinterfaces:</dt>
	<dd><code><a href="TopologyDescription.Node.html" title="interface in org.apache.kafka.streams">TopologyDescription.Node</a></code></dd>
	</dl>
	<dl class="notes">
	<dt>Enclosing interface:</dt>
	<dd><a href="TopologyDescription.html" title="interface in org.apache.kafka.streams">TopologyDescription</a></dd>
	</dl>
	<hr>
	<pre>public static interface <span class="type-name-label">TopologyDescription.Sink</span>
	extends <a href="TopologyDescription.Node.html" title="interface in org.apache.kafka.streams">TopologyDescription.Node</a></pre>
	<div class="block">A sink node of a topology.</div>
	</section>
	<section class="summary">
	<ul class="summary-list">
	<!-- ========== 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="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><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></code></td>
	<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#topic()">topic</a></span>()</code></th>
	<td class="col-last">
	<div class="block">The topic name this sink node is writing to.</div>
	</td>
	</tr>
	<tr class="row-color" id="i1">
	<td class="col-first"><code><a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor">TopicNameExtractor</a></code></td>
	<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#topicNameExtractor()">topicNameExtractor</a></span>()</code></th>
	<td class="col-last">
	<div class="block">The <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a> class that this sink node uses to dynamically extract the topic name to write to.</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	</div>
	<div class="inherited-list">
	<h3 id="methods.inherited.from.class.org.apache.kafka.streams.TopologyDescription.Node">Methods inherited from interface org.apache.kafka.streams.<a href="TopologyDescription.Node.html" title="interface in org.apache.kafka.streams">TopologyDescription.Node</a></h3>
	<code><a href="TopologyDescription.Node.html#name()">name</a>, <a href="TopologyDescription.Node.html#predecessors()">predecessors</a>, <a href="TopologyDescription.Node.html#successors()">successors</a></code></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="topic()">
	<h3>topic</h3>
	<div class="member-signature"><span class="return-type"><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></span> <span class="member-name">topic</span>()</div>
	<div class="block">The topic name this sink node is writing to.
	Could be <code>null</code> if the topic name can only be dynamically determined based on <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a></div>
	<dl class="notes">
	<dt>Returns:</dt>
	<dd>a topic name</dd>
	</dl>
	</section>
	</li>
	<li>
	<section class="detail" id="topicNameExtractor()">
	<h3>topicNameExtractor</h3>
	<div class="member-signature"><span class="return-type"><a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor">TopicNameExtractor</a></span> <span class="member-name">topicNameExtractor</span>()</div>
	<div class="block">The <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a> class that this sink node uses to dynamically extract the topic name to write to.
	Could be <code>null</code> if the topic name is not dynamically determined.</div>
	<dl class="notes">
	<dt>Returns:</dt>
	<dd>the <a href="processor/TopicNameExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TopicNameExtractor</code></a> class used get the topic name</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>Nested \| </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>