Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/BaseTableFunction.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/BaseTableFunction.html?rev=1860788&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/BaseTableFunction.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/BaseTableFunction.html Fri Jun 7 20:22:19 2019 @@ -0,0 +1,349 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_121) on Thu Jun 06 15:02:02 PDT 2019 --> +<title>BaseTableFunction (samza-api 1.2.0 API)</title> +<meta name="date" content="2019-06-06"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BaseTableFunction (samza-api 1.2.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/table/remote/BaseTableFunction.html" target="_top">Frames</a></li> +<li><a href="BaseTableFunction.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<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="subNavList"> +<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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.table.remote</div> +<h2 title="Class BaseTableFunction" class="title">Class BaseTableFunction</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.table.remote.BaseTableFunction</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, <a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a>, <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">BaseTableFunction</span> +extends java.lang.Object +implements <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a></pre> +<div class="block">Base class for all table read and write functions.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.samza.table.remote.BaseTableFunction">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/BaseTableFunction.html#table">table</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/BaseTableFunction.html#BaseTableFunction--">BaseTableFunction</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/BaseTableFunction.html#init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-">init</a></span>(<a href="../../../../../org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a> context, + <a href="../../../../../org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a> table)</code> +<div class="block">Initializes the function before any operation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TableFunction"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a></h3> +<code><a href="../../../../../org/apache/samza/table/remote/TableFunction.html#isRetriable-java.lang.Throwable-">isRetriable</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TablePart"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></h3> +<code><a href="../../../../../org/apache/samza/table/remote/TablePart.html#toConfig-org.apache.samza.config.Config-org.apache.samza.config.Config-">toConfig</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.operators.functions.ClosableFunction"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.samza.operators.functions.<a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a></h3> +<code><a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html#close--">close</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="table"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>table</h4> +<pre>protected <a href="../../../../../org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a> table</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BaseTableFunction--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BaseTableFunction</h4> +<pre>public BaseTableFunction()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>init</h4> +<pre>public void init(<a href="../../../../../org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a> context, + <a href="../../../../../org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a> table)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/samza/table/remote/TableFunction.html#init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-">TableFunction</a></code></span></div> +<div class="block">Initializes the function before any operation.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/samza/table/remote/TableFunction.html#init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-">init</a></code> in interface <code><a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>context</code> - the <a href="../../../../../org/apache/samza/context/Context.html" title="interface in org.apache.samza.context"><code>Context</code></a> for this task</dd> +<dd><code>table</code> - the <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote"><code>TableFunction</code></a> which this table function belongs to</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/table/remote/BaseTableFunction.html" target="_top">Frames</a></li> +<li><a href="BaseTableFunction.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<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="subNavList"> +<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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableFunction.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableFunction.html?rev=1860788&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableFunction.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableFunction.html Fri Jun 7 20:22:19 2019 @@ -0,0 +1,280 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_121) on Thu Jun 06 15:02:02 PDT 2019 --> +<title>TableFunction (samza-api 1.2.0 API)</title> +<meta name="date" content="2019-06-06"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TableFunction (samza-api 1.2.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/table/remote/BaseTableFunction.html" title="class in org.apache.samza.table.remote"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/table/remote/TableFunction.html" target="_top">Frames</a></li> +<li><a href="TableFunction.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.table.remote</div> +<h2 title="Interface TableFunction" class="title">Interface TableFunction</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, java.io.Serializable, <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a><K,V>, <a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a><K,V></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/samza/table/remote/BaseTableFunction.html" title="class in org.apache.samza.table.remote">BaseTableFunction</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> +public interface <span class="typeNameLabel">TableFunction</span> +extends <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a>, <a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, java.io.Serializable</pre> +<div class="block">The root interface for table read and write function.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableFunction.html#init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-">init</a></span>(<a href="../../../../../org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a> context, + <a href="../../../../../org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a> table)</code> +<div class="block">Initializes the function before any operation.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableFunction.html#isRetriable-java.lang.Throwable-">isRetriable</a></span>(java.lang.Throwable exception)</code> +<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TablePart"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></h3> +<code><a href="../../../../../org/apache/samza/table/remote/TablePart.html#toConfig-org.apache.samza.config.Config-org.apache.samza.config.Config-">toConfig</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.operators.functions.ClosableFunction"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.samza.operators.functions.<a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a></h3> +<code><a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html#close--">close</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(<a href="../../../../../org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a> context, + <a href="../../../../../org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a> table)</pre> +<div class="block">Initializes the function before any operation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>context</code> - the <a href="../../../../../org/apache/samza/context/Context.html" title="interface in org.apache.samza.context"><code>Context</code></a> for this task</dd> +<dd><code>table</code> - the <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote"><code>TableFunction</code></a> which this table function belongs to</dd> +</dl> +</li> +</ul> +<a name="isRetriable-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isRetriable</h4> +<pre>boolean isRetriable(java.lang.Throwable exception)</pre> +<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>exception</code> - exception thrown by a table operation</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether the operation can be retried</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/table/remote/BaseTableFunction.html" title="class in org.apache.samza.table.remote"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/table/remote/TableFunction.html" target="_top">Frames</a></li> +<li><a href="TableFunction.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TablePart.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TablePart.html?rev=1860788&r1=1860787&r2=1860788&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TablePart.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TablePart.html Fri Jun 7 20:22:19 2019 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_202) on Mon Apr 15 15:43:35 PDT 2019 --> -<title>TablePart (samza-api 1.1.1-SNAPSHOT API)</title> -<meta name="date" content="2019-04-15"> +<!-- Generated by javadoc (1.8.0_121) on Thu Jun 06 15:02:02 PDT 2019 --> +<title>TablePart (samza-api 1.2.0 API)</title> +<meta name="date" content="2019-06-06"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TablePart (samza-api 1.1.1-SNAPSHOT API)"; + parent.document.title="TablePart (samza-api 1.2.0 API)"; } } catch(err) { @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="class in org.apache.samza.table.remote"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -100,11 +100,11 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <dl> <dt>All Known Subinterfaces:</dt> -<dd><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="interface in org.apache.samza.table.remote">TableRateLimiter.CreditFunction</a><K,V>, <a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a><K,V>, <a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a><K,V></dd> +<dd><a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a>, <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="interface in org.apache.samza.table.remote">TableRateLimiter.CreditFunction</a><K,V>, <a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a><K,V>, <a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a><K,V></dd> </dl> <dl> <dt>All Known Implementing Classes:</dt> -<dd><a href="../../../../../org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dd> +<dd><a href="../../../../../org/apache/samza/table/remote/BaseTableFunction.html" title="class in org.apache.samza.table.remote">BaseTableFunction</a>, <a href="../../../../../org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dd> </dl> <hr> <br> @@ -198,7 +198,7 @@ public interface <span class="typeNameLa </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="class in org.apache.samza.table.remote"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html?rev=1860788&r1=1860787&r2=1860788&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html Fri Jun 7 20:22:19 2019 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_202) on Mon Apr 15 15:43:35 PDT 2019 --> -<title>TableRateLimiter.CreditFunction (samza-api 1.1.1-SNAPSHOT API)</title> -<meta name="date" content="2019-04-15"> +<!-- Generated by javadoc (1.8.0_121) on Thu Jun 06 15:02:02 PDT 2019 --> +<title>TableRateLimiter.CreditFunction (samza-api 1.2.0 API)</title> +<meta name="date" content="2019-06-06"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,14 +12,14 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TableRateLimiter.CreditFunction (samza-api 1.1.1-SNAPSHOT API)"; + parent.document.title="TableRateLimiter.CreditFunction (samza-api 1.2.0 API)"; } } catch(err) { } //--> -var methods = {"i0":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var methods = {"i0":18,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -132,15 +132,23 @@ extends <a href="../../../../../org/apac </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> +<td class="colFirst"><code>default int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html#getCredits-int-java.lang.Object...-">getCredits</a></span>(int opId, + java.lang.Object... args)</code> +<div class="block">Get the number of credits required for the <code>opId</code> and associated <code>args</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html#getCredits-K-V-">getCredits</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="type parameter in TableRateLimiter.CreditFunction">K</a> key, - <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="type parameter in TableRateLimiter.CreditFunction">V</a> value)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html#getCredits-K-V-java.lang.Object...-">getCredits</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="type parameter in TableRateLimiter.CreditFunction">K</a> key, + <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="type parameter in TableRateLimiter.CreditFunction">V</a> value, + java.lang.Object... args)</code> <div class="block">Get the number of credits required for the <code>key</code> and <code>value</code> pair.</div> </td> </tr> @@ -166,21 +174,41 @@ extends <a href="../../../../../org/apac <!-- --> </a> <h3>Method Detail</h3> -<a name="getCredits-java.lang.Object-java.lang.Object-"> +<a name="getCredits-java.lang.Object-java.lang.Object-java.lang.Object:A-"> <!-- --> -</a><a name="getCredits-K-V-"> +</a><a name="getCredits-K-V-java.lang.Object...-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getCredits</h4> <pre>int getCredits(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="type parameter in TableRateLimiter.CreditFunction">K</a> key, - <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="type parameter in TableRateLimiter.CreditFunction">V</a> value)</pre> + <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="type parameter in TableRateLimiter.CreditFunction">V</a> value, + java.lang.Object... args)</pre> <div class="block">Get the number of credits required for the <code>key</code> and <code>value</code> pair.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>key</code> - table key</dd> <dd><code>value</code> - table record</dd> +<dd><code>args</code> - additional arguments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>number of credits</dd> +</dl> +</li> +</ul> +<a name="getCredits-int-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCredits</h4> +<pre>default int getCredits(int opId, + java.lang.Object... args)</pre> +<div class="block">Get the number of credits required for the <code>opId</code> and associated <code>args</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>opId</code> - operation Id</dd> +<dd><code>args</code> - additional arguments</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>number of credits</dd> </dl> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.html?rev=1860788&r1=1860787&r2=1860788&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableRateLimiter.html Fri Jun 7 20:22:19 2019 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_202) on Mon Apr 15 15:43:35 PDT 2019 --> -<title>TableRateLimiter (samza-api 1.1.1-SNAPSHOT API)</title> -<meta name="date" content="2019-04-15"> +<!-- Generated by javadoc (1.8.0_121) on Thu Jun 06 15:02:02 PDT 2019 --> +<title>TableRateLimiter (samza-api 1.2.0 API)</title> +<meta name="date" content="2019-06-06"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,13 +12,13 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TableRateLimiter (samza-api 1.1.1-SNAPSHOT API)"; + parent.document.title="TableRateLimiter (samza-api 1.2.0 API)"; } } catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -185,26 +185,37 @@ extends java.lang.Object</pre> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttle-java.util.Collection-">throttle</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>> keys)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttle-java.util.Collection-java.lang.Object...-">throttle</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>> keys, + java.lang.Object... args)</code> <div class="block">Throttle a request with a collection of keys as the argument if necessary.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttle-K-">throttle</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a> key)</code> -<div class="block">Throttle a request with a key argument if necessary.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttle-int-java.lang.Object...-">throttle</a></span>(int opId, + java.lang.Object... args)</code> +<div class="block">Throttle a request with opId and associated arguments</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttle-K-V-">throttle</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a> key, - <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a> value)</code> -<div class="block">Throttle a request with both the key and value arguments if necessary.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttle-K-java.lang.Object...-">throttle</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a> key, + java.lang.Object... args)</code> +<div class="block">Throttle a request with a key argument if necessary.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttleRecords-java.util.Collection-">throttleRecords</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a>>> records)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttle-K-V-java.lang.Object...-">throttle</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a> key, + <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a> value, + java.lang.Object... args)</code> +<div class="block">Throttle a request with both the key and value arguments if necessary.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html#throttleRecords-java.util.Collection-java.lang.Object...-">throttleRecords</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a>>> records, + java.lang.Object... args)</code> <div class="block">Throttle a request with a collection of table records as the argument if necessary.</div> </td> </tr> @@ -271,65 +282,89 @@ extends java.lang.Object</pre> </dl> </li> </ul> -<a name="throttle-java.lang.Object-"> +<a name="throttle-java.lang.Object-java.lang.Object:A-"> <!-- --> -</a><a name="throttle-K-"> +</a><a name="throttle-K-java.lang.Object...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>throttle</h4> -<pre>public void throttle(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a> key)</pre> +<pre>public void throttle(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a> key, + java.lang.Object... args)</pre> <div class="block">Throttle a request with a key argument if necessary.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>key</code> - key used for the table request</dd> +<dd><code>args</code> - additional arguments</dd> </dl> </li> </ul> -<a name="throttle-java.lang.Object-java.lang.Object-"> +<a name="throttle-java.lang.Object-java.lang.Object-java.lang.Object:A-"> <!-- --> -</a><a name="throttle-K-V-"> +</a><a name="throttle-K-V-java.lang.Object...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>throttle</h4> <pre>public void throttle(<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a> key, - <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a> value)</pre> + <a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a> value, + java.lang.Object... args)</pre> <div class="block">Throttle a request with both the key and value arguments if necessary.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>key</code> - key used for the table request</dd> <dd><code>value</code> - value used for the table request</dd> +<dd><code>args</code> - additional arguments</dd> +</dl> +</li> +</ul> +<a name="throttle-int-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>throttle</h4> +<pre>public void throttle(int opId, + java.lang.Object... args)</pre> +<div class="block">Throttle a request with opId and associated arguments</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>opId</code> - operation Id</dd> +<dd><code>args</code> - associated arguments</dd> </dl> </li> </ul> -<a name="throttle-java.util.Collection-"> +<a name="throttle-java.util.Collection-java.lang.Object...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>throttle</h4> -<pre>public void throttle(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>> keys)</pre> +<pre>public void throttle(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>> keys, + java.lang.Object... args)</pre> <div class="block">Throttle a request with a collection of keys as the argument if necessary.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>keys</code> - collection of keys used for the table request</dd> +<dd><code>args</code> - additional arguments</dd> </dl> </li> </ul> -<a name="throttleRecords-java.util.Collection-"> +<a name="throttleRecords-java.util.Collection-java.lang.Object...-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>throttleRecords</h4> -<pre>public void throttleRecords(java.util.Collection<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a>>> records)</pre> +<pre>public void throttleRecords(java.util.Collection<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableRateLimiter.html" title="type parameter in TableRateLimiter">V</a>>> records, + java.lang.Object... args)</pre> <div class="block">Throttle a request with a collection of table records as the argument if necessary.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>records</code> - collection of records used for the table request</dd> +<dd><code>args</code> - additional arguments</dd> </dl> </li> </ul> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableReadFunction.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableReadFunction.html?rev=1860788&r1=1860787&r2=1860788&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableReadFunction.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableReadFunction.html Fri Jun 7 20:22:19 2019 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_202) on Mon Apr 15 15:43:35 PDT 2019 --> -<title>TableReadFunction (samza-api 1.1.1-SNAPSHOT API)</title> -<meta name="date" content="2019-04-15"> +<!-- Generated by javadoc (1.8.0_121) on Thu Jun 06 15:02:02 PDT 2019 --> +<title>TableReadFunction (samza-api 1.2.0 API)</title> +<meta name="date" content="2019-06-06"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,13 +12,13 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TableReadFunction (samza-api 1.1.1-SNAPSHOT API)"; + parent.document.title="TableReadFunction (samza-api 1.2.0 API)"; } } catch(err) { } //--> -var methods = {"i0":18,"i1":18,"i2":18,"i3":6,"i4":6}; +var methods = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":6,"i5":18,"i6":18}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -105,13 +105,13 @@ var activeTableTab = "activeTableTab"; </dl> <dl> <dt>All Superinterfaces:</dt> -<dd><a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, <a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions">InitableFunction</a>, java.io.Serializable, <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></dd> +<dd><a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, java.io.Serializable, <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a>, <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></dd> </dl> <hr> <br> <pre><a href="../../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> public interface <span class="typeNameLabel">TableReadFunction<K,V></span> -extends <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a>, <a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions">InitableFunction</a>, <a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, java.io.Serializable</pre> +extends <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a></pre> <div class="block">A function object to be used with a remote readable table implementation. It encapsulates the functionality of reading table record(s) for a provided set of key(s). @@ -156,31 +156,46 @@ extends <a href="../../../../../org/apac </td> </tr> <tr id="i3" class="rowColor"> +<td class="colFirst"><code>default java.util.concurrent.CompletableFuture<java.util.Map<<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">V</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html#getAllAsync-java.util.Collection-java.lang.Object...-">getAllAsync</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">K</a>> keys, + java.lang.Object... args)</code> +<div class="block">Asynchronously fetch the table <code>records</code> for specified <code>keys</code> and additional arguments.</div> +</td> +</tr> +<tr id="i4" class="altColor"> <td class="colFirst"><code>java.util.concurrent.CompletableFuture<<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">V</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html#getAsync-K-">getAsync</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">K</a> key)</code> <div class="block">Asynchronously fetch single table record for a specified <code>key</code>.</div> </td> </tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html#isRetriable-java.lang.Throwable-">isRetriable</a></span>(java.lang.Throwable exception)</code> -<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>default java.util.concurrent.CompletableFuture<<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">V</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html#getAsync-K-java.lang.Object...-">getAsync</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">K</a> key, + java.lang.Object... args)</code> +<div class="block">Asynchronously fetch single table record for a specified <code>key</code> with additional arguments.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>default <T> java.util.concurrent.CompletableFuture<T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html#readAsync-int-java.lang.Object...-">readAsync</a></span>(int opId, + java.lang.Object... args)</code> +<div class="block">Asynchronously read data from table for specified <code>opId</code> and additional arguments.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TablePart"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TableFunction"> <!-- --> </a> -<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></h3> -<code><a href="../../../../../org/apache/samza/table/remote/TablePart.html#toConfig-org.apache.samza.config.Config-org.apache.samza.config.Config-">toConfig</a></code></li> +<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a></h3> +<code><a href="../../../../../org/apache/samza/table/remote/TableFunction.html#init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-">init</a>, <a href="../../../../../org/apache/samza/table/remote/TableFunction.html#isRetriable-java.lang.Throwable-">isRetriable</a></code></li> </ul> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.operators.functions.InitableFunction"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TablePart"> <!-- --> </a> -<h3>Methods inherited from interface org.apache.samza.operators.functions.<a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions">InitableFunction</a></h3> -<code><a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html#init-org.apache.samza.context.Context-">init</a></code></li> +<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></h3> +<code><a href="../../../../../org/apache/samza/table/remote/TablePart.html#toConfig-org.apache.samza.config.Config-org.apache.samza.config.Config-">toConfig</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.operators.functions.ClosableFunction"> @@ -240,6 +255,27 @@ extends <a href="../../../../../org/apac </dl> </li> </ul> +<a name="getAsync-java.lang.Object-java.lang.Object:A-"> +<!-- --> +</a><a name="getAsync-K-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsync</h4> +<pre>default java.util.concurrent.CompletableFuture<<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">V</a>> getAsync(<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">K</a> key, + java.lang.Object... args)</pre> +<div class="block">Asynchronously fetch single table record for a specified <code>key</code> with additional arguments. + This method must be thread-safe.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - key for the table record</dd> +<dd><code>args</code> - additional arguments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>CompletableFuture for the get request</dd> +</dl> +</li> +</ul> <a name="getAll-java.util.Collection-"> <!-- --> </a> @@ -274,19 +310,43 @@ extends <a href="../../../../../org/apac </dl> </li> </ul> -<a name="isRetriable-java.lang.Throwable-"> +<a name="getAllAsync-java.util.Collection-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllAsync</h4> +<pre>default java.util.concurrent.CompletableFuture<java.util.Map<<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">V</a>>> getAllAsync(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableReadFunction.html" title="type parameter in TableReadFunction">K</a>> keys, + java.lang.Object... args)</pre> +<div class="block">Asynchronously fetch the table <code>records</code> for specified <code>keys</code> and additional arguments. + This method must be thread-safe.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>keys</code> - keys for the table records</dd> +<dd><code>args</code> - additional arguments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>CompletableFuture for the get request</dd> +</dl> +</li> +</ul> +<a name="readAsync-int-java.lang.Object...-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>isRetriable</h4> -<pre>boolean isRetriable(java.lang.Throwable exception)</pre> -<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> +<h4>readAsync</h4> +<pre>default <T> java.util.concurrent.CompletableFuture<T> readAsync(int opId, + java.lang.Object... args)</pre> +<div class="block">Asynchronously read data from table for specified <code>opId</code> and additional arguments. + This method must be thread-safe.</div> <dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - return type</dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>exception</code> - exception thrown by a table operation</dd> +<dd><code>opId</code> - operation identifier</dd> +<dd><code>args</code> - additional arguments</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>whether the operation can be retried</dd> +<dd>CompletableFuture for the read request</dd> </dl> </li> </ul> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableWriteFunction.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableWriteFunction.html?rev=1860788&r1=1860787&r2=1860788&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableWriteFunction.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/table/remote/TableWriteFunction.html Fri Jun 7 20:22:19 2019 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_202) on Mon Apr 15 15:43:35 PDT 2019 --> -<title>TableWriteFunction (samza-api 1.1.1-SNAPSHOT API)</title> -<meta name="date" content="2019-04-15"> +<!-- Generated by javadoc (1.8.0_121) on Thu Jun 06 15:02:02 PDT 2019 --> +<title>TableWriteFunction (samza-api 1.2.0 API)</title> +<meta name="date" content="2019-06-06"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,13 +12,13 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TableWriteFunction (samza-api 1.1.1-SNAPSHOT API)"; + parent.document.title="TableWriteFunction (samza-api 1.2.0 API)"; } } catch(err) { } //--> -var methods = {"i0":18,"i1":18,"i2":18,"i3":6,"i4":18,"i5":6,"i6":18,"i7":18,"i8":18,"i9":6}; +var methods = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":6,"i5":18,"i6":18,"i7":18,"i8":18,"i9":18,"i10":18,"i11":6,"i12":18,"i13":18}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -105,13 +105,13 @@ var activeTableTab = "activeTableTab"; </dl> <dl> <dt>All Superinterfaces:</dt> -<dd><a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, <a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions">InitableFunction</a>, java.io.Serializable, <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></dd> +<dd><a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, java.io.Serializable, <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a>, <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></dd> </dl> <hr> <br> <pre><a href="../../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> public interface <span class="typeNameLabel">TableWriteFunction<K,V></span> -extends <a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a>, <a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions">InitableFunction</a>, <a href="../../../../../org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions">ClosableFunction</a>, java.io.Serializable</pre> +extends <a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a></pre> <div class="block">A function object to be used with a remote read/write table implementation. It encapsulates the functionality of writing table record(s) for a provided set of key(s) to the store. @@ -157,63 +157,94 @@ extends <a href="../../../../../org/apac </td> </tr> <tr id="i3" class="rowColor"> +<td class="colFirst"><code>default java.util.concurrent.CompletableFuture<java.lang.Void></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#deleteAllAsync-java.util.Collection-java.lang.Object...-">deleteAllAsync</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a>> keys, + java.lang.Object... args)</code> +<div class="block">Asynchronously delete all <code>records</code> with the specified <code>keys</code> and additional arguments from + the remote store.</div> +</td> +</tr> +<tr id="i4" class="altColor"> <td class="colFirst"><code>java.util.concurrent.CompletableFuture<java.lang.Void></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#deleteAsync-K-">deleteAsync</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a> key)</code> <div class="block">Asynchronously delete the <code>record</code> with specified <code>key</code> from the remote store</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>default java.util.concurrent.CompletableFuture<java.lang.Void></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#deleteAsync-K-java.lang.Object...-">deleteAsync</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a> key, + java.lang.Object... args)</code> +<div class="block">Asynchronously delete the <code>record</code> with specified <code>key</code> and additional arguments from the remote store</div> +</td> +</tr> +<tr id="i6" class="altColor"> <td class="colFirst"><code>default void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#flush--">flush</a></span>()</code> <div class="block">Flush the remote store (optional)</div> </td> </tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#isRetriable-java.lang.Throwable-">isRetriable</a></span>(java.lang.Throwable exception)</code> -<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> -</td> -</tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>default void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#put-K-V-">put</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a> key, <a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a> record)</code> <div class="block">Store single table <code>record</code> with specified <code>key</code>.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>default void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#putAll-java.util.List-">putAll</a></span>(java.util.List<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a>>> records)</code> <div class="block">Store the table <code>records</code> with specified <code>keys</code>.</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>default java.util.concurrent.CompletableFuture<java.lang.Void></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#putAllAsync-java.util.Collection-">putAllAsync</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a>>> records)</code> <div class="block">Asynchronously store the table <code>records</code> with specified <code>keys</code>.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>default java.util.concurrent.CompletableFuture<java.lang.Void></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#putAllAsync-java.util.Collection-java.lang.Object...-">putAllAsync</a></span>(java.util.Collection<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a>>> records, + java.lang.Object... args)</code> +<div class="block">Asynchronously store the table <code>records</code> with specified <code>keys</code> and additional arguments.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>java.util.concurrent.CompletableFuture<java.lang.Void></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#putAsync-K-V-">putAsync</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a> key, <a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a> record)</code> <div class="block">Asynchronously store single table <code>record</code> with specified <code>key</code>.</div> </td> </tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>default java.util.concurrent.CompletableFuture<java.lang.Void></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#putAsync-K-V-java.lang.Object...-">putAsync</a></span>(<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a> key, + <a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a> record, + java.lang.Object... args)</code> +<div class="block">Asynchronously store single table <code>record</code> with specified <code>key</code> and additional arguments.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>default <T> java.util.concurrent.CompletableFuture<T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html#writeAsync-int-java.lang.Object...-">writeAsync</a></span>(int opId, + java.lang.Object... args)</code> +<div class="block">Asynchronously write data to table for specified <code>opId</code> and additional arguments.</div> +</td> +</tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TablePart"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TableFunction"> <!-- --> </a> -<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></h3> -<code><a href="../../../../../org/apache/samza/table/remote/TablePart.html#toConfig-org.apache.samza.config.Config-org.apache.samza.config.Config-">toConfig</a></code></li> +<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TableFunction.html" title="interface in org.apache.samza.table.remote">TableFunction</a></h3> +<code><a href="../../../../../org/apache/samza/table/remote/TableFunction.html#init-org.apache.samza.context.Context-org.apache.samza.table.AsyncReadWriteTable-">init</a>, <a href="../../../../../org/apache/samza/table/remote/TableFunction.html#isRetriable-java.lang.Throwable-">isRetriable</a></code></li> </ul> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.operators.functions.InitableFunction"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.table.remote.TablePart"> <!-- --> </a> -<h3>Methods inherited from interface org.apache.samza.operators.functions.<a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions">InitableFunction</a></h3> -<code><a href="../../../../../org/apache/samza/operators/functions/InitableFunction.html#init-org.apache.samza.context.Context-">init</a></code></li> +<h3>Methods inherited from interface org.apache.samza.table.remote.<a href="../../../../../org/apache/samza/table/remote/TablePart.html" title="interface in org.apache.samza.table.remote">TablePart</a></h3> +<code><a href="../../../../../org/apache/samza/table/remote/TablePart.html#toConfig-org.apache.samza.config.Config-org.apache.samza.config.Config-">toConfig</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.operators.functions.ClosableFunction"> @@ -275,6 +306,29 @@ extends <a href="../../../../../org/apac </dl> </li> </ul> +<a name="putAsync-java.lang.Object-java.lang.Object-java.lang.Object:A-"> +<!-- --> +</a><a name="putAsync-K-V-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAsync</h4> +<pre>default java.util.concurrent.CompletableFuture<java.lang.Void> putAsync(<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a> key, + <a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a> record, + java.lang.Object... args)</pre> +<div class="block">Asynchronously store single table <code>record</code> with specified <code>key</code> and additional arguments. + This method must be thread-safe.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - key for the table record</dd> +<dd><code>record</code> - table record to be written</dd> +<dd><code>args</code> - additional arguments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>CompletableFuture for the put request</dd> +</dl> +</li> +</ul> <a name="putAll-java.util.List-"> <!-- --> </a> @@ -307,6 +361,25 @@ extends <a href="../../../../../org/apac </dl> </li> </ul> +<a name="putAllAsync-java.util.Collection-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAllAsync</h4> +<pre>default java.util.concurrent.CompletableFuture<java.lang.Void> putAllAsync(java.util.Collection<<a href="../../../../../org/apache/samza/storage/kv/Entry.html" title="class in org.apache.samza.storage.kv">Entry</a><<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a>,<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">V</a>>> records, + java.lang.Object... args)</pre> +<div class="block">Asynchronously store the table <code>records</code> with specified <code>keys</code> and additional arguments. + This method must be thread-safe.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>records</code> - table records to be written</dd> +<dd><code>args</code> - additional arguments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>CompletableFuture for the put request</dd> +</dl> +</li> +</ul> <a name="delete-java.lang.Object-"> <!-- --> </a><a name="delete-K-"> @@ -342,6 +415,26 @@ extends <a href="../../../../../org/apac </dl> </li> </ul> +<a name="deleteAsync-java.lang.Object-java.lang.Object:A-"> +<!-- --> +</a><a name="deleteAsync-K-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAsync</h4> +<pre>default java.util.concurrent.CompletableFuture<java.lang.Void> deleteAsync(<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a> key, + java.lang.Object... args)</pre> +<div class="block">Asynchronously delete the <code>record</code> with specified <code>key</code> and additional arguments from the remote store</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - key to the table record to be deleted</dd> +<dd><code>args</code> - additional arguments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>CompletableFuture for the delete request</dd> +</dl> +</li> +</ul> <a name="deleteAll-java.util.Collection-"> <!-- --> </a> @@ -374,19 +467,43 @@ extends <a href="../../../../../org/apac </dl> </li> </ul> -<a name="isRetriable-java.lang.Throwable-"> +<a name="deleteAllAsync-java.util.Collection-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAllAsync</h4> +<pre>default java.util.concurrent.CompletableFuture<java.lang.Void> deleteAllAsync(java.util.Collection<<a href="../../../../../org/apache/samza/table/remote/TableWriteFunction.html" title="type parameter in TableWriteFunction">K</a>> keys, + java.lang.Object... args)</pre> +<div class="block">Asynchronously delete all <code>records</code> with the specified <code>keys</code> and additional arguments from + the remote store.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>keys</code> - keys for the table records to be written</dd> +<dd><code>args</code> - additional arguments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>CompletableFuture for the deleteAll request</dd> +</dl> +</li> +</ul> +<a name="writeAsync-int-java.lang.Object...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>isRetriable</h4> -<pre>boolean isRetriable(java.lang.Throwable exception)</pre> -<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> +<h4>writeAsync</h4> +<pre>default <T> java.util.concurrent.CompletableFuture<T> writeAsync(int opId, + java.lang.Object... args)</pre> +<div class="block">Asynchronously write data to table for specified <code>opId</code> and additional arguments. + This method must be thread-safe.</div> <dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - return type</dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>exception</code> - exception thrown by a table operation</dd> +<dd><code>opId</code> - operation identifier</dd> +<dd><code>args</code> - additional arguments</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>whether the operation can be retried</dd> +<dd>CompletableFuture for the write request</dd> </dl> </li> </ul>
