| <!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>KinesisIO.Read (Apache Beam 2.47.0)</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="KinesisIO.Read (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/aws2/kinesis/KinesisIO.html" title="class in org.apache.beam.sdk.io.aws2.kinesis"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.RecordAggregation.html" title="class in org.apache.beam.sdk.io.aws2.kinesis"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" target="_top">Frames</a></li> |
| <li><a href="KinesisIO.Read.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io.aws2.kinesis</div> |
| <h2 title="Class KinesisIO.Read" class="title">Class KinesisIO.Read</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/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisRecord.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisRecord</a>>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.aws2.kinesis.KinesisIO.Read</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> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">KinesisIO.Read</span> |
| extends <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisRecord.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisRecord</a>>></pre> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.html#read--"><code>KinesisIO.read()</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.io.aws2.kinesis.KinesisIO.Read">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#resourceHints">resourceHints</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"> </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/aws2/kinesis/KinesisIO.Read.html#Read--">Read</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisRecord.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisRecord</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#expand-org.apache.beam.sdk.values.PBegin-">expand</a></span>(<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</code> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withArrivalTimeWatermarkPolicy--">withArrivalTimeWatermarkPolicy</a></span>()</code> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as ArrivalTimeWatermarkPolicyFactory.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withArrivalTimeWatermarkPolicy-org.joda.time.Duration-">withArrivalTimeWatermarkPolicy</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> watermarkIdleDurationThreshold)</code> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as ArrivalTimeWatermarkPolicyFactory.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withAWSClientsProvider-org.apache.beam.sdk.io.aws2.kinesis.AWSClientsProvider-">withAWSClientsProvider</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/AWSClientsProvider.html" title="interface in org.apache.beam.sdk.io.aws2.kinesis">AWSClientsProvider</a> clientProvider)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead. Alternatively |
| you can configure a custom <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientBuilderFactory.html" title="interface in org.apache.beam.sdk.io.aws2.common"><code>ClientBuilderFactory</code></a> in <a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html" title="interface in org.apache.beam.sdk.io.aws2.options"><code>AwsOptions</code></a>.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withAWSClientsProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-software.amazon.awssdk.regions.Region-">withAWSClientsProvider</a></span>(<a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a> awsCredentialsProvider, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withAWSClientsProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-software.amazon.awssdk.regions.Region-java.lang.String-">withAWSClientsProvider</a></span>(<a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a> awsCredentialsProvider, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region, |
| java.lang.String serviceEndpoint)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withAWSClientsProvider-java.lang.String-java.lang.String-software.amazon.awssdk.regions.Region-">withAWSClientsProvider</a></span>(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withAWSClientsProvider-java.lang.String-java.lang.String-software.amazon.awssdk.regions.Region-java.lang.String-">withAWSClientsProvider</a></span>(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region, |
| java.lang.String serviceEndpoint)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-">withClientConfiguration</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientConfiguration</a> config)</code> |
| <div class="block">Configuration of Kinesis & Cloudwatch clients.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withCustomRateLimitPolicy-org.apache.beam.sdk.io.aws2.kinesis.RateLimitPolicyFactory-">withCustomRateLimitPolicy</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/RateLimitPolicyFactory.html" title="interface in org.apache.beam.sdk.io.aws2.kinesis">RateLimitPolicyFactory</a> rateLimitPolicyFactory)</code> |
| <div class="block">Specifies the <code>RateLimitPolicyFactory</code> for a custom rate limiter.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withCustomWatermarkPolicy-org.apache.beam.sdk.io.aws2.kinesis.WatermarkPolicyFactory-">withCustomWatermarkPolicy</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.aws2.kinesis">WatermarkPolicyFactory</a> watermarkPolicyFactory)</code> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as a custom watermarkPolicyFactory.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withDynamicDelayRateLimitPolicy-java.util.function.Supplier-">withDynamicDelayRateLimitPolicy</a></span>(java.util.function.Supplier<<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>> delay)</code> |
| <div class="block">Specifies a dynamic delay rate limit policy with the given function being called at each |
| polling interval to get the next delay value.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withFixedDelayRateLimitPolicy--">withFixedDelayRateLimitPolicy</a></span>()</code> |
| <div class="block">Specifies a fixed delay rate limit policy with the default delay of 1 second.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withFixedDelayRateLimitPolicy-org.joda.time.Duration-">withFixedDelayRateLimitPolicy</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> delay)</code> |
| <div class="block">Specifies a fixed delay rate limit policy with the given delay.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withInitialPositionInStream-software.amazon.kinesis.common.InitialPositionInStream-">withInitialPositionInStream</a></span>(software.amazon.kinesis.common.InitialPositionInStream initialPosition)</code> |
| <div class="block">Specify reading from some initial position in stream.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withInitialTimestampInStream-org.joda.time.Instant-">withInitialTimestampInStream</a></span>(<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> initialTimestamp)</code> |
| <div class="block">Specify reading beginning at given <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"><code>Instant</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withMaxCapacityPerShard-java.lang.Integer-">withMaxCapacityPerShard</a></span>(java.lang.Integer maxCapacity)</code> |
| <div class="block">Specifies the maximum number of messages per one shard.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withMaxNumRecords-long-">withMaxNumRecords</a></span>(long maxNumRecords)</code> |
| <div class="block">Specifies to read at most a given number of records.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withMaxReadTime-org.joda.time.Duration-">withMaxReadTime</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> maxReadTime)</code> |
| <div class="block">Specifies to read records during <code>maxReadTime</code>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withProcessingTimeWatermarkPolicy--">withProcessingTimeWatermarkPolicy</a></span>()</code> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as ProcessingTimeWatermarkPolicyFactory.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withRequestRecordsLimit-int-">withRequestRecordsLimit</a></span>(int limit)</code> |
| <div class="block">Specifies the maximum number of records in GetRecordsResult returned by GetRecords call which |
| is limited by 10K records.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withStreamName-java.lang.String-">withStreamName</a></span>(java.lang.String streamName)</code> |
| <div class="block">Specify reading from streamName.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withUpToDateThreshold-org.joda.time.Duration-">withUpToDateThreshold</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> upToDateThreshold)</code> |
| <div class="block">Specifies how late records consumed by this source can be to still be considered on time.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getAdditionalInputs--">getAdditionalInputs</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.PCollection-">getDefaultOutputCoder</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getResourceHints--">getResourceHints</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#setResourceHints-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-">setResourceHints</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-">validate</a>, <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-java.util.Map-java.util.Map-">validate</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 java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="Read--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Read</h4> |
| <pre>public Read()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withStreamName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withStreamName</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withStreamName(java.lang.String streamName)</pre> |
| <div class="block">Specify reading from streamName.</div> |
| </li> |
| </ul> |
| <a name="withInitialPositionInStream-software.amazon.kinesis.common.InitialPositionInStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withInitialPositionInStream</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withInitialPositionInStream(software.amazon.kinesis.common.InitialPositionInStream initialPosition)</pre> |
| <div class="block">Specify reading from some initial position in stream.</div> |
| </li> |
| </ul> |
| <a name="withInitialTimestampInStream-org.joda.time.Instant-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withInitialTimestampInStream</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withInitialTimestampInStream(<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> initialTimestamp)</pre> |
| <div class="block">Specify reading beginning at given <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"><code>Instant</code></a>. This <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"><code>Instant</code></a> must be in the past, |
| i.e. before <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true#now--" title="class or interface in org.joda.time"><code>Instant.now()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-org.apache.beam.sdk.io.aws2.kinesis.AWSClientsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withAWSClientsProvider(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/AWSClientsProvider.html" title="interface in org.apache.beam.sdk.io.aws2.kinesis">AWSClientsProvider</a> clientProvider)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead. Alternatively |
| you can configure a custom <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientBuilderFactory.html" title="interface in org.apache.beam.sdk.io.aws2.common"><code>ClientBuilderFactory</code></a> in <a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html" title="interface in org.apache.beam.sdk.io.aws2.options"><code>AwsOptions</code></a>.</span></div> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-java.lang.String-java.lang.String-software.amazon.awssdk.regions.Region-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withAWSClientsProvider(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-java.lang.String-java.lang.String-software.amazon.awssdk.regions.Region-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withAWSClientsProvider(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region, |
| java.lang.String serviceEndpoint)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-software.amazon.awssdk.regions.Region-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withAWSClientsProvider(<a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a> awsCredentialsProvider, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-software.amazon.awssdk.regions.Region-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withAWSClientsProvider(<a href="https://static.javadoc.io/software.amazon.awssdk/auth/2.17.127/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html?is-external=true" title="class or interface in software.amazon.awssdk.auth.credentials">AwsCredentialsProvider</a> awsCredentialsProvider, |
| <a href="https://static.javadoc.io/software.amazon.awssdk/regions/2.17.127/software/amazon/awssdk/regions/Region.html?is-external=true" title="class or interface in software.amazon.awssdk.regions">Region</a> region, |
| java.lang.String serviceEndpoint)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withClientConfiguration</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withClientConfiguration(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientConfiguration</a> config)</pre> |
| <div class="block">Configuration of Kinesis & Cloudwatch clients.</div> |
| </li> |
| </ul> |
| <a name="withMaxNumRecords-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxNumRecords</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withMaxNumRecords(long maxNumRecords)</pre> |
| <div class="block">Specifies to read at most a given number of records.</div> |
| </li> |
| </ul> |
| <a name="withMaxReadTime-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxReadTime</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withMaxReadTime(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> maxReadTime)</pre> |
| <div class="block">Specifies to read records during <code>maxReadTime</code>.</div> |
| </li> |
| </ul> |
| <a name="withUpToDateThreshold-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withUpToDateThreshold</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withUpToDateThreshold(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> upToDateThreshold)</pre> |
| <div class="block">Specifies how late records consumed by this source can be to still be considered on time. |
| When this limit is exceeded the actual backlog size will be evaluated and the runner might |
| decide to scale the amount of resources allocated to the pipeline in order to speed up |
| ingestion.</div> |
| </li> |
| </ul> |
| <a name="withRequestRecordsLimit-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withRequestRecordsLimit</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withRequestRecordsLimit(int limit)</pre> |
| <div class="block">Specifies the maximum number of records in GetRecordsResult returned by GetRecords call which |
| is limited by 10K records. If should be adjusted according to average size of data record to |
| prevent shard overloading. More details can be found here: <a |
| href="https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html">API_GetRecords</a></div> |
| </li> |
| </ul> |
| <a name="withArrivalTimeWatermarkPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withArrivalTimeWatermarkPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withArrivalTimeWatermarkPolicy()</pre> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as ArrivalTimeWatermarkPolicyFactory.</div> |
| </li> |
| </ul> |
| <a name="withArrivalTimeWatermarkPolicy-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withArrivalTimeWatermarkPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withArrivalTimeWatermarkPolicy(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> watermarkIdleDurationThreshold)</pre> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as ArrivalTimeWatermarkPolicyFactory. |
| |
| <p> Denotes the duration for which the watermark can |
| be idle.</div> |
| </li> |
| </ul> |
| <a name="withProcessingTimeWatermarkPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withProcessingTimeWatermarkPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withProcessingTimeWatermarkPolicy()</pre> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as ProcessingTimeWatermarkPolicyFactory.</div> |
| </li> |
| </ul> |
| <a name="withCustomWatermarkPolicy-org.apache.beam.sdk.io.aws2.kinesis.WatermarkPolicyFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCustomWatermarkPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withCustomWatermarkPolicy(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.aws2.kinesis">WatermarkPolicyFactory</a> watermarkPolicyFactory)</pre> |
| <div class="block">Specifies the <code>WatermarkPolicyFactory</code> as a custom watermarkPolicyFactory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watermarkPolicyFactory</code> - Custom Watermark policy factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withFixedDelayRateLimitPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFixedDelayRateLimitPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withFixedDelayRateLimitPolicy()</pre> |
| <div class="block">Specifies a fixed delay rate limit policy with the default delay of 1 second.</div> |
| </li> |
| </ul> |
| <a name="withFixedDelayRateLimitPolicy-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFixedDelayRateLimitPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withFixedDelayRateLimitPolicy(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> delay)</pre> |
| <div class="block">Specifies a fixed delay rate limit policy with the given delay.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delay</code> - Denotes the fixed delay duration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDynamicDelayRateLimitPolicy-java.util.function.Supplier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDynamicDelayRateLimitPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withDynamicDelayRateLimitPolicy(java.util.function.Supplier<<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>> delay)</pre> |
| <div class="block">Specifies a dynamic delay rate limit policy with the given function being called at each |
| polling interval to get the next delay value. This can be used to change the polling interval |
| of a running pipeline based on some external configuration source, for example.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delay</code> - The function to invoke to get the next delay duration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withCustomRateLimitPolicy-org.apache.beam.sdk.io.aws2.kinesis.RateLimitPolicyFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCustomRateLimitPolicy</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withCustomRateLimitPolicy(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/RateLimitPolicyFactory.html" title="interface in org.apache.beam.sdk.io.aws2.kinesis">RateLimitPolicyFactory</a> rateLimitPolicyFactory)</pre> |
| <div class="block">Specifies the <code>RateLimitPolicyFactory</code> for a custom rate limiter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rateLimitPolicyFactory</code> - Custom rate limit policy factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withMaxCapacityPerShard-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxCapacityPerShard</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisIO.Read</a> withMaxCapacityPerShard(java.lang.Integer maxCapacity)</pre> |
| <div class="block">Specifies the maximum number of messages per one shard.</div> |
| </li> |
| </ul> |
| <a name="expand-org.apache.beam.sdk.values.PBegin-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>expand</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisRecord.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisRecord</a>> expand(<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a> input)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>. |
| |
| <p>NOTE: This method should not be called directly. Instead apply the <code>PTransform</code> should |
| be applied to the <code>InputT</code> using the <code>apply</code> method. |
| |
| <p>Composite transforms, which are defined in terms of other transforms, should return the |
| output of one of the composed transforms. Non-composite transforms, which do not apply any |
| transforms internally, should return a new unbound output and register evaluators (via |
| backend-specific registration methods).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisRecord.html" title="class in org.apache.beam.sdk.io.aws2.kinesis">KinesisRecord</a>>></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/aws2/kinesis/KinesisIO.html" title="class in org.apache.beam.sdk.io.aws2.kinesis"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.RecordAggregation.html" title="class in org.apache.beam.sdk.io.aws2.kinesis"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/kinesis/KinesisIO.Read.html" target="_top">Frames</a></li> |
| <li><a href="KinesisIO.Read.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
