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=1906774&r1=1906773&r2=1906774&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/index-all.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/index-all.html Wed Jan 18 19:33:25 2023 @@ -2,9 +2,8 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_212) on Thu Feb 04 10:07:15 PST 2021 --> -<title>Index (samza-api 1.7.0-SNAPSHOT API)</title> -<meta name="date" content="2021-02-04"> +<!-- Generated by javadoc --> +<title>Index (samza-api 1.9.0-SNAPSHOT API)</title> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> </head> @@ -12,7 +11,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Index (samza-api 1.7.0-SNAPSHOT API)"; + parent.document.title="Index (samza-api 1.9.0-SNAPSHOT API)"; } } catch(err) { @@ -99,7 +98,7 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/sql/schema/SqlSchemaBuilder.html#addField-java.lang.String-org.apache.samza.sql.schema.SqlFieldSchema-">addField(String, SqlFieldSchema)</a></span> - Method in class org.apache.samza.sql.schema.<a href="org/apache/samza/sql/schema/SqlSchemaBuilder.html" title="class in org.apache.samza.sql.schema">SqlSchemaBuilder</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/batching/Batch.html#addOperation-org.apache.samza.table.batching.Operation-">addOperation(Operation<K, V>)</a></span> - Method in interface org.apache.samza.table.batching.<a href="org/apache/samza/table/batching/Batch.html" title="interface in org.apache.samza.table.batching">Batch</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/batching/Batch.html#addOperation-org.apache.samza.table.batching.Operation-">addOperation(Operation<K, V, U>)</a></span> - Method in interface org.apache.samza.table.batching.<a href="org/apache/samza/table/batching/Batch.html" title="interface in org.apache.samza.table.batching">Batch</a></dt> <dd> <div class="block">Add an operation to the batch.</div> </dd> @@ -151,6 +150,10 @@ <dd> <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> fires as soon as any of its individual triggers has fired.</div> </dd> +<dt><a href="org/apache/samza/application/ApplicationApiType.html" title="enum in org.apache.samza.application"><span class="typeNameLink">ApplicationApiType</span></a> - Enum in <a href="org/apache/samza/application/package-summary.html">org.apache.samza.application</a></dt> +<dd> +<div class="block">Enum to denote the possible API types for a samza application.</div> +</dd> <dt><a href="org/apache/samza/context/ApplicationContainerContext.html" title="interface in org.apache.samza.context"><span class="typeNameLink">ApplicationContainerContext</span></a> - Interface in <a href="org/apache/samza/context/package-summary.html">org.apache.samza.context</a></dt> <dd> <div class="block">An <a href="org/apache/samza/context/ApplicationContainerContext.html" title="interface in org.apache.samza.context"><code>ApplicationContainerContext</code></a> instance can be used for holding per-container runtime state and objects and @@ -249,9 +252,9 @@ <div class="block">Asynchronous variant of the <a href="org/apache/samza/operators/functions/FlatMapFunction.html" title="interface in org.apache.samza.operators.functions"><code>FlatMapFunction</code></a> used in tandem with <a href="org/apache/samza/operators/MessageStream.html#flatMapAsync-org.apache.samza.operators.functions.AsyncFlatMapFunction-"><code>MessageStream.flatMapAsync(AsyncFlatMapFunction)</code></a> to transform a collection of 0 or more messages.</div> </dd> -<dt><a href="org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table"><span class="typeNameLink">AsyncReadWriteTable</span></a><<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="type parameter in AsyncReadWriteTable">K</a>,<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="type parameter in AsyncReadWriteTable">V</a>> - Interface in <a href="org/apache/samza/table/package-summary.html">org.apache.samza.table</a></dt> +<dt><a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="interface in org.apache.samza.table"><span class="typeNameLink">AsyncReadWriteUpdateTable</span></a><<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="type parameter in AsyncReadWriteUpdateTable">K</a>,<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="type parameter in AsyncReadWriteUpdateTable">V</a>,<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="type parameter in AsyncReadWriteUpdateTable">U</a>> - Interface in <a href="org/apache/samza/table/package-summary.html">org.apache.samza.table</a></dt> <dd> -<div class="block">A table that supports asynchronous get, put and delete by one or more keys</div> +<div class="block">A table that supports asynchronous get, put, update and delete by one or more keys</div> </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> @@ -288,13 +291,13 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/remote/BaseTableFunction.html#BaseTableFunction--">BaseTableFunction()</a></span> - Constructor for class org.apache.samza.table.remote.<a href="org/apache/samza/table/remote/BaseTableFunction.html" title="class in org.apache.samza.table.remote">BaseTableFunction</a></dt> <dd> </dd> -<dt><a href="org/apache/samza/table/batching/Batch.html" title="interface in org.apache.samza.table.batching"><span class="typeNameLink">Batch</span></a><<a href="org/apache/samza/table/batching/Batch.html" title="type parameter in Batch">K</a>,<a href="org/apache/samza/table/batching/Batch.html" title="type parameter in Batch">V</a>> - Interface in <a href="org/apache/samza/table/batching/package-summary.html">org.apache.samza.table.batching</a></dt> +<dt><a href="org/apache/samza/table/batching/Batch.html" title="interface in org.apache.samza.table.batching"><span class="typeNameLink">Batch</span></a><<a href="org/apache/samza/table/batching/Batch.html" title="type parameter in Batch">K</a>,<a href="org/apache/samza/table/batching/Batch.html" title="type parameter in Batch">V</a>,<a href="org/apache/samza/table/batching/Batch.html" title="type parameter in Batch">U</a>> - Interface in <a href="org/apache/samza/table/batching/package-summary.html">org.apache.samza.table.batching</a></dt> <dd> <div class="block">Manages a sequence of <a href="org/apache/samza/table/batching/Operation.html" title="interface in org.apache.samza.table.batching"><code>Operation</code></a>s, which will be performed as a batch.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/descriptors/RemoteTableDescriptor.html#BATCH_PROVIDER">BATCH_PROVIDER</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/table/batching/BatchProvider.html" title="class in org.apache.samza.table.batching"><span class="typeNameLink">BatchProvider</span></a><<a href="org/apache/samza/table/batching/BatchProvider.html" title="type parameter in BatchProvider">K</a>,<a href="org/apache/samza/table/batching/BatchProvider.html" title="type parameter in BatchProvider">V</a>> - Class in <a href="org/apache/samza/table/batching/package-summary.html">org.apache.samza.table.batching</a></dt> +<dt><a href="org/apache/samza/table/batching/BatchProvider.html" title="class in org.apache.samza.table.batching"><span class="typeNameLink">BatchProvider</span></a><<a href="org/apache/samza/table/batching/BatchProvider.html" title="type parameter in BatchProvider">K</a>,<a href="org/apache/samza/table/batching/BatchProvider.html" title="type parameter in BatchProvider">V</a>,<a href="org/apache/samza/table/batching/BatchProvider.html" title="type parameter in BatchProvider">U</a>> - Class in <a href="org/apache/samza/table/batching/package-summary.html">org.apache.samza.table.batching</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/batching/BatchProvider.html#BatchProvider--">BatchProvider()</a></span> - Constructor for class org.apache.samza.table.batching.<a href="org/apache/samza/table/batching/BatchProvider.html" title="class in org.apache.samza.table.batching">BatchProvider</a></dt> <dd> </dd> @@ -306,6 +309,17 @@ <dd> <div class="block">User defined initialization before a StreamProcessor is started</div> </dd> +<dt><a href="org/apache/samza/storage/BlobStoreAdminFactory.html" title="interface in org.apache.samza.storage"><span class="typeNameLink">BlobStoreAdminFactory</span></a> - Interface in <a href="org/apache/samza/storage/package-summary.html">org.apache.samza.storage</a></dt> +<dd> +<div class="block">Factory to create instance of <a href="org/apache/samza/storage/StateBackendAdmin.html" title="interface in org.apache.samza.storage"><code>StateBackendAdmin</code></a>s that needs to be implemented for every + state backend</div> +</dd> +<dt><a href="org/apache/samza/storage/blobstore/BlobStoreManager.html" title="interface in org.apache.samza.storage.blobstore"><span class="typeNameLink">BlobStoreManager</span></a> - Interface in <a href="org/apache/samza/storage/blobstore/package-summary.html">org.apache.samza.storage.blobstore</a></dt> +<dd> +<div class="block">Provides interface for common blob store operations: GET, PUT and DELETE</div> +</dd> +<dt><a href="org/apache/samza/storage/blobstore/BlobStoreManagerFactory.html" title="interface in org.apache.samza.storage.blobstore"><span class="typeNameLink">BlobStoreManagerFactory</span></a> - Interface in <a href="org/apache/samza/storage/blobstore/package-summary.html">org.apache.samza.storage.blobstore</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></span> - Static variable in interface org.apache.samza.system.<a href="org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></dt> <dd> <div class="block">A constant that can be used in the poll method's timeout parameter to @@ -350,12 +364,16 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/BlockingEnvelopeMap.BufferSizeGauge.html#BufferSizeGauge-org.apache.samza.system.SystemStreamPartition-java.lang.String-">BufferSizeGauge(SystemStreamPartition, String)</a></span> - Constructor for class org.apache.samza.util.<a href="org/apache/samza/util/BlockingEnvelopeMap.BufferSizeGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferSizeGauge</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/coordinator/lifecycle/JobRestartSignalFactory.html#build-org.apache.samza.coordinator.lifecycle.JobRestartSignalFactoryContext-">build(JobRestartSignalFactoryContext)</a></span> - Method in interface org.apache.samza.coordinator.lifecycle.<a href="org/apache/samza/coordinator/lifecycle/JobRestartSignalFactory.html" title="interface in org.apache.samza.coordinator.lifecycle">JobRestartSignalFactory</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/sql/schema/SqlSchemaBuilder.html#build--">build()</a></span> - Method in class org.apache.samza.sql.schema.<a href="org/apache/samza/sql/schema/SqlSchemaBuilder.html" title="class in org.apache.samza.sql.schema">SqlSchemaBuilder</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/StoreProperties.StorePropertiesBuilder.html#build--">build()</a></span> - Method in class org.apache.samza.storage.<a href="org/apache/samza/storage/StoreProperties.StorePropertiesBuilder.html" title="class in org.apache.samza.storage">StoreProperties.StorePropertiesBuilder</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/CommandBuilder.html#buildCommand--">buildCommand()</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/system/IncomingMessageEnvelope.html#buildDrainMessage-org.apache.samza.system.SystemStreamPartition-java.lang.String-">buildDrainMessage(SystemStreamPartition, String)</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><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#buildEndOfStreamEnvelope-org.apache.samza.system.SystemStreamPartition-">buildEndOfStreamEnvelope(SystemStreamPartition)</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> <div class="block">This method is deprecated in favor of WatermarkManager.buildEndOfStreamEnvelope(SystemStreamPartition ssp).</div> @@ -432,14 +450,8 @@ <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> -</dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/Checkpoint.html#Checkpoint-java.util.Map-">Checkpoint(Map<SystemStreamPartition, String>)</a></span> - Constructor for class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> -<dd> -<div class="block">Constructs a new checkpoint based off a map of Samza stream offsets.</div> -</dd> +<dt><a href="org/apache/samza/checkpoint/Checkpoint.html" title="interface in org.apache.samza.checkpoint"><span class="typeNameLink">Checkpoint</span></a> - Interface in <a href="org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueStore.html#checkpoint-org.apache.samza.checkpoint.CheckpointId-">checkpoint(CheckpointId)</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">Create a persistent checkpoint / snapshot of the current store state and return it's path.</div> @@ -448,18 +460,14 @@ <dd> <div class="block">Checkpoint store snapshots.</div> </dd> -<dt><a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html" title="class in org.apache.samza.checkpoint"><span class="typeNameLink">CheckpointedChangelogOffset</span></a> - Class in <a href="org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> -<dd> -<div class="block">Checkpointed changelog offset has the format: [checkpointId, offset], separated by a colon.</div> -</dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html#CheckpointedChangelogOffset-org.apache.samza.checkpoint.CheckpointId-java.lang.String-">CheckpointedChangelogOffset(CheckpointId, String)</a></span> - Constructor for class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html" title="class in org.apache.samza.checkpoint">CheckpointedChangelogOffset</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV1.html#CHECKPOINT_VERSION">CHECKPOINT_VERSION</a></span> - Static variable in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV1.html" title="class in org.apache.samza.checkpoint">CheckpointV1</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV2.html#CHECKPOINT_VERSION">CHECKPOINT_VERSION</a></span> - Static variable in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV2.html" title="class in org.apache.samza.checkpoint">CheckpointV2</a></dt> <dd> </dd> <dt><a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint"><span class="typeNameLink">CheckpointId</span></a> - Class in <a href="org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> <dd> <div class="block">Checkpoint ID has the format: [currentTimeMillis, last 6 digits of nanotime], separated by a dash.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointId.html#CheckpointId-long-long-">CheckpointId(long, long)</a></span> - Constructor for class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> -<dd> </dd> <dt><a href="org/apache/samza/checkpoint/CheckpointListener.html" title="interface in org.apache.samza.checkpoint"><span class="typeNameLink">CheckpointListener</span></a> - Interface in <a href="org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> <dd> <div class="block">SystemConsumers that want to be notified about checkpoints for their SSPs and potentially modify them may @@ -467,18 +475,39 @@ </dd> <dt><a href="org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><span class="typeNameLink">CheckpointManager</span></a> - Interface in <a href="org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> <dd> -<div class="block">CheckpointManagers read and write <a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint"><code>Checkpoint</code></a> to some +<div class="block">CheckpointManagers read and write <a href="org/apache/samza/checkpoint/Checkpoint.html" title="interface in org.apache.samza.checkpoint"><code>Checkpoint</code></a> to some implementation-specific location.</div> </dd> <dt><a href="org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint"><span class="typeNameLink">CheckpointManagerFactory</span></a> - Interface in <a href="org/apache/samza/checkpoint/package-summary.html">org.apache.samza.checkpoint</a></dt> <dd> <div class="block">Build a <a href="org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>.</div> </dd> +<dt><a href="org/apache/samza/checkpoint/CheckpointV1.html" title="class in org.apache.samza.checkpoint"><span class="typeNameLink">CheckpointV1</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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV1.html#CheckpointV1-java.util.Map-">CheckpointV1(Map<SystemStreamPartition, String>)</a></span> - Constructor for class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV1.html" title="class in org.apache.samza.checkpoint">CheckpointV1</a></dt> +<dd> +<div class="block">Constructs a new checkpoint based off a map of Samza stream offsets.</div> +</dd> +<dt><a href="org/apache/samza/checkpoint/CheckpointV2.html" title="class in org.apache.samza.checkpoint"><span class="typeNameLink">CheckpointV2</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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV2.html#CheckpointV2-org.apache.samza.checkpoint.CheckpointId-java.util.Map-java.util.Map-">CheckpointV2(CheckpointId, Map<SystemStreamPartition, String>, Map<String, Map<String, String>>)</a></span> - Constructor for class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV2.html" title="class in org.apache.samza.checkpoint">CheckpointV2</a></dt> +<dd> +<div class="block">Constructs the checkpoint with separated input and state offsets</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/chooser/MessageChooser.html#choose--">choose()</a></span> - Method in interface org.apache.samza.system.chooser.<a href="org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></dt> <dd> <div class="block">The choose method is invoked when the SamzaContainer is ready to process a new message.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/TaskBackupManager.html#cleanUp-org.apache.samza.checkpoint.CheckpointId-java.util.Map-">cleanUp(CheckpointId, Map<String, String>)</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/TaskBackupManager.html" title="interface in org.apache.samza.storage">TaskBackupManager</a></dt> +<dd> +<div class="block">Cleanup any local or remote state for checkpoint information that is older than the provided checkpointId + This operation is required to be idempotent.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#clear--">clear()</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/metrics/Counter.html#clear--">clear()</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> @@ -493,7 +522,8 @@ </dd> <dt><a href="org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="typeNameLink">Clock</span></a> - Interface in <a href="org/apache/samza/util/package-summary.html">org.apache.samza.util</a></dt> <dd> -<div class="block">Mockable interface for tracking time.</div> +<div class="block">An object that can provide time points (useful for getting the elapsed time between two time + points).</div> </dd> <dt><a href="org/apache/samza/operators/functions/ClosableFunction.html" title="interface in org.apache.samza.operators.functions"><span class="typeNameLink">ClosableFunction</span></a> - Interface in <a href="org/apache/samza/operators/functions/package-summary.html">org.apache.samza.operators.functions</a></dt> <dd> @@ -518,6 +548,10 @@ <dd> <div class="block">Frees any resource acquired by the operators in <a href="org/apache/samza/operators/functions/InitableFunction.html" title="interface in org.apache.samza.operators.functions"><code>InitableFunction</code></a></div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/BlobStoreManager.html#close--">close()</a></span> - Method in interface org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/BlobStoreManager.html" title="interface in org.apache.samza.storage.blobstore">BlobStoreManager</a></dt> +<dd> +<div class="block">Cleanly close resources like blob store client</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/ClosableIterator.html#close--">close()</a></span> - Method in interface org.apache.samza.storage.kv.<a href="org/apache/samza/storage/kv/ClosableIterator.html" title="interface in org.apache.samza.storage.kv">ClosableIterator</a></dt> <dd> <div class="block">Closes this iterator and frees resources assigned to it.</div> @@ -532,7 +566,15 @@ <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/AsyncReadWriteTable.html#close--">close()</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/TaskBackupManager.html#close--">close()</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/TaskBackupManager.html" title="interface in org.apache.samza.storage">TaskBackupManager</a></dt> +<dd> +<div class="block">Shutdown hook the backup manager to cleanup any allocated resources</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/TaskRestoreManager.html#close--">close()</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/TaskRestoreManager.html" title="interface in org.apache.samza.storage">TaskRestoreManager</a></dt> +<dd> +<div class="block">Closes all initiated resources include storage engines</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html#close--">close()</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="interface in org.apache.samza.table">AsyncReadWriteUpdateTable</a></dt> <dd> <div class="block">Close the table and release any resources acquired</div> </dd> @@ -564,6 +606,8 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/metrics/Gauge.html#compareAndSet-T-T-">compareAndSet(T, T)</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointId.html#compareTo-org.apache.samza.checkpoint.CheckpointId-">compareTo(CheckpointId)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/container/TaskName.html#compareTo-org.apache.samza.container.TaskName-">compareTo(TaskName)</a></span> - Method in class org.apache.samza.container.<a href="org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/model/TaskModel.html#compareTo-org.apache.samza.job.model.TaskModel-">compareTo(TaskModel)</a></span> - Method in class org.apache.samza.job.model.<a href="org/apache/samza/job/model/TaskModel.html" title="class in org.apache.samza.job.model">TaskModel</a></dt> @@ -729,6 +773,10 @@ <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/drain/DrainNotification.html#create-java.util.UUID-java.lang.String-">create(UUID, String)</a></span> - Static method in class org.apache.samza.drain.<a href="org/apache/samza/drain/DrainNotification.html" title="class in org.apache.samza.drain">DrainNotification</a></dt> +<dd> +<div class="block">Creates a DrainNotification in <a href="org/apache/samza/drain/DrainMode.html#DEFAULT"><code>DrainMode.DEFAULT</code></a> mode.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/sql/schema/SqlFieldSchema.html#createArraySchema-org.apache.samza.sql.schema.SqlFieldSchema-boolean-boolean-">createArraySchema(SqlFieldSchema, boolean, boolean)</a></span> - Static method in class org.apache.samza.sql.schema.<a href="org/apache/samza/sql/schema/SqlFieldSchema.html" title="class in org.apache.samza.sql.schema">SqlFieldSchema</a></dt> <dd> </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> @@ -755,6 +803,10 @@ <dd> <div class="block">Creates checkpoint stream.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/StateBackendAdmin.html#createResources--">createResources()</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/StateBackendAdmin.html" title="interface in org.apache.samza.storage">StateBackendAdmin</a></dt> +<dd> +<div class="block">Create all the resources required per job per store state backend</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/sql/schema/SqlFieldSchema.html#createRowFieldSchema-org.apache.samza.sql.schema.SqlSchema-boolean-boolean-">createRowFieldSchema(SqlSchema, boolean, boolean)</a></span> - Static method in class org.apache.samza.sql.schema.<a href="org/apache/samza/sql/schema/SqlFieldSchema.html" title="class in org.apache.samza.sql.schema">SqlFieldSchema</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#createStream-org.apache.samza.system.StreamSpec-">createStream(StreamSpec)</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> @@ -764,7 +816,10 @@ <dt><span class="memberNameLink"><a href="org/apache/samza/system/StreamSpec.html#createStreamAppenderStreamSpec-java.lang.String-java.lang.String-int-">createStreamAppenderStreamSpec(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/util/Clock.html#currentTimeMillis--">currentTimeMillis()</a></span> - Method in interface org.apache.samza.util.<a href="org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a></dt> -<dd> </dd> +<dd> +<div class="block">Returns a time point that can be used to calculate the difference in milliseconds with another + time point.</div> +</dd> </dl> <a name="I:D"> <!-- --> @@ -787,6 +842,10 @@ <dd> <div class="block">Delete the scheduled callback for the provided <code>key</code>.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/BlobStoreManager.html#delete-java.lang.String-org.apache.samza.storage.blobstore.Metadata-">delete(String, Metadata)</a></span> - Method in interface org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/BlobStoreManager.html" title="interface in org.apache.samza.storage.blobstore">BlobStoreManager</a></dt> +<dd> +<div class="block">Non-blocking call to mark a blob for deletion in the remote blob store</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueStore.html#delete-K-">delete(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 mapping for the specified <code>key</code> from this key-value store (if such mapping exists).</div> @@ -795,6 +854,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/ReadWriteUpdateTable.html#delete-K-java.lang.Object...-">delete(K, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadWriteUpdateTable.html" title="interface in org.apache.samza.table">ReadWriteUpdateTable</a></dt> +<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> @@ -807,12 +870,16 @@ <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/ReadWriteUpdateTable.html#deleteAll-java.util.List-java.lang.Object...-">deleteAll(List<K>, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadWriteUpdateTable.html" title="interface in org.apache.samza.table">ReadWriteUpdateTable</a></dt> +<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/AsyncReadWriteTable.html#deleteAllAsync-java.util.List-java.lang.Object...-">deleteAllAsync(List<K>, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html#deleteAllAsync-java.util.List-java.lang.Object...-">deleteAllAsync(List<K>, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="interface in org.apache.samza.table">AsyncReadWriteUpdateTable</a></dt> <dd> <div class="block">Asynchronously deletes the mappings for the specified <code>keys</code> from this table.</div> </dd> @@ -825,7 +892,7 @@ <div class="block">Asynchronously delete all <code>records</code> with the specified <code>keys</code> and additional arguments from the remote store.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteTable.html#deleteAsync-K-java.lang.Object...-">deleteAsync(K, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html#deleteAsync-K-java.lang.Object...-">deleteAsync(K, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="interface in org.apache.samza.table">AsyncReadWriteUpdateTable</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> @@ -841,6 +908,19 @@ <dd> <div class="block">Delete the scheduled <code>callback</code> for the <code>key</code>.</div> </dd> +<dt><a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html" title="class in org.apache.samza.storage.blobstore.exceptions"><span class="typeNameLink">DeletedException</span></a> - Exception in <a href="org/apache/samza/storage/blobstore/exceptions/package-summary.html">org.apache.samza.storage.blobstore.exceptions</a></dt> +<dd> +<div class="block">Future should complete with this exception to indicate that the exception occurred due to the request for an + already deleted blob.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html#DeletedException-java.lang.String-java.lang.Throwable-">DeletedException(String, Throwable)</a></span> - Constructor for exception org.apache.samza.storage.blobstore.exceptions.<a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html" title="class in org.apache.samza.storage.blobstore.exceptions">DeletedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html#DeletedException-java.lang.String-">DeletedException(String)</a></span> - Constructor for exception org.apache.samza.storage.blobstore.exceptions.<a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html" title="class in org.apache.samza.storage.blobstore.exceptions">DeletedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html#DeletedException-java.lang.Throwable-">DeletedException(Throwable)</a></span> - Constructor for exception org.apache.samza.storage.blobstore.exceptions.<a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html" title="class in org.apache.samza.storage.blobstore.exceptions">DeletedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html#DeletedException--">DeletedException()</a></span> - Constructor for exception org.apache.samza.storage.blobstore.exceptions.<a href="org/apache/samza/storage/blobstore/exceptions/DeletedException.html" title="class in org.apache.samza.storage.blobstore.exceptions">DeletedException</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#deleteMessages-java.util.Map-">deleteMessages(Map<SystemStreamPartition, String>)</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">Delete records up to (and including) the provided ssp offsets for all system stream partitions specified in the map</div> @@ -854,6 +934,8 @@ <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/checkpoint/CheckpointId.html#deserialize-java.lang.String-">deserialize(String)</a></span> - Static method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> +<dd> </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> @@ -875,6 +957,30 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/serializers/DoubleSerdeFactory.html#DoubleSerdeFactory--">DoubleSerdeFactory()</a></span> - Constructor for class org.apache.samza.serializers.<a href="org/apache/samza/serializers/DoubleSerdeFactory.html" title="class in org.apache.samza.serializers">DoubleSerdeFactory</a></dt> <dd> </dd> +<dt><a href="org/apache/samza/task/DrainListenerTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">DrainListenerTask</span></a> - Interface in <a href="org/apache/samza/task/package-summary.html">org.apache.samza.task</a></dt> +<dd> +<div class="block">The DrainListenerTask augments <a href="org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> allowing the method implementor to specify code to be + executed when the 'drain' is reached for a task.</div> +</dd> +<dt><a href="org/apache/samza/system/DrainMessage.html" title="class in org.apache.samza.system"><span class="typeNameLink">DrainMessage</span></a> - Class in <a href="org/apache/samza/system/package-summary.html">org.apache.samza.system</a></dt> +<dd> +<div class="block">The DrainMessage is a control message that is sent out to next stage + once the task has consumed to the end of a bounded stream.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/DrainMessage.html#DrainMessage-java.lang.String-">DrainMessage(String)</a></span> - Constructor for class org.apache.samza.system.<a href="org/apache/samza/system/DrainMessage.html" title="class in org.apache.samza.system">DrainMessage</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/DrainMessage.html#DrainMessage-java.lang.String-java.lang.String-">DrainMessage(String, String)</a></span> - Constructor for class org.apache.samza.system.<a href="org/apache/samza/system/DrainMessage.html" title="class in org.apache.samza.system">DrainMessage</a></dt> +<dd> </dd> +<dt><a href="org/apache/samza/drain/DrainMode.html" title="enum in org.apache.samza.drain"><span class="typeNameLink">DrainMode</span></a> - Enum in <a href="org/apache/samza/drain/package-summary.html">org.apache.samza.drain</a></dt> +<dd> +<div class="block">Defines the type of drain operation.</div> +</dd> +<dt><a href="org/apache/samza/drain/DrainNotification.html" title="class in org.apache.samza.drain"><span class="typeNameLink">DrainNotification</span></a> - Class in <a href="org/apache/samza/drain/package-summary.html">org.apache.samza.drain</a></dt> +<dd> +<div class="block">DrainNotification is a custom message used by an external controller to trigger Drain.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/drain/DrainNotification.html#DrainNotification-java.util.UUID-java.lang.String-org.apache.samza.drain.DrainMode-">DrainNotification(UUID, String, DrainMode)</a></span> - Constructor for class org.apache.samza.drain.<a href="org/apache/samza/drain/DrainNotification.html" title="class in org.apache.samza.drain">DrainNotification</a></dt> +<dd> </dd> <dt><a href="org/apache/samza/operators/triggers/DurationCharacteristic.html" title="enum in org.apache.samza.operators.triggers"><span class="typeNameLink">DurationCharacteristic</span></a> - Enum in <a href="org/apache/samza/operators/triggers/package-summary.html">org.apache.samza.operators.triggers</a></dt> <dd> <div class="block">Indicates whether the associated time duration is in event time or processing time.</div> @@ -911,11 +1017,11 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#entrySet--">entrySet()</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/checkpoint/Checkpoint.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointId.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html" title="class in org.apache.samza.checkpoint">CheckpointedChangelogOffset</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV1.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV1.html" title="class in org.apache.samza.checkpoint">CheckpointV1</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointId.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV2.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV2.html" title="class in org.apache.samza.checkpoint">CheckpointV2</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/MapConfig.html#equals-java.lang.Object-">equals(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> @@ -925,6 +1031,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/container/TaskName.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.container.<a href="org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/drain/DrainNotification.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.drain.<a href="org/apache/samza/drain/DrainNotification.html" title="class in org.apache.samza.drain">DrainNotification</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/ApplicationStatus.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.job.<a href="org/apache/samza/job/ApplicationStatus.html" title="class in org.apache.samza.job">ApplicationStatus</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/JobCoordinatorMetadata.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.job.<a href="org/apache/samza/job/JobCoordinatorMetadata.html" title="class in org.apache.samza.job">JobCoordinatorMetadata</a></dt> @@ -941,6 +1049,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/KV.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.operators.<a href="org/apache/samza/operators/KV.html" title="class in org.apache.samza.operators">KV</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/operators/UpdateMessage.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.operators.<a href="org/apache/samza/operators/UpdateMessage.html" title="class in org.apache.samza.operators">UpdateMessage</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/WindowKey.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/Partition.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.<a href="org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></dt> @@ -955,8 +1065,12 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/startpoint/StartpointTimestamp.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.startpoint.<a href="org/apache/samza/startpoint/StartpointTimestamp.html" title="class in org.apache.samza.startpoint">StartpointTimestamp</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/Metadata.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/Metadata.html" title="class in org.apache.samza.storage.blobstore">Metadata</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/ControlMessage.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/ControlMessage.html" title="class in org.apache.samza.system">ControlMessage</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/DrainMessage.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/DrainMessage.html" title="class in org.apache.samza.system">DrainMessage</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#equals-java.lang.Object-">equals(Object)</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/OutgoingMessageEnvelope.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> @@ -1042,7 +1156,7 @@ <div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those messages and leave no messages remaining to be sent.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteTable.html#flush--">flush()</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html#flush--">flush()</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="interface in org.apache.samza.table">AsyncReadWriteUpdateTable</a></dt> <dd> <div class="block">Flushes the underlying store of this table, if applicable.</div> </dd> @@ -1085,10 +1199,6 @@ <div class="block">Creates a <a href="org/apache/samza/container/placement/ContainerPlacementResponseMessage.html" title="class in org.apache.samza.container.placement"><code>ContainerPlacementResponseMessage</code></a> using <a href="org/apache/samza/container/placement/ContainerPlacementRequestMessage.html" title="class in org.apache.samza.container.placement"><code>ContainerPlacementRequestMessage</code></a> status of current request and response associated with status</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html#fromString-java.lang.String-">fromString(String)</a></span> - Static method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html" title="class in org.apache.samza.checkpoint">CheckpointedChangelogOffset</a></dt> -<dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointId.html#fromString-java.lang.String-">fromString(String)</a></span> - Static method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> -<dd> </dd> </dl> <a name="I:G"> <!-- --> @@ -1141,6 +1251,10 @@ <dd> <div class="block">Returns a value of type T</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/BlobStoreManager.html#get-java.lang.String-java.io.OutputStream-org.apache.samza.storage.blobstore.Metadata-">get(String, OutputStream, Metadata)</a></span> - Method in interface org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/BlobStoreManager.html" title="interface in org.apache.samza.storage.blobstore">BlobStoreManager</a></dt> +<dd> +<div class="block">Non-blocking GET call to remote blob store</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/storage/kv/KeyValueStore.html#get-K-">get(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">Gets the value associated with the specified <code>key</code>.</div> @@ -1151,12 +1265,18 @@ <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/ReadWriteUpdateTable.html#get-K-java.lang.Object...-">get(K, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadWriteUpdateTable.html" title="interface in org.apache.samza.table">ReadWriteUpdateTable</a></dt> +<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/storage/StateBackendFactory.html#getAdmin-org.apache.samza.job.model.JobModel-org.apache.samza.config.Config-">getAdmin(JobModel, Config)</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/StateBackendFactory.html" title="interface in org.apache.samza.storage">StateBackendFactory</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> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> @@ -1174,11 +1294,15 @@ <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/ReadWriteUpdateTable.html#getAll-java.util.List-java.lang.Object...-">getAll(List<K>, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/ReadWriteUpdateTable.html" title="interface in org.apache.samza.table">ReadWriteUpdateTable</a></dt> +<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/AsyncReadWriteTable.html#getAllAsync-java.util.List-java.lang.Object...-">getAllAsync(List<K>, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html#getAllAsync-java.util.List-java.lang.Object...-">getAllAsync(List<K>, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="interface in org.apache.samza.table">AsyncReadWriteUpdateTable</a></dt> <dd> <div class="block">Asynchronously gets the values with which the specified <code>keys</code> are associated.</div> </dd> @@ -1208,7 +1332,7 @@ <dd> <div class="block">Getter for arrival time</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteTable.html#getAsync-K-java.lang.Object...-">getAsync(K, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteTable.html" title="interface in org.apache.samza.table">AsyncReadWriteTable</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html#getAsync-K-java.lang.Object...-">getAsync(K, Object...)</a></span> - Method in interface org.apache.samza.table.<a href="org/apache/samza/table/AsyncReadWriteUpdateTable.html" title="interface in org.apache.samza.table">AsyncReadWriteUpdateTable</a></dt> <dd> <div class="block">Asynchronously gets the value associated with the specified <code>key</code>.</div> </dd> @@ -1226,6 +1350,10 @@ </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/storage/blobstore/BlobStoreManagerFactory.html#getBackupBlobStoreManager-org.apache.samza.config.Config-java.util.concurrent.ExecutorService-">getBackupBlobStoreManager(Config, ExecutorService)</a></span> - Method in interface org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/BlobStoreManagerFactory.html" title="interface in org.apache.samza.storage.blobstore">BlobStoreManagerFactory</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/StateBackendFactory.html#getBackupManager-org.apache.samza.context.JobContext-org.apache.samza.job.model.ContainerModel-org.apache.samza.job.model.TaskModel-java.util.Map-java.util.concurrent.ExecutorService-org.apache.samza.metrics.MetricsRegistry-org.apache.samza.config.Config-org.apache.samza.util.Clock-java.io.File-java.io.File-">getBackupManager(JobContext, ContainerModel, TaskModel, Map<String, SystemAdmin>, ExecutorService, MetricsRegistry, Config, Clock, File, File)</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/StateBackendFactory.html" title="interface in org.apache.samza.storage">StateBackendFactory</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/batching/BatchProvider.html#getBatch--">getBatch()</a></span> - Method in class org.apache.samza.table.batching.<a href="org/apache/samza/table/batching/BatchProvider.html" title="class in org.apache.samza.table.batching">BatchProvider</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> @@ -1247,14 +1375,18 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/triggers/TimeTrigger.html#getCharacteristic--">getCharacteristic()</a></span> - Method in class org.apache.samza.operators.triggers.<a href="org/apache/samza/operators/triggers/TimeTrigger.html" title="class in org.apache.samza.operators.triggers">TimeTrigger</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html#getCheckpointId--">getCheckpointId()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html" title="class in org.apache.samza.checkpoint">CheckpointedChangelogOffset</a></dt> -<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV2.html#getCheckpointId--">getCheckpointId()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV2.html" title="class in org.apache.samza.checkpoint">CheckpointV2</a></dt> +<dd> +<div class="block">Gets the checkpoint id for the checkpoint</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointManagerFactory.html#getCheckpointManager-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getCheckpointManager(Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint">CheckpointManagerFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/chooser/MessageChooserFactory.html#getChooser-org.apache.samza.config.Config-org.apache.samza.metrics.MetricsRegistry-">getChooser(Config, MetricsRegistry)</a></span> - Method in interface org.apache.samza.system.chooser.<a href="org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser">MessageChooserFactory</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getClass-java.lang.String-">getClass(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/storage/KafkaChangelogRestoreParams.html#getCollector--">getCollector()</a></span> - Method in class org.apache.samza.storage.<a href="org/apache/samza/storage/KafkaChangelogRestoreParams.html" title="class in org.apache.samza.storage">KafkaChangelogRestoreParams</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/application/descriptors/ApplicationDescriptor.html#getConfig--">getConfig()</a></span> - Method in interface org.apache.samza.application.descriptors.<a href="org/apache/samza/application/descriptors/ApplicationDescriptor.html" title="interface in org.apache.samza.application.descriptors">ApplicationDescriptor</a></dt> <dd> <div class="block">Get the configuration for the application.</div> @@ -1269,6 +1401,10 @@ <dd> <div class="block">Gets the final configuration for this job.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/coordinator/lifecycle/JobRestartSignalFactoryContext.html#getConfig--">getConfig()</a></span> - Method in class org.apache.samza.coordinator.lifecycle.<a href="org/apache/samza/coordinator/lifecycle/JobRestartSignalFactoryContext.html" title="class in org.apache.samza.coordinator.lifecycle">JobRestartSignalFactoryContext</a></dt> +<dd> +<div class="block"><a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a> used to build a <a href="org/apache/samza/coordinator/lifecycle/JobRestartSignal.html" title="interface in org.apache.samza.coordinator.lifecycle"><code>JobRestartSignal</code></a>.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/model/JobModel.html#getConfig--">getConfig()</a></span> - Method in class org.apache.samza.job.model.<a href="org/apache/samza/job/model/JobModel.html" title="class in org.apache.samza.job.model">JobModel</a></dt> <dd> </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> @@ -1331,6 +1467,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getDate-java.lang.String-java.text.SimpleDateFormat-java.util.Date-">getDate(String, SimpleDateFormat, Date)</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/operators/UpdateMessage.html#getDefault--">getDefault()</a></span> - Method in class org.apache.samza.operators.<a href="org/apache/samza/operators/UpdateMessage.html" title="class in org.apache.samza.operators">UpdateMessage</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/internal/WindowInternal.html#getDefaultTrigger--">getDefaultTrigger()</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/placement/ContainerPlacementMessage.html#getDeploymentId--">getDeploymentId()</a></span> - Method in class org.apache.samza.container.placement.<a href="org/apache/samza/container/placement/ContainerPlacementMessage.html" title="class in org.apache.samza.container.placement">ContainerPlacementMessage</a></dt> @@ -1341,6 +1479,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/config/Config.html#getDouble-java.lang.String-">getDouble(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/drain/DrainNotification.html#getDrainMode--">getDrainMode()</a></span> - Method in class org.apache.samza.drain.<a href="org/apache/samza/drain/DrainNotification.html" title="class in org.apache.samza.drain">DrainNotification</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/triggers/TimeBasedTrigger.html#getDuration--">getDuration()</a></span> - Method in interface org.apache.samza.operators.triggers.<a href="org/apache/samza/operators/triggers/TimeBasedTrigger.html" title="interface in org.apache.samza.operators.triggers">TimeBasedTrigger</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/triggers/TimeSinceFirstMessageTrigger.html#getDuration--">getDuration()</a></span> - Method in class org.apache.samza.operators.triggers.<a href="org/apache/samza/operators/triggers/TimeSinceFirstMessageTrigger.html" title="class in org.apache.samza.operators.triggers">TimeSinceFirstMessageTrigger</a></dt> @@ -1429,6 +1569,8 @@ <dd> </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/storage/KafkaChangelogRestoreParams.html#getInMemoryStores--">getInMemoryStores()</a></span> - Method in class org.apache.samza.storage.<a href="org/apache/samza/storage/KafkaChangelogRestoreParams.html" title="class in org.apache.samza.storage">KafkaChangelogRestoreParams</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> <dd> <div class="block">Gets a <a href="org/apache/samza/system/descriptors/InputDescriptor.html" title="class in org.apache.samza.system.descriptors"><code>InputDescriptor</code></a> for an input stream on this system.</div> @@ -1465,6 +1607,8 @@ <dd> <div class="block">Gets the id for this job.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/Metadata.html#getJobId--">getJobId()</a></span> - Method in class org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/Metadata.html" title="class in org.apache.samza.storage.blobstore">Metadata</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/context/JobContext.html#getJobModel--">getJobModel()</a></span> - Method in interface org.apache.samza.context.<a href="org/apache/samza/context/JobContext.html" title="interface in org.apache.samza.context">JobContext</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/job/JobCoordinatorMetadata.html#getJobModelId--">getJobModelId()</a></span> - Method in class org.apache.samza.job.<a href="org/apache/samza/job/JobCoordinatorMetadata.html" title="class in org.apache.samza.job">JobCoordinatorMetadata</a></dt> @@ -1473,6 +1617,8 @@ <dd> <div class="block">Gets the name of the job.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/Metadata.html#getJobName--">getJobName()</a></span> - Method in class org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/Metadata.html" title="class in org.apache.samza.storage.blobstore">Metadata</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/KV.html#getKey--">getKey()</a></span> - Method in class org.apache.samza.operators.<a href="org/apache/samza/operators/KV.html" title="class in org.apache.samza.operators">KV</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/operators/windows/WindowKey.html#getKey--">getKey()</a></span> - Method in class org.apache.samza.operators.windows.<a href="org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a></dt> @@ -1487,6 +1633,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/batching/Operation.html#getKey--">getKey()</a></span> - Method in interface org.apache.samza.table.batching.<a href="org/apache/samza/table/batching/Operation.html" title="interface in org.apache.samza.table.batching">Operation</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamPartition.html#getKeyBucket--">getKeyBucket()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dt> +<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> @@ -1533,6 +1681,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/table/batching/BatchProvider.html#getMaxBatchSize--">getMaxBatchSize()</a></span> - Method in class org.apache.samza.table.batching.<a href="org/apache/samza/table/batching/BatchProvider.html" title="class in org.apache.samza.table.batching">BatchProvider</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/job/model/JobModel.html#getMaxChangeLogStreamPartitions--">getMaxChangeLogStreamPartitions()</a></span> - Method in class org.apache.samza.job.model.<a href="org/apache/samza/job/model/JobModel.html" title="class in org.apache.samza.job.model">JobModel</a></dt> +<dd> </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> @@ -1581,7 +1731,7 @@ <dd> <div class="block">Get the name of the timer</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointId.html#getNanos--">getNanos()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointId.html#getNanoId--">getNanoId()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointId.html" title="class in org.apache.samza.checkpoint">CheckpointId</a></dt> <dd> </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> @@ -1589,17 +1739,23 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/util/BlockingEnvelopeMap.html#getNumMessagesInQueue-org.apache.samza.system.SystemStreamPartition-">getNumMessagesInQueue(SystemStreamPartition)</a></span> - Method in class org.apache.samza.util.<a href="org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html#getOffset--">getOffset()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointedChangelogOffset.html" title="class in org.apache.samza.checkpoint">CheckpointedChangelogOffset</a></dt> -<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/IncomingMessageEnvelope.html#getOffset--">getOffset()</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> <div class="block">Offset associated with this message, provided by the system consumer that consumed the message.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOffset-org.apache.samza.system.SystemStreamMetadata.OffsetType-">getOffset(SystemStreamMetadata.OffsetType)</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/checkpoint/Checkpoint.html#getOffsets--">getOffsets()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/Checkpoint.html#getOffsets--">getOffsets()</a></span> - Method in interface org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/Checkpoint.html" title="interface in org.apache.samza.checkpoint">Checkpoint</a></dt> <dd> -<div class="block">Gets a unmodifiable view of the current Samza stream offsets.</div> +<div class="block">Gets a unmodifiable view of the last processed offsets for <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>s.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV1.html#getOffsets--">getOffsets()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV1.html" title="class in org.apache.samza.checkpoint">CheckpointV1</a></dt> +<dd> +<div class="block">Gets a unmodifiable view of the current Samza input stream offsets.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/checkpoint/CheckpointV2.html#getOffsets--">getOffsets()</a></span> - Method in class org.apache.samza.checkpoint.<a href="org/apache/samza/checkpoint/CheckpointV2.html" title="class in org.apache.samza.checkpoint">CheckpointV2</a></dt> +<dd> +<div class="block">Gets a unmodifiable view of the current input <a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a> offsets.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/SystemAdmin.html#getOffsetsAfter-java.util.Map-">getOffsetsAfter(Map<SystemStreamPartition, String>)</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> @@ -1639,6 +1795,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey--">getPartitionKey()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/Metadata.html#getPayloadPath--">getPayloadPath()</a></span> - Method in class org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/Metadata.html" title="class in org.apache.samza.storage.blobstore">Metadata</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/Metadata.html#getPayloadSize--">getPayloadSize()</a></span> - Method in class org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/Metadata.html" title="class in org.apache.samza.storage.blobstore">Metadata</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/system/descriptors/StreamDescriptor.html#getPhysicalName--">getPhysicalName()</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/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> @@ -1683,16 +1843,26 @@ <dd> <div class="block">Retrieve the join key from table record</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsRegistryWithSource.html#getRegistry--">getRegistry()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsRegistryWithSource.html" title="class in org.apache.samza.metrics">MetricsRegistryWithSource</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/container/placement/ContainerPlacementMessage.html#getRequestExpiry--">getRequestExpiry()</a></span> - Method in class org.apache.samza.container.placement.<a href="org/apache/samza/container/placement/ContainerPlacementMessage.html" title="class in org.apache.samza.container.placement">ContainerPlacementMessage</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/container/placement/ContainerPlacementResponseMessage.html#getResponseMessage--">getResponseMessage()</a></span> - Method in class org.apache.samza.container.placement.<a href="org/apache/samza/container/placement/ContainerPlacementResponseMessage.html" title="class in org.apache.samza.container.placement">ContainerPlacementResponseMessage</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/blobstore/BlobStoreManagerFactory.html#getRestoreBlobStoreManager-org.apache.samza.config.Config-java.util.concurrent.ExecutorService-">getRestoreBlobStoreManager(Config, ExecutorService)</a></span> - Method in interface org.apache.samza.storage.blobstore.<a href="org/apache/samza/storage/blobstore/BlobStoreManagerFactory.html" title="interface in org.apache.samza.storage.blobstore">BlobStoreManagerFactory</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/StateBackendFactory.html#getRestoreManager-org.apache.samza.context.JobContext-org.apache.samza.context.ContainerContext-org.apache.samza.job.model.TaskModel-java.util.concurrent.ExecutorService-org.apache.samza.metrics.MetricsRegistry-java.util.Set-org.apache.samza.config.Config-org.apache.samza.util.Clock-java.io.File-java.io.File-org.apache.samza.storage.KafkaChangelogRestoreParams-">getRestoreManager(JobContext, ContainerContext, TaskModel, ExecutorService, MetricsRegistry, Set<String>, Config, Clock, File, File, KafkaChangelogRestoreParams)</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/StateBackendFactory.html" title="interface in org.apache.samza.storage">StateBackendFactory</a></dt> +<dd> </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/sql/schema/SqlFieldSchema.html#getRowSchema--">getRowSchema()</a></span> - Method in class org.apache.samza.sql.schema.<a href="org/apache/samza/sql/schema/SqlFieldSchema.html" title="class in org.apache.samza.sql.schema">SqlFieldSchema</a></dt> <dd> <div class="block">Get the row schema if the field type is <a href="org/apache/samza/sql/schema/SamzaSqlFieldType.html#ROW"><code>SamzaSqlFieldType.ROW</code></a></div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/drain/DrainNotification.html#getRunId--">getRunId()</a></span> - Method in class org.apache.samza.drain.<a href="org/apache/samza/drain/DrainNotification.html" title="class in org.apache.samza.drain">DrainNotification</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/system/DrainMessage.html#getRunId--">getRunId()</a></span> - Method in class org.apache.samza.system.<a href="org/apache/samza/system/DrainMessage.html" title="class in org.apache.samza.system">DrainMessage</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> @@ -1723,6 +1893,8 @@ <dd> <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/storage/KafkaChangelogRestoreParams.html#getSerdes--">getSerdes()</a></span> - Method in class org.apache.samza.storage.<a href="org/apache/samza/storage/KafkaChangelogRestoreParams.html" title="class in org.apache.samza.storage">KafkaChangelogRestoreParams</a></dt> +<dd> </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> @@ -1753,6 +1925,8 @@ <dd> <div class="block">Get the <a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a></div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/metrics/MetricsRegistryWithSource.html#getSource--">getSource()</a></span> - Method in class org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsRegistryWithSource.html" title="class in org.apache.samza.metrics">MetricsRegistryWithSource</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/samza/startpoint/StartpointSpecific.html#getSpecificOffset--">getSpecificOffset()</a></span> - Method in class org.apache.samza.startpoint.<a href="org/apache/samza/startpoint/StartpointSpecific.html" title="class in org.apache.samza.startpoint">StartpointSpecific</a></dt> <dd> <div class="block">Getter for the specific offset.</div> @@ -1761,6 +1935,14 @@ <dd> <div class="block">Fetch metadata from a system for a set of SSPs.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/samza/storage/BlobStoreAdminFactory.html#getStateBackendAdmin-org.apache.samza.config.Config-org.apache.samza.job.model.JobModel-">getStateBackendAdmin(Config, JobModel)</a></span> - Method in interface org.apache.samza.storage.<a href="org/apache/samza/storage/BlobStoreAdminFactory.html" title="interface in org.apache.samza.storage">BlobStoreAdminFactory</a></dt> +<dd>
[... 874 lines stripped ...]
