blob: faaccb7c87bfce69fc741c9a4c373ae329f03813 [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>org.apache.beam.sdk.io.aws2.sns (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="org.apache.beam.sdk.io.aws2.sns (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/s3/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/sns/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p><a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.io.aws2.sns</h1>
<div class="docSummary">
<div class="block">Defines IO connectors for Amazon Web Services SNS.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsAsyncClientProvider.html" title="interface in org.apache.beam.sdk.io.aws2.sns">SnsAsyncClientProvider</a></td>
<td class="colLast">
<div class="block">Provides instances of Asynchronous SNS client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsClientProvider.html" title="interface in org.apache.beam.sdk.io.aws2.sns">SnsClientProvider</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">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>
using <a href="../../../../../../../org/apache/beam/sdk/io/aws2/options/AwsOptions.html#getClientBuilderFactory--"><code>AwsOptions.getClientBuilderFactory()</code></a> instead.</span></div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/PublishResponseCoders.html" title="class in org.apache.beam.sdk.io.aws2.sns">PublishResponseCoders</a></td>
<td class="colLast">
<div class="block">Coders for SNS <a href="https://static.javadoc.io/software.amazon.awssdk/sns/2.17.127/software/amazon/awssdk/services/sns/model/PublishResponse.html?is-external=true" title="class or interface in software.amazon.awssdk.services.sns.model"><code>PublishResponse</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsCoderProviderRegistrar.html" title="class in org.apache.beam.sdk.io.aws2.sns">SnsCoderProviderRegistrar</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../../org/apache/beam/sdk/coders/CoderProviderRegistrar.html" title="interface in org.apache.beam.sdk.coders"><code>CoderProviderRegistrar</code></a> for standard types used with <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html" title="class in org.apache.beam.sdk.io.aws2.sns"><code>SnsIO</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html" title="class in org.apache.beam.sdk.io.aws2.sns">SnsIO</a></td>
<td class="colLast">
<div class="block">IO to send notifications via <a href="https://aws.amazon.com/sns/">SNS</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.sns">SnsIO.RetryConfiguration</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/common/RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.common"><code>RetryConfiguration</code></a> instead to
delegate retries to the AWS SDK.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws2.sns">SnsIO.Write</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#write--"><code>SnsIO.write()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.WriteAsync.html" title="class in org.apache.beam.sdk.io.aws2.sns">SnsIO.WriteAsync</a>&lt;T&gt;</td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Please use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#write--"><code>SnsIO.write()</code></a> to avoid the risk of data loss.</span></div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.SnsWriteException.html" title="class in org.apache.beam.sdk.io.aws2.sns">SnsIO.SnsWriteException</a></td>
<td class="colLast">
<div class="block">Exception class for SNS write exceptions.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.io.aws2.sns Description">Package org.apache.beam.sdk.io.aws2.sns Description</h2>
<div class="block">Defines IO connectors for Amazon Web Services SNS.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/s3/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sqs/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/sns/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>