| <!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.Write (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.Write (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws.sns"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" target="_top">Frames</a></li> |
| <li><a href="SnsIO.Write.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.aws.sns</div> |
| <h2 title="Class SnsIO.Write" class="title">Class SnsIO.Write</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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishRequest.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishRequest</a>>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values">PCollectionTuple</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.aws.sns.SnsIO.Write</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/aws/sns/SnsIO.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">SnsIO.Write</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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishRequest.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishRequest</a>>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values">PCollectionTuple</a>></pre> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.html#write--"><code>SnsIO.write()</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.io.aws.sns.SnsIO.Write">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/aws/sns/SnsIO.Write.html#Write--">Write</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></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/PCollectionTuple.html" title="class in org.apache.beam.sdk.values">PCollectionTuple</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#expand-org.apache.beam.sdk.values.PCollection-">expand</a></span>(<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishRequest.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishRequest</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/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withAWSClientsProvider-org.apache.beam.sdk.io.aws.sns.AwsClientsProvider-">withAWSClientsProvider</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/AwsClientsProvider.html" title="interface in org.apache.beam.sdk.io.aws.sns">AwsClientsProvider</a> awsClientsProvider)</code> |
| <div class="block">Allows to specify custom <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/AwsClientsProvider.html" title="interface in org.apache.beam.sdk.io.aws.sns"><code>AwsClientsProvider</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withAWSClientsProvider-java.lang.String-java.lang.String-com.amazonaws.regions.Regions-">withAWSClientsProvider</a></span>(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-core/1.12.135/com/amazonaws/regions/Regions.html?is-external=true" title="class or interface in com.amazonaws.regions">Regions</a> region)</code> |
| <div class="block">Specify credential details and region to be used to write to SNS.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withAWSClientsProvider-java.lang.String-java.lang.String-com.amazonaws.regions.Regions-java.lang.String-">withAWSClientsProvider</a></span>(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-core/1.12.135/com/amazonaws/regions/Regions.html?is-external=true" title="class or interface in com.amazonaws.regions">Regions</a> region, |
| java.lang.String serviceEndpoint)</code> |
| <div class="block">Specify credential details and region to be used to write to SNS.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withCoder-org.apache.beam.sdk.coders.Coder-">withCoder</a></span>(<a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishResult.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishResult</a>> coder)</code> |
| <div class="block">Encode the <code>PublishResult</code> with the given coder.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withFullPublishResult--">withFullPublishResult</a></span>()</code> |
| <div class="block">Encode the full <code>PublishResult</code> object, including sdkResponseMetadata and |
| sdkHttpMetadata with the HTTP response headers.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withFullPublishResultWithoutHeaders--">withFullPublishResultWithoutHeaders</a></span>()</code> |
| <div class="block">Encode the full <code>PublishResult</code> object, including sdkResponseMetadata and |
| sdkHttpMetadata but excluding the HTTP response headers.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withResultOutputTag-org.apache.beam.sdk.values.TupleTag-">withResultOutputTag</a></span>(<a href="../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishResult.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishResult</a>> results)</code> |
| <div class="block">Tuple tag to store results.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withRetryConfiguration-org.apache.beam.sdk.io.aws.sns.SnsIO.RetryConfiguration-">withRetryConfiguration</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.RetryConfiguration</a> retryConfiguration)</code> |
| <div class="block">Provides configuration to retry a failed request to publish a message to SNS.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withTopicName-java.lang.String-">withTopicName</a></span>(java.lang.String topicName)</code> |
| <div class="block">Specify the SNS topic which will be used for writing, this name is mandatory.</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></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="Write--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Write</h4> |
| <pre>public Write()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withTopicName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTopicName</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withTopicName(java.lang.String topicName)</pre> |
| <div class="block">Specify the SNS topic which will be used for writing, this name is mandatory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topicName</code> - topicName</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-org.apache.beam.sdk.io.aws.sns.AwsClientsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withAWSClientsProvider(<a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/AwsClientsProvider.html" title="interface in org.apache.beam.sdk.io.aws.sns">AwsClientsProvider</a> awsClientsProvider)</pre> |
| <div class="block">Allows to specify custom <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/AwsClientsProvider.html" title="interface in org.apache.beam.sdk.io.aws.sns"><code>AwsClientsProvider</code></a>. <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/AwsClientsProvider.html" title="interface in org.apache.beam.sdk.io.aws.sns"><code>AwsClientsProvider</code></a> creates new |
| <a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/AmazonSNS.html?is-external=true" title="class or interface in com.amazonaws.services.sns"><code>AmazonSNS</code></a> which is later used for writing to a SNS topic.</div> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-java.lang.String-java.lang.String-com.amazonaws.regions.Regions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withAWSClientsProvider(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-core/1.12.135/com/amazonaws/regions/Regions.html?is-external=true" title="class or interface in com.amazonaws.regions">Regions</a> region)</pre> |
| <div class="block">Specify credential details and region to be used to write to SNS. If you need more |
| sophisticated credential protocol, then you should look at <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withAWSClientsProvider-org.apache.beam.sdk.io.aws.sns.AwsClientsProvider-"><code>withAWSClientsProvider(AwsClientsProvider)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withAWSClientsProvider-java.lang.String-java.lang.String-com.amazonaws.regions.Regions-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withAWSClientsProvider</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withAWSClientsProvider(java.lang.String awsAccessKey, |
| java.lang.String awsSecretKey, |
| <a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-core/1.12.135/com/amazonaws/regions/Regions.html?is-external=true" title="class or interface in com.amazonaws.regions">Regions</a> region, |
| java.lang.String serviceEndpoint)</pre> |
| <div class="block">Specify credential details and region to be used to write to SNS. If you need more |
| sophisticated credential protocol, then you should look at <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html#withAWSClientsProvider-org.apache.beam.sdk.io.aws.sns.AwsClientsProvider-"><code>withAWSClientsProvider(AwsClientsProvider)</code></a>. |
| |
| <p>The <code>serviceEndpoint</code> sets an alternative service host. This is useful to execute |
| the tests with Kinesis service emulator.</div> |
| </li> |
| </ul> |
| <a name="withRetryConfiguration-org.apache.beam.sdk.io.aws.sns.SnsIO.RetryConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withRetryConfiguration</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withRetryConfiguration(<a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.RetryConfiguration</a> retryConfiguration)</pre> |
| <div class="block">Provides configuration to retry a failed request to publish a message to SNS. Users should |
| consider that retrying might compound the underlying problem which caused the initial |
| failure. Users should also be aware that once retrying is 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 completed. Retrying uses an exponential backoff |
| algorithm, with minimum backoff of 5 seconds and then surfacing the error once the maximum |
| number of retries or maximum configuration duration is exceeded. |
| |
| <p>Example use: |
| |
| <pre><code> |
| SnsIO.write() |
| .withRetryConfiguration(SnsIO.RetryConfiguration.create(5, Duration.standardMinutes(1)) |
| ... |
| </code></pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>retryConfiguration</code> - the rules which govern the retry behavior</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns"><code>SnsIO.Write</code></a> with retrying configured</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withResultOutputTag-org.apache.beam.sdk.values.TupleTag-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withResultOutputTag</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withResultOutputTag(<a href="../../../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishResult.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishResult</a>> results)</pre> |
| <div class="block">Tuple tag to store results. Mandatory field.</div> |
| </li> |
| </ul> |
| <a name="withFullPublishResult--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFullPublishResult</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withFullPublishResult()</pre> |
| <div class="block">Encode the full <code>PublishResult</code> object, including sdkResponseMetadata and |
| sdkHttpMetadata with the HTTP response headers.</div> |
| </li> |
| </ul> |
| <a name="withFullPublishResultWithoutHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFullPublishResultWithoutHeaders</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withFullPublishResultWithoutHeaders()</pre> |
| <div class="block">Encode the full <code>PublishResult</code> object, including sdkResponseMetadata and |
| sdkHttpMetadata but excluding the HTTP response headers.</div> |
| </li> |
| </ul> |
| <a name="withCoder-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCoder</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" title="class in org.apache.beam.sdk.io.aws.sns">SnsIO.Write</a> withCoder(<a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishResult.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishResult</a>> coder)</pre> |
| <div class="block">Encode the <code>PublishResult</code> with the given coder.</div> |
| </li> |
| </ul> |
| <a name="expand-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>expand</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values">PCollectionTuple</a> expand(<a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishRequest.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishRequest</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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-sns/1.12.135/com/amazonaws/services/sns/model/PublishRequest.html?is-external=true" title="class or interface in com.amazonaws.services.sns.model">PublishRequest</a>>,<a href="../../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values">PCollectionTuple</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/aws/sns/SnsIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.aws.sns"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/aws/sns/SnsIO.Write.html" target="_top">Frames</a></li> |
| <li><a href="SnsIO.Write.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> |
