| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Joined (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, class: Joined"> |
| <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":9,"i1":10,"i2":9,"i3":10,"i4":9,"i5":10,"i6":9,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class Joined" class="title">Class Joined<K,​V,​VO></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.kafka.streams.kstream.Joined<K,​V,​VO></div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public class <span class="type-name-label">Joined<K,​V,​VO></span> |
| extends <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></pre> |
| <div class="block">The <code>Joined</code> class represents optional params that can be passed to |
| <a href="KStream.html#join(org.apache.kafka.streams.kstream.KTable,org.apache.kafka.streams.kstream.ValueJoiner,org.apache.kafka.streams.kstream.Joined)"><code>KStream#join(KTable,...)</code></a> and |
| <a href="KStream.html#leftJoin(org.apache.kafka.streams.kstream.KTable,org.apache.kafka.streams.kstream.ValueJoiner)"><code>KStream#leftJoin(KTable,...)</code></a> operations.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field.summary"> |
| <h2>Field Summary</h2> |
| <div class="member-summary"> |
| <table class="summary-table"> |
| <caption><span>Fields</span></caption> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Field</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color"> |
| <td class="col-first"><code>protected <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">K</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#keySerde">keySerde</a></span></code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="row-color"> |
| <td class="col-first"><code>protected <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="#name">name</a></span></code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="alt-color"> |
| <td class="col-first"><code>protected <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">VO</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#otherValueSerde">otherValueSerde</a></span></code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="row-color"> |
| <td class="col-first"><code>protected <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">V</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#valueSerde">valueSerde</a></span></code></th> |
| <td class="col-last"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor.summary"> |
| <h2>Constructor Summary</h2> |
| <div class="member-summary"> |
| <table class="summary-table"> |
| <caption><span>Constructors</span></caption> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier</th> |
| <th class="col-second" scope="col">Constructor</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color"> |
| <td class="col-first"><code>protected </code></td> |
| <th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E(org.apache.kafka.streams.kstream.Joined)">Joined</a></span>​(<a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>> joined)</code></th> |
| <td class="col-last"> </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="t4" class="table-tab" onclick="show(8);">Concrete 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,​ |
| V,​ |
| VO> <a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#as(java.lang.String)">as</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">Create an instance of <code>Joined</code> with base name for all components of the join, this may |
| include any repartition topics created to complete the join.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">K</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#keySerde()">keySerde</a></span>()</code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code>static <K,​ |
| V,​ |
| VO> <a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#keySerde(org.apache.kafka.common.serialization.Serde)">keySerde</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><K> keySerde)</code></th> |
| <td class="col-last"> |
| <div class="block">Create an instance of <code>Joined</code> with a key <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i3"> |
| <td class="col-first"><code><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">VO</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#otherValueSerde()">otherValueSerde</a></span>()</code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="alt-color" id="i4"> |
| <td class="col-first"><code>static <K,​ |
| V,​ |
| VO> <a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#otherValueSerde(org.apache.kafka.common.serialization.Serde)">otherValueSerde</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><VO> otherValueSerde)</code></th> |
| <td class="col-last"> |
| <div class="block">Create an instance of <code>Joined</code> with an other value <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i5"> |
| <td class="col-first"><code><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">V</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#valueSerde()">valueSerde</a></span>()</code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="alt-color" id="i6"> |
| <td class="col-first"><code>static <K,​ |
| V,​ |
| VO> <a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#valueSerde(org.apache.kafka.common.serialization.Serde)">valueSerde</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><V> valueSerde)</code></th> |
| <td class="col-last"> |
| <div class="block">Create an instance of <code>Joined</code> with a value <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i7"> |
| <td class="col-first"><code>static <K,​ |
| V,​ |
| VO> <a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#with(org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde)">with</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><K> keySerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><V> valueSerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><VO> otherValueSerde)</code></th> |
| <td class="col-last"> |
| <div class="block">Create an instance of <code>Joined</code> with key, value, and otherValue <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i8"> |
| <td class="col-first"><code>static <K,​ |
| V,​ |
| VO> <a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#with(org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde,java.lang.String)">with</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><K> keySerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><V> valueSerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><VO> otherValueSerde, |
| <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">Create an instance of <code>Joined</code> with key, value, and otherValue <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i9"> |
| <td class="col-first"><code><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#withKeySerde(org.apache.kafka.common.serialization.Serde)">withKeySerde</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">K</a>> keySerde)</code></th> |
| <td class="col-last"> |
| <div class="block">Set the key <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> to be used.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i10"> |
| <td class="col-first"><code><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</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">Set the base name used for all components of the join, this may include any repartition topics |
| created to complete the join.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i11"> |
| <td class="col-first"><code><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#withOtherValueSerde(org.apache.kafka.common.serialization.Serde)">withOtherValueSerde</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">VO</a>> otherValueSerde)</code></th> |
| <td class="col-last"> |
| <div class="block">Set the otherValue <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> to be used.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i12"> |
| <td class="col-first"><code><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#withValueSerde(org.apache.kafka.common.serialization.Serde)">withValueSerde</a></span>​(<a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">V</a>> valueSerde)</code></th> |
| <td class="col-last"> |
| <div class="block">Set the value <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> to be used.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field.detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="keySerde"> |
| <h3>keySerde</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">K</a>></span> <span class="member-name">keySerde</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueSerde"> |
| <h3>valueSerde</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">V</a>></span> <span class="member-name">valueSerde</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="otherValueSerde"> |
| <h3>otherValueSerde</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">VO</a>></span> <span class="member-name">otherValueSerde</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="name"> |
| <h3>name</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <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">name</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor.detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.kafka.streams.kstream.Joined)"> |
| <h3>Joined</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="member-name">Joined</span>​(<span class="parameters"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>> joined)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="with(org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde)"> |
| <h3>with</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,​ |
| V,​ |
| VO></span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></span> <span class="member-name">with</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><K> keySerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><V> valueSerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><VO> otherValueSerde)</span></div> |
| <div class="block">Create an instance of <code>Joined</code> with key, value, and otherValue <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> instances. |
| <code>null</code> values are accepted and will be replaced by the default serdes as defined in config.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - key type</dd> |
| <dd><code>V</code> - value type</dd> |
| <dd><code>VO</code> - other value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>keySerde</code> - the key serde to use. If <code>null</code> the default key serde from config will be used</dd> |
| <dd><code>valueSerde</code> - the value serde to use. If <code>null</code> the default value serde from config will be used</dd> |
| <dd><code>otherValueSerde</code> - the otherValue serde to use. If <code>null</code> the default value serde from config will be used</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance with the provided serdes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="with(org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde,org.apache.kafka.common.serialization.Serde,java.lang.String)"> |
| <h3>with</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,​ |
| V,​ |
| VO></span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></span> <span class="member-name">with</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><K> keySerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><V> valueSerde, |
| <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><VO> otherValueSerde, |
| <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">Create an instance of <code>Joined</code> with key, value, and otherValue <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> instances. |
| <code>null</code> values are accepted and will be replaced by the default serdes as defined in |
| config.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - key type</dd> |
| <dd><code>V</code> - value type</dd> |
| <dd><code>VO</code> - other value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>keySerde</code> - the key serde to use. If <code>null</code> the default key serde from config will be |
| used</dd> |
| <dd><code>valueSerde</code> - the value serde to use. If <code>null</code> the default value serde from config |
| will be used</dd> |
| <dd><code>otherValueSerde</code> - the otherValue serde to use. If <code>null</code> the default value serde |
| from config will be used</dd> |
| <dd><code>name</code> - the name used as the base for naming components of the join including any |
| repartition topics</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance with the provided serdes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keySerde(org.apache.kafka.common.serialization.Serde)"> |
| <h3>keySerde</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,​ |
| V,​ |
| VO></span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></span> <span class="member-name">keySerde</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><K> keySerde)</span></div> |
| <div class="block">Create an instance of <code>Joined</code> with a key <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a>. |
| <code>null</code> values are accepted and will be replaced by the default key serde as defined in config.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - key type</dd> |
| <dd><code>V</code> - value type</dd> |
| <dd><code>VO</code> - other value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>keySerde</code> - the key serde to use. If <code>null</code> the default key serde from config will be used</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the keySerde</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueSerde(org.apache.kafka.common.serialization.Serde)"> |
| <h3>valueSerde</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,​ |
| V,​ |
| VO></span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></span> <span class="member-name">valueSerde</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><V> valueSerde)</span></div> |
| <div class="block">Create an instance of <code>Joined</code> with a value <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a>. |
| <code>null</code> values are accepted and will be replaced by the default value serde as defined in config.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - key type</dd> |
| <dd><code>V</code> - value type</dd> |
| <dd><code>VO</code> - other value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>valueSerde</code> - the value serde to use. If <code>null</code> the default value serde from config will be used</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the valueSerde</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="otherValueSerde(org.apache.kafka.common.serialization.Serde)"> |
| <h3>otherValueSerde</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,​ |
| V,​ |
| VO></span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></span> <span class="member-name">otherValueSerde</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><VO> otherValueSerde)</span></div> |
| <div class="block">Create an instance of <code>Joined</code> with an other value <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a>. |
| <code>null</code> values are accepted and will be replaced by the default value serde as defined in config.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - key type</dd> |
| <dd><code>V</code> - value type</dd> |
| <dd><code>VO</code> - other value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>otherValueSerde</code> - the otherValue serde to use. If <code>null</code> the default value serde from config will be used</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the otherValueSerde</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="as(java.lang.String)"> |
| <h3>as</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,​ |
| V,​ |
| VO></span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><K,​V,​VO></span> <span class="member-name">as</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">Create an instance of <code>Joined</code> with base name for all components of the join, this may |
| include any repartition topics created to complete the join.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - key type</dd> |
| <dd><code>V</code> - value type</dd> |
| <dd><code>VO</code> - other value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name used as the base for naming components of the join including any |
| repartition topics</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withKeySerde(org.apache.kafka.common.serialization.Serde)"> |
| <h3>withKeySerde</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>></span> <span class="member-name">withKeySerde</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">K</a>> keySerde)</span></div> |
| <div class="block">Set the key <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> to be used. Null values are accepted and will be replaced by the default |
| key serde as defined in config</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>keySerde</code> - the key serde to use. If null the default key serde from config will be used</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the <code>name</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withValueSerde(org.apache.kafka.common.serialization.Serde)"> |
| <h3>withValueSerde</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>></span> <span class="member-name">withValueSerde</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">V</a>> valueSerde)</span></div> |
| <div class="block">Set the value <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> to be used. Null values are accepted and will be replaced by the default |
| value serde as defined in config</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>valueSerde</code> - the value serde to use. If null the default value serde from config will be used</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the <code>valueSerde</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withOtherValueSerde(org.apache.kafka.common.serialization.Serde)"> |
| <h3>withOtherValueSerde</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</a>></span> <span class="member-name">withOtherValueSerde</span>​(<span class="parameters"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">VO</a>> otherValueSerde)</span></div> |
| <div class="block">Set the otherValue <a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization"><code>Serde</code></a> to be used. Null values are accepted and will be replaced by the default |
| value serde as defined in config</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>otherValueSerde</code> - the otherValue serde to use. If null the default value serde from config will be used</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the <code>valueSerde</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withName(java.lang.String)"> |
| <h3>withName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Joined.html" title="class in org.apache.kafka.streams.kstream">Joined</a><<a href="Joined.html" title="type parameter in Joined">K</a>,​<a href="Joined.html" title="type parameter in Joined">V</a>,​<a href="Joined.html" title="type parameter in Joined">VO</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">Set the base name used for all components of the join, this may include any repartition topics |
| created to complete the join.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name used as the base for naming components of the join including any |
| repartition topics</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>Joined</code> instance configured with the <code>name</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keySerde()"> |
| <h3>keySerde</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">K</a>></span> <span class="member-name">keySerde</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueSerde()"> |
| <h3>valueSerde</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">V</a>></span> <span class="member-name">valueSerde</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="otherValueSerde()"> |
| <h3>otherValueSerde</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a><<a href="Joined.html" title="type parameter in Joined">VO</a>></span> <span class="member-name">otherValueSerde</span>()</div> |
| </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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
