blob: 6d74196038c1534c842f72394365d334ecacbfa2 [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>RampupThrottlingFn (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="RampupThrottlingFn (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/gcp/datastore/EntityToRow.html" title="class in org.apache.beam.sdk.io.gcp.datastore"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/datastore/RowToEntity.html" title="class in org.apache.beam.sdk.io.gcp.datastore"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html" target="_top">Frames</a></li>
<li><a href="RampupThrottlingFn.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><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">Nested</a>&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.gcp.datastore</div>
<h2 title="Class RampupThrottlingFn" class="title">Class RampupThrottlingFn&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.DoFn</a>&lt;T,T&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.gcp.datastore.RampupThrottlingFn&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RampupThrottlingFn&lt;T&gt;</span>
extends <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a>&lt;T,T&gt;
implements java.io.Serializable</pre>
<div class="block">An implementation of a client-side throttler that enforces a gradual ramp-up, broadly in line
with Datastore best practices. See also
https://cloud.google.com/datastore/docs/best-practices#ramping_up_traffic.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.io.gcp.datastore.RampupThrottlingFn">Serialized Form</a></dd>
</dl>
</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.transforms.DoFn">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a></h3>
<code><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.AlwaysFetched.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.AlwaysFetched</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.BoundedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.BoundedPerElement</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.BundleFinalizer.html" title="interface in org.apache.beam.sdk.transforms">DoFn.BundleFinalizer</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.Element.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Element</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.FieldAccess.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.FieldAccess</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.FinishBundle</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundleContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.FinishBundleContext</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetInitialRestriction</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialWatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetInitialWatermarkEstimatorState</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.GetRestrictionCoder.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetRestrictionCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.GetSize.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetSize</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.GetWatermarkEstimatorStateCoder.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetWatermarkEstimatorStateCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.Key.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Key</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.MultiOutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.MultiOutputReceiver</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.NewTracker</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.NewWatermarkEstimator.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.NewWatermarkEstimator</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimer.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnTimer</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimerContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.OnTimerContext</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimerFamily.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnTimerFamily</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.OnWindowExpiration.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnWindowExpiration</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.OnWindowExpirationContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.OnWindowExpirationContext</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.OutputReceiver</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="type parameter in DoFn.OutputReceiver">T</a>&gt;, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContinuation.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContinuation</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.ProcessElement</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.RequiresStableInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.RequiresStableInput</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.RequiresTimeSortedInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.RequiresTimeSortedInput</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.Restriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Restriction</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.Setup.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Setup</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.SideInput.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.SideInput</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.SplitRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.SplitRestriction</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StartBundle</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundleContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.StartBundleContext</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.StateId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StateId</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.Teardown.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Teardown</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.TimerFamily.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TimerFamily</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.TimerId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TimerId</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.Timestamp.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Timestamp</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.TruncateRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TruncateRestriction</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.UnboundedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.UnboundedPerElement</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.WatermarkEstimatorState.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.WatermarkEstimatorState</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.WindowedContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.WindowedContext</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/gcp/datastore/RampupThrottlingFn.html#RampupThrottlingFn-int-org.apache.beam.sdk.values.PCollectionView-">RampupThrottlingFn</a></span>(int&nbsp;numWorkers,
<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;<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>&gt;&nbsp;timestampSideInput)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html#RampupThrottlingFn-org.apache.beam.sdk.options.ValueProvider-org.apache.beam.sdk.values.PCollectionView-">RampupThrottlingFn</a></span>(<a href="../../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a>&lt;java.lang.Integer&gt;&nbsp;numWorkers,
<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;<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>&gt;&nbsp;firstInstantSideInput)</code>&nbsp;</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/gcp/datastore/RampupThrottlingFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</code>
<div class="block">Register display data for the given transform or component.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html#processElement-org.apache.beam.sdk.transforms.DoFn.ProcessContext-">processElement</a></span>(<a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a>&nbsp;c)</code>
<div class="block">Emit only as many elements as the exponentially increasing budget allows.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html#setup--">setup</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a></h3>
<code><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html#getAllowedTimestampSkew--">getAllowedTimestampSkew</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html#getInputTypeDescriptor--">getInputTypeDescriptor</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html#getOutputTypeDescriptor--">getOutputTypeDescriptor</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html#prepareForProcessing--">prepareForProcessing</a></code></li>
</ul>
<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="RampupThrottlingFn-org.apache.beam.sdk.options.ValueProvider-org.apache.beam.sdk.values.PCollectionView-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RampupThrottlingFn</h4>
<pre>public&nbsp;RampupThrottlingFn(<a href="../../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a>&lt;java.lang.Integer&gt;&nbsp;numWorkers,
<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;<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>&gt;&nbsp;firstInstantSideInput)</pre>
</li>
</ul>
<a name="RampupThrottlingFn-int-org.apache.beam.sdk.values.PCollectionView-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RampupThrottlingFn</h4>
<pre>public&nbsp;RampupThrottlingFn(int&nbsp;numWorkers,
<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a>&lt;<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>&gt;&nbsp;timestampSideInput)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setup</h4>
<pre><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.Setup.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.Setup</a>
public&nbsp;void&nbsp;setup()</pre>
</li>
</ul>
<a name="processElement-org.apache.beam.sdk.transforms.DoFn.ProcessContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processElement</h4>
<pre><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.ProcessElement</a>
public&nbsp;void&nbsp;processElement(<a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a>&nbsp;c)
throws java.io.IOException,
java.lang.InterruptedException</pre>
<div class="block">Emit only as many elements as the exponentially increasing budget allows.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.InterruptedException</code></dd>
</dl>
</li>
</ul>
<a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>populateDisplayData</h4>
<pre>public&nbsp;void&nbsp;populateDisplayData(<a href="../../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">DoFn</a></code></span></div>
<div class="block">Register display data for the given transform or component.
<p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect
display data via <a href="../../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call <code>super.populateDisplayData(builder)</code> in order to register display data in the current namespace,
but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use the namespace
of the subcomponent.
<p>By default, does not register any display data. Implementors may override this method to
provide their own display data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html" title="type parameter in RampupThrottlingFn">T</a>,<a href="../../../../../../../org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html" title="type parameter in RampupThrottlingFn">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - The builder to populate with display data.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></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/gcp/datastore/EntityToRow.html" title="class in org.apache.beam.sdk.io.gcp.datastore"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/datastore/RowToEntity.html" title="class in org.apache.beam.sdk.io.gcp.datastore"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/datastore/RampupThrottlingFn.html" target="_top">Frames</a></li>
<li><a href="RampupThrottlingFn.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><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">Nested</a>&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>