blob: d9133829f2ba6d7d5e705a13e4ca31ee9c44f70c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>CountingSource.CounterMark (Apache Beam 2.38.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CountingSource.CounterMark (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/io/CountingSource.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/io/CountingSource.CounterMark.html" target="_top">Frames</a></li>
<li><a href="CountingSource.CounterMark.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.io</div>
<h2 title="Class CountingSource.CounterMark" class="title">Class CountingSource.CounterMark</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.CountingSource.CounterMark</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/io/CountingSource.html" title="class in org.apache.beam.sdk.io">CountingSource</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/apache/beam/sdk/coders/DefaultCoder.html" title="annotation in org.apache.beam.sdk.coders">@DefaultCoder</a>(<a href="../../../../../org/apache/beam/sdk/coders/DefaultCoder.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/coders/AvroCoder.html" title="class in org.apache.beam.sdk.coders">AvroCoder.class</a>)
public static class <span class="typeNameLabel">CountingSource.CounterMark</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></pre>
<div class="block">The checkpoint for an unbounded <a href="../../../../../org/apache/beam/sdk/io/CountingSource.html" title="class in org.apache.beam.sdk.io"><code>CountingSource</code></a> is simply the last value produced. The
associated source object encapsulates the information needed to produce the next value.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.UnboundedSource.CheckpointMark">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.beam.sdk.io.<a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.NoopCheckpointMark.html" title="class in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark.NoopCheckpointMark</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.io.UnboundedSource.CheckpointMark">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.beam.sdk.io.<a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html#NOOP_CHECKPOINT_MARK">NOOP_CHECKPOINT_MARK</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/CountingSource.CounterMark.html#CounterMark-long-org.joda.time.Instant-">CounterMark</a></span>(long&nbsp;lastEmitted,
<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;startTime)</code>
<div class="block">Creates a checkpoint mark reflecting the last emitted value.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/CountingSource.CounterMark.html#finalizeCheckpoint--">finalizeCheckpoint</a></span>()</code>
<div class="block">Called by the system to signal that this checkpoint mark has been committed along with all
the records which have been read from the <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> since the previous
checkpoint was taken.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/CountingSource.CounterMark.html#getLastEmitted--">getLastEmitted</a></span>()</code>
<div class="block">Returns the last value emitted by the reader.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/io/CountingSource.CounterMark.html#getStartTime--">getStartTime</a></span>()</code>
<div class="block">Returns the time the reader was started.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CounterMark-long-org.joda.time.Instant-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CounterMark</h4>
<pre>public&nbsp;CounterMark(long&nbsp;lastEmitted,
<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;startTime)</pre>
<div class="block">Creates a checkpoint mark reflecting the last emitted value.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLastEmitted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastEmitted</h4>
<pre>public&nbsp;long&nbsp;getLastEmitted()</pre>
<div class="block">Returns the last value emitted by the reader.</div>
</li>
</ul>
<a name="getStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;getStartTime()</pre>
<div class="block">Returns the time the reader was started.</div>
</li>
</ul>
<a name="finalizeCheckpoint--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finalizeCheckpoint</h4>
<pre>public&nbsp;void&nbsp;finalizeCheckpoint()
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html#finalizeCheckpoint--">UnboundedSource.CheckpointMark</a></code></span></div>
<div class="block">Called by the system to signal that this checkpoint mark has been committed along with all
the records which have been read from the <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> since the previous
checkpoint was taken.
<p>For example, this method could send acknowledgements to an external data source such as
Pubsub.
<p>Note that:
<ul>
<li>This finalize method may be called from any thread, concurrently with calls to the
<a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> it was created from.
<li>Checkpoints will not necessarily be finalized as soon as they are created. A checkpoint
may be taken while a previous checkpoint from the same <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> has not
yet be finalized.
<li>In the absence of failures, all checkpoints will be finalized and they will be
finalized in the same order they were taken from the <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a>.
<li>It is possible for a checkpoint to be taken but this method never called. This method
will never be called if the checkpoint could not be committed, and other failures may
cause this method to never be called.
<li>It is not safe to assume the <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a> from which this checkpoint was
created still exists at the time this method is called.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html#finalizeCheckpoint--">finalizeCheckpoint</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/io/CountingSource.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/io/CountingSource.CounterMark.html" target="_top">Frames</a></li>
<li><a href="CountingSource.CounterMark.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>