org.apache.beam.sdk.io.aws2.sqs

Class SqsIO

java.lang.Object

org.apache.beam.sdk.io.aws2.sqs.SqsIO

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

An unbounded source for Amazon Simple Queue Service (SQS).

Reading from an SQS queue

The SqsIO SqsIO.Read returns an unbounded PCollection of Message containing the received messages. Note: This source does not currently advance the watermark when no new messages are received.

To configure an SQS source, you have to provide the queueUrl to connect to. The following example illustrates how to configure the source:

 pipeline.apply(SqsIO.read().withQueueUrl(queueUrl))
 

Writing to an SQS queue

The following example illustrates how to use the sink:

 pipeline
   .apply(...) // returns PCollection<SendMessageRequest>
   .apply(SqsIO.write())
 

Additional Configuration

Additional configuration can be provided via AwsCredentialsProvider in code. For example, if you wanted to provide a secret access key via code:

 AwsCredentialsProvider provider = StaticCredentialsProvider.create(
    AwsBasicCredentials.create(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
 pipeline
   .apply(...) // returns PCollection<SendMessageRequest>
   .apply(SqsIO.write().withSqsClientProvider(provider))
 

For more information on the available options see AwsOptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqsIO.Read A PTransform to read/receive messages from SQS.
static class	SqsIO.Write A PTransform to send messages to SQS.

Method Summary

Modifier and Type	Method and Description
static SqsIO.Read	read()
static SqsIO.Write	write()

Methods inherited from class java.lang.Object

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

Method Detail

read

public static SqsIO.Read read()

write

public static SqsIO.Write write()