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

Class SqsIO.Write

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<SendMessageRequest>,PDone>

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

SqsIO

public abstract static class SqsIO.Write
extends PTransform<PCollection<SendMessageRequest>,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

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
PDone	expand(PCollection<SendMessageRequest> input) Override this method to specify how this PTransform should be expanded on the given InputT.
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, populateDisplayData, 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 PDone expand(PCollection<SendMessageRequest> 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<PCollection<SendMessageRequest>,PDone>