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

Class SqsIO.Write

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<software.amazon.awssdk.services.sqs.model.SendMessageRequest>,org.apache.beam.sdk.values.PDone>

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

All Implemented Interfaces:

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

Enclosing class:

SqsIO

public abstract static class SqsIO.Write
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<software.amazon.awssdk.services.sqs.model.SendMessageRequest>,org.apache.beam.sdk.values.PDone>

A PTransform to send messages to 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 and Description
Write()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PDone	expand(org.apache.beam.sdk.values.PCollection<software.amazon.awssdk.services.sqs.model.SendMessageRequest> input)
SqsIO.Write	withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, java.lang.String region) Specify AwsCredentialsProvider and region to be used to write to SQS.
SqsIO.Write	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.Write	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, getResourceHints, populateDisplayData, setResourceHints, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

withSqsClientProvider

public SqsIO.Write 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.Write withSqsClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
                                         java.lang.String region)

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

withSqsClientProvider

public SqsIO.Write 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 org.apache.beam.sdk.values.PDone expand(org.apache.beam.sdk.values.PCollection<software.amazon.awssdk.services.sqs.model.SendMessageRequest> input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<software.amazon.awssdk.services.sqs.model.SendMessageRequest>,org.apache.beam.sdk.values.PDone>