org.apache.beam.sdk.io.aws.sns

Class SnsIO

java.lang.Object

org.apache.beam.sdk.io.aws.sns.SnsIO

Deprecated.

Module beam-sdks-java-io-amazon-web-services is deprecated and will be eventually removed. Please migrate to SnsIO in module beam-sdks-java-io-amazon-web-services2.

@Experimental(value=SOURCE_SINK)
 @Deprecated
public final class SnsIO
extends java.lang.Object

PTransforms for writing to SNS.

Writing to SNS

Example usage:

 PCollection<PublishRequest> data = ...;

 data.apply(SnsIO.write()
     .withTopicName("topicName")
     .withRetryConfiguration(
        SnsIO.RetryConfiguration.create(
          4, org.joda.time.Duration.standardSeconds(10)))
     .withAWSClientsProvider(new BasicSnsProvider(accessKey, secretKey, region))
     .withResultOutputTag(results));
 

As a client, you need to provide at least the following things:

• name of the SNS topic you're going to write to
• retry configuration
• need to specify AwsClientsProvider. You can pass on the default one BasicSnsProvider
• an output tag where you can get results. Example in SnsIOTest

By default, the output PublishResult contains only the messageId, all other fields are null. If you need the full ResponseMetadata and SdkHttpMetadata you can call SnsIO.Write.withFullPublishResult(). If you need the HTTP status code but not the response headers you can call SnsIO.Write.withFullPublishResultWithoutHeaders().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnsIO.RetryConfiguration Deprecated. A POJO encapsulating a configuration for retry behavior when issuing requests to SNS.
static class	SnsIO.Write Deprecated. Implementation of write().

Constructor Summary

Constructors

Constructor and Description
SnsIO() Deprecated.

Method Summary

Modifier and Type	Method and Description
static SnsIO.Write	write() Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnsIO

public SnsIO()

Deprecated.

Method Detail

write

public static SnsIO.Write write()

Deprecated.