blob: 5acca81ef8f26d55f8c74fc1c0b83cf5e69848a0 [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>SqsIO.Read (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="SqsIO.Read (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":42,"i6":42,"i7":42};
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/sqs/SqsIO.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Write.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" target="_top">Frames</a></li>
<li><a href="SqsIO.Read.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a>&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.aws2.sqs</div>
<h2 title="Class SqsIO.Read" class="title">Class SqsIO.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>&lt;<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>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsMessage.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsMessage</a>&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.aws2.sqs.SqsIO.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/sqs/SqsIO.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO</a></dd>
</dl>
<hr>
<br>
<pre>public abstract static class <span class="typeNameLabel">SqsIO.Read</span>
extends <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>&lt;<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>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsMessage.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsMessage</a>&gt;&gt;</pre>
<div class="block">A <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read/receive messages from SQS. See <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO</code></a> for more information
on usage and configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.io.aws2.sqs.SqsIO.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&nbsp;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">&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/aws2/sqs/SqsIO.Read.html#Read--">Read</a></span>()</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsMessage.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsMessage</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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>&nbsp;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/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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>&nbsp;config)</code>
<div class="block">Configuration of SQS client.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html#withMaxNumRecords-long-">withMaxNumRecords</a></span>(long&nbsp;maxNumRecords)</code>
<div class="block">Define the max number of records received by the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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>&nbsp;maxReadTime)</code>
<div class="block">Define the max read time (duration) while the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a> will receive messages.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html#withQueueUrl-java.lang.String-">withQueueUrl</a></span>(java.lang.String&nbsp;queueUrl)</code>
<div class="block">Define the queueUrl used by the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a> to receive messages from SQS.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html#withSqsClientProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-java.lang.String-">withSqsClientProvider</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>&nbsp;credentials,
java.lang.String&nbsp;region)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html#withSqsClientProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-java.lang.String-java.net.URI-">withSqsClientProvider</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>&nbsp;credentials,
java.lang.String&nbsp;region,
java.net.URI&nbsp;endpoint)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html#withSqsClientProvider-org.apache.beam.sdk.io.aws2.sqs.SqsClientProvider-">withSqsClientProvider</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsClientProvider.html" title="interface in org.apache.beam.sdk.io.aws2.sqs">SqsClientProvider</a>&nbsp;clientProvider)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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>
</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&nbsp;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></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, 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&nbsp;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="withMaxNumRecords-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withMaxNumRecords</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a>&nbsp;withMaxNumRecords(long&nbsp;maxNumRecords)</pre>
<div class="block">Define the max number of records received by the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a>. When the max number of records
is lower than <code>Long.MAX_VALUE</code>, the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a> will provide a bounded <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div>
</li>
</ul>
<a name="withMaxReadTime-org.joda.time.Duration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withMaxReadTime</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a>&nbsp;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>&nbsp;maxReadTime)</pre>
<div class="block">Define the max read time (duration) while the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a> will receive messages. When this
max read time is not null, the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a> will provide a bounded <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div>
</li>
</ul>
<a name="withQueueUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withQueueUrl</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a>&nbsp;withQueueUrl(java.lang.String&nbsp;queueUrl)</pre>
<div class="block">Define the queueUrl used by the <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><code>SqsIO.Read</code></a> to receive messages from SQS.</div>
</li>
</ul>
<a name="withSqsClientProvider-org.apache.beam.sdk.io.aws2.sqs.SqsClientProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSqsClientProvider</h4>
<pre>@Deprecated
public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a>&nbsp;withSqsClientProvider(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsClientProvider.html" title="interface in org.apache.beam.sdk.io.aws2.sqs">SqsClientProvider</a>&nbsp;clientProvider)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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="withSqsClientProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSqsClientProvider</h4>
<pre>@Deprecated
public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a>&nbsp;withSqsClientProvider(<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>&nbsp;credentials,
java.lang.String&nbsp;region)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html#withClientConfiguration-org.apache.beam.sdk.io.aws2.common.ClientConfiguration-"><code>withClientConfiguration(ClientConfiguration)</code></a> instead.</span></div>
</li>
</ul>
<a name="withSqsClientProvider-software.amazon.awssdk.auth.credentials.AwsCredentialsProvider-java.lang.String-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSqsClientProvider</h4>
<pre>@Deprecated
public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a>&nbsp;withSqsClientProvider(<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>&nbsp;credentials,
java.lang.String&nbsp;region,
java.net.URI&nbsp;endpoint)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.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&nbsp;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsIO.Read</a>&nbsp;withClientConfiguration(<a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/ClientConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common">ClientConfiguration</a>&nbsp;config)</pre>
<div class="block">Configuration of SQS client.</div>
</li>
</ul>
<a name="expand-org.apache.beam.sdk.values.PBegin-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>expand</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsMessage.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsMessage</a>&gt;&nbsp;expand(<a href="../../../../../../../org/apache/beam/sdk/values/PBegin.html" title="class in org.apache.beam.sdk.values">PBegin</a>&nbsp;input)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>&lt;<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>&lt;<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsMessage.html" title="class in org.apache.beam.sdk.io.aws2.sqs">SqsMessage</a>&gt;&gt;</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/sqs/SqsIO.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/SqsIO.Write.html" title="class in org.apache.beam.sdk.io.aws2.sqs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/sqs/SqsIO.Read.html" target="_top">Frames</a></li>
<li><a href="SqsIO.Read.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a>&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>