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

Example usage:

 PCollection<String> data = ...;

 data.apply(SnsIO.<String>write()
     .withTopicArn("topicArn")
     .withPublishRequestBuilder(m -> PublishRequest.builder().message(m))
     .withSnsClientProvider(awsCredentialsProvider, region));
 

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

• SNS topic ARN you're going to publish to (optional, but required for most use cases)
• Builder function to create SNS publish requests from your input
• AWS credentials provider and region for the SNS client provider

By default, the output PublishResponse contains only the SNS messageId, all other fields are null. If you need to include the full SdkHttpResponse and AwsResponseMetadata, you can call SnsIO.Write.withFullPublishResponse(). If you need the HTTP status code only but no headers, you can use SnsIO.Write.withFullPublishResponseWithoutHeaders().

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> Deprecated. Please use write() to avoid the risk of data loss.

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() Deprecated. Please use write() to avoid the risk of data loss.

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

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

Deprecated. Please use write() to avoid the risk of data loss.

See Also:

BEAM-13824, BEAM-13203