org.apache.beam.sdk.io.aws2.sns

Class SnsIO

java.lang.Object

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

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

PTransforms for writing to SNS.

Writing to SNS Synchronously

Example usage:

 PCollection<String> data = ...;

 data.apply(SnsIO.<String>write()
     .withPublishRequestFn(m -> PublishRequest.builder().topicArn("topicArn").message(m).build())
     .withTopicArn("topicArn")
     .withRetryConfiguration(
        SnsIO.RetryConfiguration.create(
          4, org.joda.time.Duration.standardSeconds(10)))
     .withSnsClientProvider(new BasicSnsClientProvider(awsCredentialsProvider, region));
 

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

• SNS topic arn you're going to publish to
• Retry Configuration
• AwsCredentialsProvider, which you can pass on to BasicSnsClientProvider
• publishRequestFn, a function to convert your message into PublishRequest

Writing to SNS Asynchronously

Example usage:

 PCollection<String> data = ...;

 data.apply(SnsIO.<String>writeAsync()
 		.withElementCoder(StringUtf8Coder.of())
 		.withPublishRequestFn(createPublishRequestFn())
 		.withSnsClientProvider(new BasicSnsClientProvider(awsCredentialsProvider, region));

 

 PCollection<String> data = ...;

 PCollection<SnsResponse<String>> responses = data.apply(SnsIO.<String>writeAsync()
      .withElementCoder(StringUtf8Coder.of())
      .withPublishRequestFn(createPublishRequestFn())
  *   .withSnsClientProvider(new BasicSnsClientProvider(awsCredentialsProvider, region));

 

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

• Coder for element T.
• publishRequestFn, a function to convert your message into PublishRequest
• SnsClientProvider, a provider to create an async client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnsIO.RetryConfiguration A POJO encapsulating a configuration for retry behavior when issuing requests to SNS.
protected static class	SnsIO.SnsWriteException Exception class for SNS write exceptions.
static class	SnsIO.Write<T> Implementation of write().
static class	SnsIO.WriteAsync<T> Implementation of writeAsync().

Constructor Summary

Constructors

Constructor and Description
SnsIO()

Method Summary

Modifier and Type	Method and Description
static <T> SnsIO.Write<T>	write()
static <T> SnsIO.WriteAsync<T>	writeAsync()

Methods inherited from class java.lang.Object

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

Constructor Detail

SnsIO

public SnsIO()

Method Detail

write

public static <T> SnsIO.Write<T> write()

writeAsync

public static <T> SnsIO.WriteAsync<T> writeAsync()