Modified: samza/site/learn/documentation/latest/api/javadocs/index-all.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/index-all.html?rev=1848654&r1=1848653&r2=1848654&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/index-all.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/index-all.html Tue Dec 11 07:23:12 2018 @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_181) on Tue Nov 27 02:00:04 PST 2018 --> -<title>Index (samza-api 1.0.0 API)</title> -<meta name="date" content="2018-11-27"> +<!-- Generated by javadoc (1.8.0_181) on Mon Dec 10 23:18:52 PST 2018 --> +<title>Index (samza-api 1.0.1-SNAPSHOT API)</title> +<meta name="date" content="2018-12-10"> <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="Index (samza-api 1.0.0 API)"; + parent.document.title="Index (samza-api 1.0.1-SNAPSHOT API)"; } } catch(err) { @@ -101,6 +101,14 @@ <dd> <div class="block">Add a value to the list.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html#addStoreConfig-java.lang.String-java.lang.String-java.util.Map-">addStoreConfig(String, String, Map<String, String>)</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html" title="class in org.apache.samza.table.descriptors">LocalTableDescriptor</a></dt> +<dd> +<div class="block">Helper method to add a store level config item to table configuration</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html#addTableConfig-java.lang.String-java.lang.String-java.util.Map-">addTableConfig(String, String, Map<String, String>)</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="class in org.apache.samza.table.descriptors">BaseTableDescriptor</a></dt> +<dd> +<div class="block">Helper method to add a config item to table configuration</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/runtime/ProcessorLifecycleListener.html#afterFailure-java.lang.Throwable-">afterFailure(Throwable)</a></span> - Method in interface org.apache.samza.runtime.<a href="org/apache/samza/runtime/ProcessorLifecycleListener.html" title="interface in org.apache.samza.runtime">ProcessorLifecycleListener</a></dt> <dd> <div class="block">User defined callback after a StreamProcessor is stopped with failure</div> @@ -207,6 +215,8 @@ <div class="block">Expands the provided <a href="org/apache/samza/system/descriptors/InputDescriptor.html" title="class in org.apache.samza.system.descriptors"><code>InputDescriptor</code></a> to a sub-DAG of one or more operators on the <a href="org/apache/samza/application/descriptors/StreamApplicationDescriptor.html" title="interface in org.apache.samza.application.descriptors"><code>StreamApplicationDescriptor</code></a>, and returns a new <a href="org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> with the combined results.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/RemoteTableDescriptor.html#ASYNC_CALLBACK_POOL_SIZE">ASYNC_CALLBACK_POOL_SIZE</a></span> - Static variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/RemoteTableDescriptor.html" title="class in org.apache.samza.table.descriptors">RemoteTableDescriptor</a></dt> +<dd> </dd> <dt><a href="org/apache/samza/task/AsyncStreamTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">AsyncStreamTask</span></a> - Interface in <a href="org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> <dd> <div class="block">An AsyncStreamTask is the basic class to support multithreading execution in Samza container.</div> @@ -228,6 +238,14 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/chooser/BaseMessageChooser.html#BaseMessageChooser--">BaseMessageChooser()</a></span> - Constructor for class org.apache.samza.system.chooser.<a href="org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser">BaseMessageChooser</a></dt> <dd> </dd> +<dt><a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="class in org.apache.samza.table.descriptors"><span class="typeNameLink">BaseTableDescriptor</span></a><<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="type parameter in BaseTableDescriptor">K</a>,<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="type parameter in BaseTableDescriptor">V</a>,<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="type parameter in BaseTableDescriptor">D</a> extends <a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="class in org.apache.samza.table.descriptors">BaseTableDescriptor</a><<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="type parameter in BaseTableDescriptor">K</a>,<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="type parameter in BaseTableDescriptor">V</a>,<a href="org/apache/samza/table/descriptors /BaseTableDescriptor.html" title="type parameter in BaseTableDescriptor">D</a>>> - Class in <a href="org/apache/samza/table/descriptors/package-summary.html">org.apache.samza.table.descriptors</a></dt> +<dd> +<div class="block">Base class for all table descriptor implementations.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html#BaseTableDescriptor-java.lang.String-">BaseTableDescriptor(String)</a></span> - Constructor for class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="class in org.apache.samza.table.descriptors">BaseTableDescriptor</a></dt> +<dd> +<div class="block">Constructs a table descriptor instance</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/runtime/ProcessorLifecycleListener.html#beforeStart--">beforeStart()</a></span> - Method in interface org.apache.samza.runtime.<a href="org/apache/samza/runtime/ProcessorLifecycleListener.html" title="interface in org.apache.samza.runtime">ProcessorLifecycleListener</a></dt> <dd> <div class="block">User defined initialization before a StreamProcessor is started</div> @@ -279,6 +297,10 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/CommandBuilder.html#buildEnvironment--">buildEnvironment()</a></span> - Method in class org.apache.samza.job.<a href="org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#buildKey-java.lang.String-java.lang.String-">buildKey(String, String)</a></span> - Static method in class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> +<dd> +<div class="block">Build complete config key for a config item</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#buildWatermarkEnvelope-org.apache.samza.system.SystemStreamPartition-long-">buildWatermarkEnvelope(SystemStreamPartition, long)</a></span> - Static method in class org.apache.samza.system.<a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> <dd> </dd> <dt><a href="org/apache/samza/serializers/ByteBufferSerde.html" title="class in org.apache.samza.serializers"><span class="typeNameLink">ByteBufferSerde</span></a> - Class in <a href="org/apache/samza/serializers/package-summary.html">org.apache.samza.serializers</a></dt> @@ -307,10 +329,31 @@ </a> <h2 class="title">C</h2> <dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html#CACHE_SIZE">CACHE_SIZE</a></span> - Static variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="class in org.apache.samza.table.descriptors">CachingTableDescriptor</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html#CACHE_TABLE_ID">CACHE_TABLE_ID</a></span> - Static variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="class in org.apache.samza.table.descriptors">CachingTableDescriptor</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="class in org.apache.samza.table.descriptors"><span class="typeNameLink">CachingTableDescriptor</span></a><<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="type parameter in CachingTableDescriptor">K</a>,<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="type parameter in CachingTableDescriptor">V</a>> - Class in <a href="org/apache/samza/table/descriptors/package-summary.html">org.apache.samza.table.descriptors</a></dt> +<dd> +<div class="block">Table descriptor for a caching table.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html#CachingTableDescriptor-java.lang.String-org.apache.samza.table.descriptors.TableDescriptor-">CachingTableDescriptor(String, TableDescriptor<K, V, ?>)</a></span> - Constructor for class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="class in org.apache.samza.table.descriptors">CachingTableDescriptor</a></dt> +<dd> +<div class="block">Constructs a table descriptor instance with internal cache</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html#CachingTableDescriptor-java.lang.String-org.apache.samza.table.descriptors.TableDescriptor-org.apache.samza.table.descriptors.TableDescriptor-">CachingTableDescriptor(String, TableDescriptor<K, V, ?>, TableDescriptor<K, V, ?>)</a></span> - Constructor for class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="class in org.apache.samza.table.descriptors">CachingTableDescriptor</a></dt> +<dd> +<div class="block">Constructs a table descriptor instance and specify a cache (as Table descriptor) + to be used for caching.</div> +</dd> <dt><a href="org/apache/samza/scheduler/CallbackScheduler.html" title="interface in org.apache.samza.scheduler"><span class="typeNameLink">CallbackScheduler</span></a> - Interface in <a href="org/apache/samza/scheduler/package-summary.html">org.apache.samza.scheduler</a></dt> <dd> <div class="block">Provides a way for applications to register some logic to be executed at a future time.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html#changelogReplicationFactor">changelogReplicationFactor</a></span> - Variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html" title="class in org.apache.samza.table.descriptors">LocalTableDescriptor</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html#changelogStream">changelogStream</a></span> - Variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html" title="class in org.apache.samza.table.descriptors">LocalTableDescriptor</a></dt> +<dd> </dd> <dt><a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint"><span class="typeNameLink">Checkpoint</span></a> - Class in <a href="org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> <dd> <div class="block">A checkpoint is a mapping of all the streams a job is consuming and the most recent current offset for each.</div> @@ -389,14 +432,14 @@ <dd> <div class="block">Closes this key-value store, if applicable, relinquishing any underlying resources.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/TableProvider.html#close--">close()</a></span> - Method in interface org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/TableProvider.html" title="interface in org.apache.samza.table.descriptors">TableProvider</a></dt> -<dd> -<div class="block">Shutdown the underlying table</div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/ReadableTable.html#close--">close()</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadableTable.html" title="interface in org.apache.samza.table">ReadableTable</a></dt> <dd> <div class="block">Close the table and release any resources acquired</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableProvider.html#close--">close()</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/TableProvider.html" title="interface in org.apache.samza.table">TableProvider</a></dt> +<dd> +<div class="block">Shutdown the underlying table</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/task/ClosableTask.html#close--">close()</a></span> - Method in interface org.apache.samza.task.<a href="org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task">ClosableTask</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> @@ -441,6 +484,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/CommandBuilder.html#config">config</a></span> - Variable in class org.apache.samza.job.<a href="org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html#config">config</a></span> - Variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="class in org.apache.samza.table.descriptors">BaseTableDescriptor</a></dt> +<dd> </dd> <dt><a href="org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="typeNameLink">ConfigException</span></a> - Exception in <a href="org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> <dd> <div class="block">Specific <a href="org/apache/samza/SamzaException.html" title="class in org.apache.samza"><code>SamzaException</code></a>s thrown from <a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div> @@ -510,14 +555,22 @@ <div class="block">A <a href="org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a> that fires when the number of messages in the <a href="org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a> reaches the specified count.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/context/ApplicationContainerContextFactory.html#create-org.apache.samza.context.JobContext-org.apache.samza.context.ContainerContext-">create(JobContext, ContainerContext)</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/ApplicationContainerContextFactory.html" title="interface in org.apache.samza.context">ApplicationContainerContextFactory</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/context/ApplicationContainerContextFactory.html#create-org.apache.samza.context.ExternalContext-org.apache.samza.context.JobContext-org.apache.samza.context.ContainerContext-">create(ExternalContext, JobContext, ContainerContext)</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/ApplicationContainerContextFactory.html" title="interface in org.apache.samza.context">ApplicationContainerContextFactory</a></dt> <dd> <div class="block">Creates an instance of the application-defined <a href="org/apache/samza/context/ApplicationContainerContext.html" title="interface in org.apache.samza.context"><code>ApplicationContainerContext</code></a>.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/context/ApplicationTaskContextFactory.html#create-org.apache.samza.context.JobContext-org.apache.samza.context.ContainerContext-org.apache.samza.context.TaskContext-org.apache.samza.context.ApplicationContainerContext-">create(JobContext, ContainerContext, TaskContext, ApplicationContainerContext)</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/ApplicationTaskContextFactory.html" title="interface in org.apache.samza.context">ApplicationTaskContextFactory</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/context/ApplicationContainerContextFactory.html#create-org.apache.samza.context.JobContext-org.apache.samza.context.ContainerContext-">create(JobContext, ContainerContext)</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/ApplicationContainerContextFactory.html" title="interface in org.apache.samza.context">ApplicationContainerContextFactory</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/context/ApplicationTaskContextFactory.html#create-org.apache.samza.context.ExternalContext-org.apache.samza.context.JobContext-org.apache.samza.context.ContainerContext-org.apache.samza.context.TaskContext-org.apache.samza.context.ApplicationContainerContext-">create(ExternalContext, JobContext, ContainerContext, TaskContext, ApplicationContainerContext)</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/ApplicationTaskContextFactory.html" title="interface in org.apache.samza.context">ApplicationTaskContextFactory</a></dt> <dd> <div class="block">Creates an instance of the application-defined <a href="org/apache/samza/context/ApplicationTaskContext.html" title="interface in org.apache.samza.context"><code>ApplicationTaskContext</code></a>.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/context/ApplicationTaskContextFactory.html#create-org.apache.samza.context.JobContext-org.apache.samza.context.ContainerContext-org.apache.samza.context.TaskContext-org.apache.samza.context.ApplicationContainerContext-">create(JobContext, ContainerContext, TaskContext, ApplicationContainerContext)</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/ApplicationTaskContextFactory.html" title="interface in org.apache.samza.context">ApplicationTaskContextFactory</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#createChangeLogStreamSpec-java.lang.String-java.lang.String-int-">createChangeLogStreamSpec(String, String, int)</a></span> - Static method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#createCheckpointStreamSpec-java.lang.String-java.lang.String-">createCheckpointStreamSpec(String, String)</a></span> - Static method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> @@ -554,7 +607,9 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Counter.html#dec-long-">dec(long)</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/metadatastore/MetadataStore.html#delete-byte:A-">delete(byte[])</a></span> - Method in interface org.apache.samza.metadatastore.<a href="org/apache/samza/metadatastore/MetadataStore.html" title="interface in org.apache.samza.metadatastore">MetadataStore</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/RemoteTableDescriptor.html#DEFAULT_RATE_LIMITER_CLASS_NAME">DEFAULT_RATE_LIMITER_CLASS_NAME</a></span> - Static variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/RemoteTableDescriptor.html" title="class in org.apache.samza.table.descriptors">RemoteTableDescriptor</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/metadatastore/MetadataStore.html#delete-java.lang.String-">delete(String)</a></span> - Method in interface org.apache.samza.metadatastore.<a href="org/apache/samza/metadatastore/MetadataStore.html" title="interface in org.apache.samza.metadatastore">MetadataStore</a></dt> <dd> <div class="block">Deletes the mapping for the specified <code>key</code> from this metadata store (if such mapping exists).</div> </dd> @@ -570,6 +625,10 @@ <dd> <div class="block">Deletes the mapping for the specified <code>key</code> from this table (if such mapping exists).</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableWriteFunction.html#delete-K-">delete(K)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a></dt> +<dd> +<div class="block">Delete the <code>record</code> with specified <code>key</code> from the remote store.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueStore.html#deleteAll-java.util.List-">deleteAll(List<K>)</a></span> - Method in interface org.apache.samza.storage.kv.<a href="org/apache/samza/storage/kv/KeyValueStore.html" title="interface in org.apache.samza.storage.kv">KeyValueStore</a></dt> <dd> <div class="block">Deletes the mappings for the specified <code>keys</code> from this key-value store (if such mappings exist).</div> @@ -578,14 +637,27 @@ <dd> <div class="block">Deletes the mappings for the specified <code>keys</code> from this table.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableWriteFunction.html#deleteAll-java.util.Collection-">deleteAll(Collection<K>)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a></dt> +<dd> +<div class="block">Delete all <code>records</code> with the specified <code>keys</code> from the remote store + The default implementation calls deleteAllAsync and blocks on the completion afterwards.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/ReadWriteTable.html#deleteAllAsync-java.util.List-">deleteAllAsync(List<K>)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadWriteTable.html" title="interface in org.apache.samza.table">ReadWriteTable</a></dt> <dd> <div class="block">Asynchronously deletes the mappings for the specified <code>keys</code> from this table.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableWriteFunction.html#deleteAllAsync-java.util.Collection-">deleteAllAsync(Collection<K>)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a></dt> +<dd> +<div class="block">Asynchronously delete all <code>records</code> with the specified <code>keys</code> from the remote store.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/ReadWriteTable.html#deleteAsync-K-">deleteAsync(K)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadWriteTable.html" title="interface in org.apache.samza.table">ReadWriteTable</a></dt> <dd> <div class="block">Asynchronously deletes the mapping for the specified <code>key</code> from this table (if such mapping exists).</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableWriteFunction.html#deleteAsync-K-">deleteAsync(K)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a></dt> +<dd> +<div class="block">Asynchronously delete the <code>record</code> with specified <code>key</code> from the remote store</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/scheduler/CallbackScheduler.html#deleteCallback-K-">deleteCallback(K)</a></span> - Method in interface org.apache.samza.scheduler.<a href="org/apache/samza/scheduler/CallbackScheduler.html" title="interface in org.apache.samza.scheduler">CallbackScheduler</a></dt> <dd> <div class="block">Delete the scheduled <code>callback</code> for the <code>key</code>.</div> @@ -598,6 +670,10 @@ <dd> <div class="block">Describes the inputs, outputs, state, configuration and processing logic using the provided <code>appDescriptor</code>.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/utils/SerdeUtils.html#deserialize-java.lang.String-java.lang.String-">deserialize(String, String)</a></span> - Static method in class org.apache.samza.table.utils.<a href="org/apache/samza/table/utils/SerdeUtils.html" title="class in org.apache.samza.table.utils">SerdeUtils</a></dt> +<dd> +<div class="block">Helper method to deserialize Java objects from Base64 strings</div> +</dd> <dt><a href="org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><span class="typeNameLink">Deserializer</span></a><<a href="org/apache/samza/serializers/Deserializer.html" title="type parameter in Deserializer">T</a>> - Interface in <a href="org/apache/samza/serializers/package-summary.html">org.apache.samza.serializers</a></dt> <dd> <div class="block">A standard interface for Samza compatible deserializers, used for deserializing serialized objects back to their @@ -623,6 +699,8 @@ </a> <h2 class="title">E</h2> <dl> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html#enableChangelog">enableChangelog</a></span> - Variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html" title="class in org.apache.samza.table.descriptors">LocalTableDescriptor</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#END_OF_STREAM_OFFSET">END_OF_STREAM_OFFSET</a></span> - Static variable in class org.apache.samza.system.<a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> <dd> </dd> <dt><a href="org/apache/samza/task/EndOfStreamListenerTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">EndOfStreamListenerTask</span></a> - Interface in <a href="org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> @@ -685,8 +763,6 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/WatermarkMessage.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/WatermarkMessage.html" title="class in org.apache.samza.system">WatermarkMessage</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> -<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/TimestampedValue.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/TimestampedValue.html" title="class in org.apache.samza.util">TimestampedValue</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/sql/udfs/ScalarUdf.html#execute-java.lang.Object...-">execute(Object...)</a></span> - Method in interface org.apache.samza.sql.udfs.<a href="org/apache/samza/sql/udfs/ScalarUdf.html" title="interface in org.apache.samza.sql.udfs">ScalarUdf</a></dt> @@ -698,10 +774,10 @@ <div class="block">Interface for advanced <code>SystemDescriptor</code>s that constrain the type of returned <code>InputDescriptor</code>s to their own <code>StreamExpander</code> function result types.</div> </dd> -<dt><a href="org/apache/samza/system/ExtendedSystemAdmin.html" title="interface in org.apache.samza.system"><span class="typeNameLink">ExtendedSystemAdmin</span></a> - Interface in <a href="org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt> +<dt><a href="org/apache/samza/context/ExternalContext.html" title="interface in org.apache.samza.context"><span class="typeNameLink">ExternalContext</span></a> - Interface in <a href="org/apache/samza/context/package-summary.html">org.apache.samza.context</a></dt> <dd> -<div class="block">Interface extends the more generic SystemAdmin interface - TODO: Merge this interface method with SystemAdmin when we upgrade to JDK 1.8</div> +<div class="block">An <a href="org/apache/samza/context/ExternalContext.html" title="interface in org.apache.samza.context"><code>ExternalContext</code></a> can be used to pass components created and managed outside of Samza into a Samza + application.</div> </dd> </dl> <a name="I:F"> @@ -758,6 +834,10 @@ <dd> <div class="block">Flushes the underlying store of this table, if applicable.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableWriteFunction.html#flush--">flush()</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a></dt> +<dd> +<div class="block">Flush the remote store (optional)</div> +</dd> <dt><a href="org/apache/samza/operators/functions/FoldLeftFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">FoldLeftFunction</span></a><<a href="org/apache/samza/operators/functions/FoldLeftFunction.html" title="type parameter in FoldLeftFunction">M</a>,<a href="org/apache/samza/operators/functions/FoldLeftFunction.html" title="type parameter in FoldLeftFunction">WV</a>> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> <dd> <div class="block">Incrementally updates the aggregated value as messages are added.</div> @@ -803,12 +883,6 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsVisitor.html#gauge-org.apache.samza.metrics.Gauge-">gauge(Gauge<T>)</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/TableProvider.html#generateConfig-org.apache.samza.config.Config-java.util.Map-">generateConfig(Config, Map<String, String>)</a></span> - Method in interface org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/TableProvider.html" title="interface in org.apache.samza.table.descriptors">TableProvider</a></dt> -<dd> -<div class="block">Generate any configuration for this table, the generated configuration - is used by Samza container to construct this table and any components - necessary.</div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/runtime/ProcessorIdGenerator.html#generateProcessorId-org.apache.samza.config.Config-">generateProcessorId(Config)</a></span> - Method in interface org.apache.samza.runtime.<a href="org/apache/samza/runtime/ProcessorIdGenerator.html" title="interface in org.apache.samza.runtime">ProcessorIdGenerator</a></dt> <dd> <div class="block">Generates a String representation to identify a single instance of StreamProcessor.</div> @@ -836,7 +910,7 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#get-java.lang.Object-">get(Object)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/metadatastore/MetadataStore.html#get-byte:A-">get(byte[])</a></span> - Method in interface org.apache.samza.metadatastore.<a href="org/apache/samza/metadatastore/MetadataStore.html" title="interface in org.apache.samza.metadatastore">MetadataStore</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/metadatastore/MetadataStore.html#get-java.lang.String-">get(String)</a></span> - Method in interface org.apache.samza.metadatastore.<a href="org/apache/samza/metadatastore/MetadataStore.html" title="interface in org.apache.samza.metadatastore">MetadataStore</a></dt> <dd> <div class="block">Gets the value associated with the specified <code>key</code>.</div> </dd> @@ -854,6 +928,10 @@ <dd> <div class="block">Gets the value associated with the specified <code>key</code>.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableReadFunction.html#get-K-">get(K)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a></dt> +<dd> +<div class="block">Fetch single table record for a specified <code>key</code>.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getAccumulationMode--">getAccumulationMode()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemFactory.html#getAdmin-java.lang.String-org.apache.samza.config.Config-">getAdmin(String, Config)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> @@ -866,10 +944,22 @@ <dd> <div class="block">Gets the values with which the specified <code>keys</code> are associated.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableReadFunction.html#getAll-java.util.Collection-">getAll(Collection<K>)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a></dt> +<dd> +<div class="block">Fetch the table <code>records</code> for specified <code>keys</code>.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/ReadableTable.html#getAllAsync-java.util.List-">getAllAsync(List<K>)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadableTable.html" title="interface in org.apache.samza.table">ReadableTable</a></dt> <dd> <div class="block">Asynchronously gets the values with which the specified <code>keys</code> are associated.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableReadFunction.html#getAllAsync-java.util.Collection-">getAllAsync(Collection<K>)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a></dt> +<dd> +<div class="block">Asynchronously fetch the table <code>records</code> for specified <code>keys</code>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#getAllSystemStreams--">getAllSystemStreams()</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></dt> +<dd> +<div class="block">Fetch the set of all available streams</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/context/Context.html#getApplicationContainerContext--">getApplicationContainerContext()</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a></dt> <dd> <div class="block">Gets the application-defined context for the current container.</div> @@ -886,10 +976,16 @@ <dd> <div class="block">Asynchronously gets the value associated with the specified <code>key</code>.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableReadFunction.html#getAsync-K-">getAsync(K)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a></dt> +<dd> +<div class="block">Asynchronously fetch single table record for a specified <code>key</code>.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Snapshot.html#getAverage--">getAverage()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> <dd> <div class="block">Get the average of the values in the collection</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getBackoffType--">getBackoffType()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getBoolean-java.lang.String-boolean-">getBoolean(String, boolean)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getBoolean-java.lang.String-">getBoolean(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> @@ -929,10 +1025,6 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getConfig--">getConfig()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#getConfig--">getConfig()</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> -<dd> -<div class="block">Get implementation configuration for the table</div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemFactory.html#getConsumer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getConsumer(String, Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/context/Context.html#getContainerContext--">getContainerContext()</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a></dt> @@ -956,6 +1048,10 @@ <dd> <div class="block">Get the values of a counter</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html#getCredits-K-V-">getCredits(K, V)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableRateLimiter.CreditFunction.html" title="interface in org.apache.samza.table.remote">TableRateLimiter.CreditFunction</a></dt> +<dd> +<div class="block">Get the number of credits required for the <code>key</code> and <code>value</code> pair.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getDate-java.lang.String-">getDate(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getDate-java.lang.String-java.lang.String-">getDate(String, String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> @@ -988,6 +1084,14 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/descriptors/SystemDescriptor.html#getExpander--">getExpander()</a></span> - Method in class org.apache.samza.system.descriptors.<a href="org/apache/samza/system/descriptors/SystemDescriptor.html" title="class in org.apache.samza.system.descriptors">SystemDescriptor</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getExponentialFactor--">getExponentialFactor()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getExponentialMaxSleep--">getExponentialMaxSleep()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/context/Context.html#getExternalContext--">getExternalContext()</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a></dt> +<dd> +<div class="block">Gets the <a href="org/apache/samza/context/ExternalContext.html" title="interface in org.apache.samza.context"><code>ExternalContext</code></a> that was created outside of the application.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/sql/SamzaSqlRelRecord.html#getField-java.lang.String-">getField(String)</a></span> - Method in class org.apache.samza.sql.<a href="org/apache/samza/sql/SamzaSqlRelRecord.html" title="class in org.apache.samza.sql">SamzaSqlRelRecord</a></dt> <dd> <div class="block">Get the value of the field corresponding to the field name.</div> @@ -1008,6 +1112,14 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getFoldLeftFunction--">getFoldLeftFunction()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#getForTable-java.lang.String-java.lang.String-java.lang.String-">getForTable(String, String, String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> +<dd> +<div class="block">Get table config value for a key</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#getForTable-java.lang.String-java.lang.String-">getForTable(String, String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> +<dd> +<div class="block">Get table config value for a key</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsAccessor.html#getGaugeValues-java.lang.String-java.lang.String-">getGaugeValues(String, String)</a></span> - Method in interface org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics">MetricsAccessor</a></dt> <dd> <div class="block">Get the values of a gauge</div> @@ -1024,10 +1136,6 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getId--">getId()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#getId--">getId()</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> -<dd> -<div class="block">Get the Id of the table</div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getInitializer--">getInitializer()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/descriptors/ExpandingInputDescriptorProvider.html#getInputDescriptor-java.lang.String-org.apache.samza.serializers.Serde-">getInputDescriptor(String, Serde)</a></span> - Method in interface org.apache.samza.system.descriptors.<a href="org/apache/samza/system/descriptors/ExpandingInputDescriptorProvider.html" title="interface in org.apache.samza.system.descriptors">ExpandingInputDescriptorProvider</a></dt> @@ -1052,6 +1160,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getInt-java.lang.String-">getInt(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getJitter--">getJitter()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> +<div class="block">Introduce randomness to the sleepTime time.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/StreamJobFactory.html#getJob-org.apache.samza.config.Config-">getJob(Config)</a></span> - Method in interface org.apache.samza.job.<a href="org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job">StreamJobFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/context/Context.html#getJobContext--">getJobContext()</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a></dt> @@ -1080,6 +1192,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getKeyExtractor--">getKeyExtractor()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#getKeySerde-java.lang.String-">getKeySerde(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> +<dd> +<div class="block">Get registry keys of key serde for this table</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getKeySerde--">getKeySerde()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/serializers/KVSerde.html#getKeySerde--">getKeySerde()</a></span> - Method in class org.apache.samza.serializers.<a href="org/apache/samza/serializers/KVSerde.html" title="class in org.apache.samza.serializers">KVSerde</a></dt> @@ -1104,6 +1220,14 @@ <dd> <div class="block">Get the maximum value in the collection</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getMaxAttempts--">getMaxAttempts()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> +<div class="block">Termination after a fix number of attempts.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getMaxDuration--">getMaxDuration()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> +<div class="block">Termination after a fixed duration.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/WindowPane.html#getMessage--">getMessage()</a></span> - Method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows">WindowPane</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#getMessage--">getMessage()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> @@ -1128,6 +1252,10 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getMode--">getMode()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#getMsgSerde-java.lang.String-">getMsgSerde(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> +<dd> +<div class="block">Get registry keys of value serde for this table</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getMsgSerde--">getMsgSerde()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Counter.html#getName--">getName()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></dt> @@ -1142,10 +1270,6 @@ <dd> <div class="block">Get the name of the timer</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/system/ExtendedSystemAdmin.html#getNewestOffset-org.apache.samza.system.SystemStreamPartition-java.lang.Integer-">getNewestOffset(SystemStreamPartition, Integer)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/ExtendedSystemAdmin.html" title="interface in org.apache.samza.system">ExtendedSystemAdmin</a></dt> -<dd> -<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getNewestOffset--">getNewestOffset()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getNewInstance-java.lang.String-">getNewInstance(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> @@ -1200,12 +1324,41 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#getPhysicalName--">getPhysicalName()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/StreamSpec.html" title="class in org.apache.samza.system">StreamSpec</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionMapper.html#getPreviousSSP-org.apache.samza.system.SystemStreamPartition-int-int-">getPreviousSSP(SystemStreamPartition, int, int)</a></span> - Method in interface org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionMapper.html" title="interface in org.apache.samza.container.grouper.stream">SystemStreamPartitionMapper</a></dt> +<dd> +<div class="block">Determines the previous <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a> for a <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a> + of a input stream after the stream expansion or contraction.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/GrouperContext.html#getPreviousTaskToContainerAssignment--">getPreviousTaskToContainerAssignment()</a></span> - Method in class org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/GrouperContext.html" title="class in org.apache.samza.container.grouper.stream">GrouperContext</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/GrouperContext.html#getPreviousTaskToSSPAssignment--">getPreviousTaskToSSPAssignment()</a></span> - Method in class org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/GrouperContext.html" title="class in org.apache.samza.container.grouper.stream">GrouperContext</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/GrouperContext.html#getProcessorIds--">getProcessorIds()</a></span> - Method in class org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/GrouperContext.html" title="class in org.apache.samza.container.grouper.stream">GrouperContext</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/GrouperContext.html#getProcessorLocality--">getProcessorLocality()</a></span> - Method in class org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/GrouperContext.html" title="class in org.apache.samza.container.grouper.stream">GrouperContext</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemFactory.html#getProducer-java.lang.String-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getProducer(String, Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html#getProviderFactoryClassName--">getProviderFactoryClassName()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="class in org.apache.samza.table.descriptors">BaseTableDescriptor</a></dt> +<dd> +<div class="block">Return the fully qualified class name of the <a href="org/apache/samza/table/TableProviderFactory.html" title="interface in org.apache.samza.table"><code>TableProviderFactory</code></a></div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html#getProviderFactoryClassName--">getProviderFactoryClassName()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="class in org.apache.samza.table.descriptors">CachingTableDescriptor</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html#getProviderFactoryClassName--">getProviderFactoryClassName()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html" title="class in org.apache.samza.table.descriptors">GuavaCacheTableDescriptor</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/RemoteTableDescriptor.html#getProviderFactoryClassName--">getProviderFactoryClassName()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/RemoteTableDescriptor.html" title="class in org.apache.samza.table.descriptors">RemoteTableDescriptor</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getRandomMax--">getRandomMax()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getRandomMin--">getRandomMin()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/StreamTableJoinFunction.html#getRecordKey-R-">getRecordKey(R)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/StreamTableJoinFunction.html" title="interface in org.apache.samza.operators.functions">StreamTableJoinFunction</a></dt> <dd> <div class="block">Retrieve the join key from table record</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getRetryPredicate--">getRetryPredicate()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/functions/JoinFunction.html#getSecondKey-JM-">getSecondKey(JM)</a></span> - Method in interface org.apache.samza.operators.functions.<a href="org/apache/samza/operators/functions/JoinFunction.html" title="interface in org.apache.samza.operators.functions">JoinFunction</a></dt> <dd> <div class="block">Get the join key for messages in the second input stream.</div> @@ -1232,32 +1385,30 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/descriptors/StreamDescriptor.html#getSerde--">getSerde()</a></span> - Method in class org.apache.samza.system.descriptors.<a href="org/apache/samza/system/descriptors/StreamDescriptor.html" title="class in org.apache.samza.system.descriptors">StreamDescriptor</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#getSerde--">getSerde()</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html#getSerde--">getSerde()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html" title="class in org.apache.samza.table.descriptors">LocalTableDescriptor</a></dt> <dd> -<div class="block">Get the serde</div> +<div class="block">Get the serde assigned to this <a href="org/apache/samza/table/descriptors/TableDescriptor.html" title="interface in org.apache.samza.table.descriptors"><code>TableDescriptor</code></a></div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getShort-java.lang.String-short-">getShort(String, short)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getShort-java.lang.String-">getShort(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#getSideInputs--">getSideInputs()</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html#getSideInputs--">getSideInputs()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/LocalTableDescriptor.html" title="class in org.apache.samza.table.descriptors">LocalTableDescriptor</a></dt> <dd> -<div class="block">Get the list of side inputs for the table.</div> +<div class="block">Get side input stream names</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/SideInputsProcessorFactory.html#getSideInputsProcessor-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getSideInputsProcessor(Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/SideInputsProcessorFactory.html" title="interface in org.apache.samza.storage">SideInputsProcessorFactory</a></dt> <dd> <div class="block">Creates a new instance of a <a href="org/apache/samza/storage/SideInputsProcessor.html" title="interface in org.apache.samza.storage"><code>SideInputsProcessor</code></a>.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#getSideInputsProcessor--">getSideInputsProcessor()</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> -<dd> -<div class="block">Get the <a href="org/apache/samza/storage/SideInputsProcessor.html" title="interface in org.apache.samza.storage"><code>SideInputsProcessor</code></a> associated with the table.</div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Snapshot.html#getSize--">getSize()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> <dd> <div class="block">Get the number of values in the collection</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#getSize--">getSize()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/retry/TableRetryPolicy.html#getSleepTime--">getSleepTime()</a></span> - Method in class org.apache.samza.table.retry.<a href="org/apache/samza/table/retry/TableRetryPolicy.html" title="class in org.apache.samza.table.retry">TableRetryPolicy</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Reservoir.html#getSnapshot--">getSnapshot()</a></span> - Method in interface org.apache.samza.metrics.<a href="org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></dt> <dd> <div class="block">Return a <a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a> of this reservoir</div> @@ -1296,6 +1447,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamMetadata.html#getStreamName--">getStreamName()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionMapperFactory.html#getStreamPartitionMapper-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getStreamPartitionMapper(Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionMapperFactory.html" title="interface in org.apache.samza.container.grouper.stream">SystemStreamPartitionMapperFactory</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Snapshot.html#getSum--">getSum()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></dt> <dd> <div class="block">Get the sum of values in the collection</div> @@ -1326,8 +1479,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#getSystemStreamPartition--">getSystemStreamPartition()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/system/ExtendedSystemAdmin.html#getSystemStreamPartitionCounts-java.util.Set-long-">getSystemStreamPartitionCounts(Set<String>, long)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/ExtendedSystemAdmin.html" title="interface in org.apache.samza.system">ExtendedSystemAdmin</a></dt> -<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#getSystemStreamPartitionCounts-java.util.Set-long-">getSystemStreamPartitionCounts(Set<String>, long)</a></span> - Method in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></dt> +<dd> +<div class="block">Get partitions counts only.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouperFactory.html#getSystemStreamPartitionGrouper-org.apache.samza.config.Config-">getSystemStreamPartitionGrouper(Config)</a></span> - Method in interface org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouperFactory.html" title="interface in org.apache.samza.container.grouper.stream">SystemStreamPartitionGrouperFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamMetadata.html#getSystemStreamPartitionMetadata--">getSystemStreamPartitionMetadata()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dt> @@ -1344,26 +1499,42 @@ <dd> <div class="block">Gets the <a href="org/apache/samza/table/Table.html" title="interface in org.apache.samza.table"><code>Table</code></a> corresponding to the <code>tableId</code> for this task.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/TableProvider.html#getTable--">getTable()</a></span> - Method in interface org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/TableProvider.html" title="interface in org.apache.samza.table.descriptors">TableProvider</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableProvider.html#getTable--">getTable()</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/TableProvider.html" title="interface in org.apache.samza.table">TableProvider</a></dt> <dd> <div class="block">Get an instance of the table for read/write operations</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html#getTableDescriptors--">getTableDescriptors()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/CachingTableDescriptor.html" title="class in org.apache.samza.table.descriptors">CachingTableDescriptor</a></dt> +<dd> +<div class="block">Retrieve user-defined table descriptors contained in this table</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html#getTableDescriptors--">getTableDescriptors()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="class in org.apache.samza.table.descriptors">HybridTableDescriptor</a></dt> +<dd> +<div class="block">Get tables contained within this table.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html#getTableId--">getTableId()</a></span> - Method in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/BaseTableDescriptor.html" title="class in org.apache.samza.table.descriptors">BaseTableDescriptor</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/TableDescriptor.html#getTableId--">getTableId()</a></span> - Method in interface org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/TableDescriptor.html" title="interface in org.apache.samza.table.descriptors">TableDescriptor</a></dt> <dd> <div class="block">Get the id of the table</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/TableProviderFactory.html#getTableProvider-org.apache.samza.table.TableSpec-">getTableProvider(TableSpec)</a></span> - Method in interface org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/TableProviderFactory.html" title="interface in org.apache.samza.table.descriptors">TableProviderFactory</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#getTableIds--">getTableIds()</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> <dd> -<div class="block">Constructs an instances of the table provider based on a given table spec</div> +<div class="block">Get Id's of all tables</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#getTableProviderFactoryClassName--">getTableProviderFactoryClassName()</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableProviderFactory.html#getTableProvider-java.lang.String-">getTableProvider(String)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/TableProviderFactory.html" title="interface in org.apache.samza.table">TableProviderFactory</a></dt> <dd> -<div class="block">Get the class name of the table provider factory</div> +<div class="block">Construct a table provider based on job configuration</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#getTableProviderFactory-java.lang.String-">getTableProviderFactory(String)</a></span> - Method in class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> +<dd> +<div class="block">Get the <a href="org/apache/samza/table/TableProviderFactory.html" title="interface in org.apache.samza.table"><code>TableProviderFactory</code></a> class name for a table</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/context/Context.html#getTaskContext--">getTaskContext()</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/Context.html" title="interface in org.apache.samza.context">Context</a></dt> <dd> <div class="block">Gets the framework-provided context for the current task.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/GrouperContext.html#getTaskLocality--">getTaskLocality()</a></span> - Method in class org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/GrouperContext.html" title="class in org.apache.samza.container.grouper.stream">GrouperContext</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/context/TaskContext.html#getTaskMetricsRegistry--">getTaskMetricsRegistry()</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/TaskContext.html" title="interface in org.apache.samza.context">TaskContext</a></dt> <dd> <div class="block">Gets the <a href="org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> for this task, which can be used to register metrics that are reported per task.</div> @@ -1435,7 +1606,27 @@ <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getWindowValSerde--">getWindowValSerde()</a></span> - Method in class org.apache.samza.operators.windows.internal.<a href="org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html#group-java.util.Set-">group(Set<SystemStreamPartition>)</a></span> - Method in interface org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html" title="interface in org.apache.samza.container.grouper.stream">SystemStreamPartitionGrouper</a></dt> +<dd> +<div class="block">Groups the input systemStreamPartitions into the logical taskNames.</div> +</dd> +<dt><a href="org/apache/samza/container/grouper/stream/GrouperContext.html" title="class in org.apache.samza.container.grouper.stream"><span class="typeNameLink">GrouperContext</span></a> - Class in <a href="org/apache/samza/container/grouper/stream/package-summary.html">org.apache.samza.container.grouper.stream</a></dt> +<dd> +<div class="block">A Wrapper class that holds the necessary historical metadata of the samza job which is used + by the <a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html" title="interface in org.apache.samza.container.grouper.stream"><code>SystemStreamPartitionGrouper</code></a> + to generate optimal task assignments.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/container/grouper/stream/GrouperContext.html#GrouperContext-java.util.Map-java.util.Map-java.util.Map-java.util.Map-">GrouperContext(Map<String, LocationId>, Map<TaskName, LocationId>, Map<TaskName, Set<SystemStreamPartition>>, Map<TaskName, String>)</a></span> - Constructor for class org.apache.samza.container.grouper.stream.<a href="org/apache/samza/container/grouper/stream/GrouperContext.html" title="class in org.apache.samza.container.grouper.stream">GrouperContext</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html#GUAVA_CACHE">GUAVA_CACHE</a></span> - Static variable in class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html" title="class in org.apache.samza.table.descriptors">GuavaCacheTableDescriptor</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html" title="class in org.apache.samza.table.descriptors"><span class="typeNameLink">GuavaCacheTableDescriptor</span></a><<a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html" title="type parameter in GuavaCacheTableDescriptor">K</a>,<a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html" title="type parameter in GuavaCacheTableDescriptor">V</a>> - Class in <a href="org/apache/samza/table/descriptors/package-summary.html">org.apache.samza.table.descriptors</a></dt> +<dd> +<div class="block">Table descriptor for Guava-based caching table.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html#GuavaCacheTableDescriptor-java.lang.String-">GuavaCacheTableDescriptor(String)</a></span> - Constructor for class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/GuavaCacheTableDescriptor.html" title="class in org.apache.samza.table.descriptors">GuavaCacheTableDescriptor</a></dt> +<dd> +<div class="block">Constructs a table descriptor instance</div> +</dd> </dl> <a name="I:H"> <!-- --> @@ -1482,12 +1673,18 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/WatermarkMessage.html#hashCode--">hashCode()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/WatermarkMessage.html" title="class in org.apache.samza.system">WatermarkMessage</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableSpec.html#hashCode--">hashCode()</a></span> - Method in class org.apache.samza.table.<a href="org/apache/samza/table/TableSpec.html" title="class in org.apache.samza.table">TableSpec</a></dt> -<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/TimestampedValue.html#hashCode--">hashCode()</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/TimestampedValue.html" title="class in org.apache.samza.util">TimestampedValue</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamPartitionIterator.html#hasNext--">hasNext()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></dt> <dd> </dd> +<dt><a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="class in org.apache.samza.table.descriptors"><span class="typeNameLink">HybridTableDescriptor</span></a><<a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="type parameter in HybridTableDescriptor">K</a>,<a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="type parameter in HybridTableDescriptor">V</a>,<a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="type parameter in HybridTableDescriptor">D</a> extends <a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="class in org.apache.samza.table.descriptors">HybridTableDescriptor</a><<a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="type parameter in HybridTableDescriptor">K</a>,<a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="type parameter in HybridTableDescriptor">V</a>,<a href="org/ap ache/samza/table/descriptors/HybridTableDescriptor.html" title="type parameter in HybridTableDescriptor">D</a>>> - Class in <a href="org/apache/samza/table/descriptors/package-summary.html">org.apache.samza.table.descriptors</a></dt> +<dd> +<div class="block">Base class for hybrid table descriptors.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html#HybridTableDescriptor-java.lang.String-">HybridTableDescriptor(String)</a></span> - Constructor for class org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/HybridTableDescriptor.html" title="class in org.apache.samza.table.descriptors">HybridTableDescriptor</a></dt> +<dd> +<div class="block">Constructs a table descriptor instance</div> +</dd> </dl> <a name="I:I"> <!-- --> @@ -1536,14 +1733,14 @@ <dd> <div class="block">Udfs can implement this method to perform any initialization that they may need.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/TableProvider.html#init-org.apache.samza.context.Context-">init(Context)</a></span> - Method in interface org.apache.samza.table.descriptors.<a href="org/apache/samza/table/descriptors/TableProvider.html" title="interface in org.apache.samza.table.descriptors">TableProvider</a></dt> -<dd> -<div class="block">Initialize TableProvider with container and task context</div> -</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/ReadableTable.html#init-org.apache.samza.context.Context-">init(Context)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadableTable.html" title="interface in org.apache.samza.table">ReadableTable</a></dt> <dd> <div class="block">Initializes the table during container initialization.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/TableProvider.html#init-org.apache.samza.context.Context-">init(Context)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/TableProvider.html" title="interface in org.apache.samza.table">TableProvider</a></dt> +<dd> +<div class="block">Initialize TableProvider with container and task context</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/task/InitableTask.html#init-org.apache.samza.context.Context-">init(Context)</a></span> - Method in interface org.apache.samza.task.<a href="org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task">InitableTask</a></dt> <dd> <div class="block">Called by TaskRunner each time an implementing task is created.</div> @@ -1629,6 +1826,16 @@ <dd> <div class="block">Flag to indicate whether a store can be persisted to disk or not</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableRateLimiter.html#isRateLimited--">isRateLimited()</a></span> - Method in class org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableRateLimiter.html" title="class in org.apache.samza.table.remote">TableRateLimiter</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableReadFunction.html#isRetriable-java.lang.Throwable-">isRetriable(Throwable)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableReadFunction.html" title="interface in org.apache.samza.table.remote">TableReadFunction</a></dt> +<dd> +<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/TableWriteFunction.html#isRetriable-java.lang.Throwable-">isRetriable(Throwable)</a></span> - Method in interface org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/TableWriteFunction.html" title="interface in org.apache.samza.table.remote">TableWriteFunction</a></dt> +<dd> +<div class="block">Determine whether the current operation can be retried with the last thrown exception.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueSnapshot.html#iterator--">iterator()</a></span> - Method in interface org.apache.samza.storage.kv.<a href="org/apache/samza/storage/kv/KeyValueSnapshot.html" title="interface in org.apache.samza.storage.kv">KeyValueSnapshot</a></dt> <dd> <div class="block">Creates a new iterator for this snapshot.</div> @@ -1639,6 +1846,12 @@ </a> <h2 class="title">J</h2> <dl> +<dt><a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config"><span class="typeNameLink">JavaTableConfig</span></a> - Class in <a href="org/apache/samza/config/package-summary.html">org.apache.samza.config</a></dt> +<dd> +<div class="block">A helper class for handling table configuration</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/config/JavaTableConfig.html#JavaTableConfig-java.util.Map-">JavaTableConfig(Map<String, String>)</a></span> - Constructor for class org.apache.samza.config.<a href="org/apache/samza/config/JavaTableConfig.html" title="class in org.apache.samza.config">JavaTableConfig</a></dt> +<dd> </dd> <dt><a href="org/apache/samza/context/JobContext.html" title="interface in org.apache.samza.context"><span class="typeNameLink">JobContext</span></a> - Interface in <a href="org/apache/samza/context/package-summary.html">org.apache.samza.context</a></dt> <dd> <div class="block">The framework-provided context for the job.</div> @@ -1761,6 +1974,14 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsVisitor.html#listGauge-org.apache.samza.metrics.ListGauge-">listGauge(ListGauge<T>)</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></dt> <dd> </dd>
[... 559 lines stripped ...]