Package 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:
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:

  • Constructor Details

    • Read

      public Read()

  • Method Details

    • 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(String queueUrl)
      Define the queueUrl used by the SqsIO.Read to receive messages from SQS.

    • withClientConfiguration

      public SqsIO.Read withClientConfiguration(ClientConfiguration config)
      Configuration of SQS client.

    • 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>>