| <!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>SnsIO (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="SnsIO (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":41}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/sns/SnsCoderProviderRegistrar.html" title="class in org.apache.beam.sdk.io.aws2.sns"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.sns"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/sns/SnsIO.html" target="_top">Frames</a></li> |
| <li><a href="SnsIO.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </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.sns</div> |
| <h2 title="Class SnsIO" class="title">Class SnsIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.aws2.sns.SnsIO</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><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>) |
| public final class <span class="typeNameLabel">SnsIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">IO to send notifications via <a href="https://aws.amazon.com/sns/">SNS</a>. |
| |
| <h3>Writing to SNS</h3> |
| |
| <p>Example usage: |
| |
| <pre><code> |
| PCollection<String> data = ...; |
| data.apply(SnsIO.<String>write() |
| .withTopicArn("topicArn") |
| .withPublishRequestBuilder(msg -> PublishRequest.builder().message(msg))); |
| </code></pre> |
| |
| <p>At a minimum you have to provide: |
| |
| <ul> |
| <li>SNS topic ARN you're going to publish to (optional, but required for most use cases) |
| <li>Request builder function to create SNS publish requests from your input |
| </ul> |
| |
| <p>By default, the output <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> contains only the SNS messageId, all other |
| fields are null. If you need to include the full <code>SdkHttpResponse</code> and <a href="https://static.javadoc.io/software.amazon.awssdk/aws-core/2.17.127/software/amazon/awssdk/awscore/AwsResponseMetadata.html?is-external=true" title="class or interface in software.amazon.awssdk.awscore"><code>AwsResponseMetadata</code></a>, you can call <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.Write.html#withFullPublishResponse--"><code>SnsIO.Write.withFullPublishResponse()</code></a>. If you need the HTTP |
| status code only but no headers, you can use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.Write.html#withFullPublishResponseWithoutHeaders--"><code>SnsIO.Write.withFullPublishResponseWithoutHeaders()</code></a>. |
| |
| <h3>Configuration of AWS clients</h3> |
| |
| <p>AWS clients for all AWS IOs can be configured using <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>, e.g. <code>--awsRegion=us-west-1</code>. <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> contain reasonable defaults based on default providers |
| for <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"><code>Region</code></a> and <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"><code>AwsCredentialsProvider</code></a>. |
| |
| <p>If you require more advanced configuration, you may change the <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#setClientBuilderFactory-java.lang.Class-"><code>AwsOptions.setClientBuilderFactory(Class)</code></a>. |
| |
| <p>Configuration for a specific IO can be overwritten using <code>withClientConfiguration()</code>, |
| which also allows to configure the retry behavior for the respective IO. |
| |
| <h4>Retries</h4> |
| |
| <p>Retries for failed requests can be configured using <code>ClientConfiguration.Builder#retry(Consumer)</code> and are handled by the AWS SDK unless there's a |
| partial success (batch requests). The SDK uses a backoff strategy with equal jitter for computing |
| the delay before the next retry. |
| |
| <p><b>Note:</b> Once retries are exhausted the error is surfaced to the runner which <em>may</em> |
| then opt to retry the current partition in entirety or abort if the max number of retries of the |
| runner is reached.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <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> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span></code> |
| <div class="block">Exception class for SNS write exceptions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.Write.html" title="type parameter in SnsIO.Write">T</a>></span></code> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#write--"><code>write()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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><<a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.WriteAsync.html" title="type parameter in SnsIO.WriteAsync">T</a>></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Please use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#write--"><code>write()</code></a> to avoid the risk of data loss.</span></div> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </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/sns/SnsIO.html#SnsIO--">SnsIO</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <T> <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><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#write--">write</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T> <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><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#writeAsync--">writeAsync</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Please use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#write--"><code>write()</code></a> to avoid the risk of data loss.</span></div> |
| </div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SnsIO--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SnsIO</h4> |
| <pre>public SnsIO()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="write--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public static <T> <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><T> write()</pre> |
| </li> |
| </ul> |
| <a name="writeAsync--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeAsync</h4> |
| <pre>@Deprecated |
| public static <T> <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><T> writeAsync()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Please use <a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.html#write--"><code>write()</code></a> to avoid the risk of data loss.</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://issues.apache.org/jira/browse/BEAM-13824">BEAM-13824</a>, <a |
| href="https://issues.apache.org/jira/browse/BEAM-13203">BEAM-13203</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsCoderProviderRegistrar.html" title="class in org.apache.beam.sdk.io.aws2.sns"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws2/sns/SnsIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws2.sns"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws2/sns/SnsIO.html" target="_top">Frames</a></li> |
| <li><a href="SnsIO.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </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> |
