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

Class SqsIO.Read

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

SqsIO

public abstract static class SqsIO.Read
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.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, resourceHints

Constructor Summary

Constructors

Constructor	Description
Read()

Method Summary

Modifier and Type	Method	Description
org.apache.beam.sdk.values.PCollection<SqsMessage>	expand(org.apache.beam.sdk.values.PBegin input)
SqsIO.Read	withClientConfiguration(ClientConfiguration config)	Configuration of SQS client.
SqsIO.Read	withMaxNumRecords(long maxNumRecords)	Define the max number of records received by the SqsIO.Read.
SqsIO.Read	withMaxReadTime(org.joda.time.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(SqsClientProvider clientProvider)	Deprecated. Use withClientConfiguration(ClientConfiguration) instead.
SqsIO.Read	withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentials, java.lang.String region)	Deprecated. Use withClientConfiguration(ClientConfiguration) instead.
SqsIO.Read	withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentials, java.lang.String region, java.net.URI endpoint)	Deprecated. Use withClientConfiguration(ClientConfiguration) instead.

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

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setResourceHints, toString, validate, 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(org.joda.time.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

@Deprecated
public SqsIO.Read withSqsClientProvider(SqsClientProvider clientProvider)

Deprecated.

Use withClientConfiguration(ClientConfiguration) instead. Alternatively you can configure a custom ClientBuilderFactory in AwsOptions.

withSqsClientProvider

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

Deprecated.

Use withClientConfiguration(ClientConfiguration) instead.

withSqsClientProvider

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

Deprecated.

Use withClientConfiguration(ClientConfiguration) instead.

withClientConfiguration

public SqsIO.Read withClientConfiguration(ClientConfiguration config)

Configuration of SQS client.

expand

public org.apache.beam.sdk.values.PCollection<SqsMessage> expand(org.apache.beam.sdk.values.PBegin input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<SqsMessage>>