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

Class SqsIO.Read

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<SqsMessage>>

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

SqsIO

public abstract static class SqsIO.Read
extends PTransform<PBegin,PCollection<SqsMessage>>

A PTransform to read/receive messages from SQS. See SqsIO for more information on usage and configuration.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
PCollection<SqsMessage>	expand(PBegin input) Override this method to specify how this PTransform should be expanded on the given InputT.
SqsIO.Read	withMaxNumRecords(long maxNumRecords) Define the max number of records received by the SqsIO.Read.
SqsIO.Read	withMaxReadTime(Duration maxReadTime) Define the max read time (duration) while the SqsIO.Read will receive messages.
SqsIO.Read	withQueueUrl(java.lang.String queueUrl) Define the queueUrl used by the SqsIO.Read to receive messages from SQS.
SqsIO.Read	withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, java.lang.String region) Specify AwsCredentialsProvider and region to be used to read from SQS.
SqsIO.Read	withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, java.lang.String region, java.net.URI serviceEndpoint) Specify AwsCredentialsProvider and region to be used to write to SQS.
SqsIO.Read	withSqsClientProvider(SqsClientProvider awsClientsProvider) Allows to specify custom SqsClientProvider.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, populateDisplayData, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Read

public Read()

Method Detail

withMaxNumRecords

public SqsIO.Read withMaxNumRecords(long maxNumRecords)

Define the max number of records received by the SqsIO.Read. When the max number of records is lower than Long.MAX_VALUE, the SqsIO.Read will provide a bounded PCollection.

withMaxReadTime

public SqsIO.Read withMaxReadTime(Duration maxReadTime)

Define the max read time (duration) while the SqsIO.Read will receive messages. When this max read time is not null, the SqsIO.Read will provide a bounded PCollection.

withQueueUrl

public SqsIO.Read withQueueUrl(java.lang.String queueUrl)

Define the queueUrl used by the SqsIO.Read to receive messages from SQS.

withSqsClientProvider

public SqsIO.Read withSqsClientProvider(SqsClientProvider awsClientsProvider)

Allows to specify custom SqsClientProvider. SqsClientProvider creates new SqsClient which is later used for writing to a SqS queue.

withSqsClientProvider

public SqsIO.Read withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
                                        java.lang.String region)

Specify AwsCredentialsProvider and region to be used to read from SQS. If you need more sophisticated credential protocol, then you should look at withSqsClientProvider(SqsClientProvider).

withSqsClientProvider

public SqsIO.Read withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
                                        java.lang.String region,
                                        java.net.URI serviceEndpoint)

Specify AwsCredentialsProvider and region to be used to write to SQS. If you need more sophisticated credential protocol, then you should look at withSqsClientProvider(SqsClientProvider).

The serviceEndpoint sets an alternative service host. This is useful to execute the tests with Kinesis service emulator.

expand

public PCollection<SqsMessage> expand(PBegin input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

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).

Specified by:

expand in class PTransform<PBegin,PCollection<SqsMessage>>