org.apache.beam.sdk.io.aws2.sns

Class SnsIO.Write<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<T>,PCollection<PublishResponse>>

org.apache.beam.sdk.io.aws2.sns.SnsIO.Write<T>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

SnsIO

public abstract static class SnsIO.Write<T>
extends PTransform<PCollection<T>,PCollection<PublishResponse>>

Implementation of SnsIO.write().

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
PCollection<PublishResponse>	expand(PCollection<T> input) Override this method to specify how this PTransform should be expanded on the given InputT.
SnsIO.Write<T>	withCoder(Coder<PublishResponse> coder) Encode the PublishResult with the given coder.
SnsIO.Write<T>	withFullPublishResponse() Encode the full PublishResult object, including sdkResponseMetadata and sdkHttpMetadata with the HTTP response headers.
SnsIO.Write<T>	withFullPublishResponseWithoutHeaders() Encode the full PublishResult object, including sdkResponseMetadata and sdkHttpMetadata but excluding the HTTP response headers.
SnsIO.Write<T>	withPublishRequestFn(SerializableFunction<T,PublishRequest> publishRequestFn) Specify a function for converting a message into PublishRequest object, this function is mandatory.
SnsIO.Write<T>	withRetryConfiguration(SnsIO.RetryConfiguration retryConfiguration) Provides configuration to retry a failed request to publish a message to SNS.
SnsIO.Write<T>	withSnsClientProvider(AwsCredentialsProvider credentialsProvider, java.lang.String region) Specify AwsCredentialsProvider and region to be used to write to SNS.
SnsIO.Write<T>	withSnsClientProvider(AwsCredentialsProvider credentialsProvider, java.lang.String region, java.net.URI serviceEndpoint) Specify AwsCredentialsProvider and region to be used to write to SNS.
SnsIO.Write<T>	withSnsClientProvider(SnsClientProvider awsClientsProvider) Allows to specify custom SnsClientProvider.
SnsIO.Write<T>	withTopicArn(java.lang.String topicArn) Specify the SNS topic which will be used for writing, this name is mandatory.

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

withTopicArn

public SnsIO.Write<T> withTopicArn(java.lang.String topicArn)

Specify the SNS topic which will be used for writing, this name is mandatory.

Parameters:

topicArn - topicArn

withPublishRequestFn

public SnsIO.Write<T> withPublishRequestFn(SerializableFunction<T,PublishRequest> publishRequestFn)

Specify a function for converting a message into PublishRequest object, this function is mandatory.

Parameters:

publishRequestFn - publishRequestFn

withSnsClientProvider

public SnsIO.Write<T> withSnsClientProvider(SnsClientProvider awsClientsProvider)

Allows to specify custom SnsClientProvider. SnsClientProvider creates new SnsClient which is later used for writing to a SNS topic.

withSnsClientProvider

public SnsIO.Write<T> withSnsClientProvider(AwsCredentialsProvider credentialsProvider,
                                            java.lang.String region)

Specify AwsCredentialsProvider and region to be used to write to SNS. If you need more sophisticated credential protocol, then you should look at withSnsClientProvider(SnsClientProvider).

withSnsClientProvider

public SnsIO.Write<T> withSnsClientProvider(AwsCredentialsProvider credentialsProvider,
                                            java.lang.String region,
                                            java.net.URI serviceEndpoint)

Specify AwsCredentialsProvider and region to be used to write to SNS. If you need more sophisticated credential protocol, then you should look at withSnsClientProvider(SnsClientProvider).

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

withRetryConfiguration

public SnsIO.Write<T> withRetryConfiguration(SnsIO.RetryConfiguration retryConfiguration)

Provides configuration to retry a failed request to publish a message to SNS. Users should consider that retrying might compound the underlying problem which caused the initial failure. Users should also be aware that once retrying is exhausted the error is surfaced to the runner which may then opt to retry the current partition in entirety or abort if the max number of retries of the runner is completed. Retrying uses an exponential backoff algorithm, with minimum backoff of 5 seconds and then surfacing the error once the maximum number of retries or maximum configuration duration is exceeded.

Example use:

 SnsIO.write()
   .withRetryConfiguration(SnsIO.RetryConfiguration.create(5, Duration.standardMinutes(1))
   ...
 

Parameters:

retryConfiguration - the rules which govern the retry behavior

Returns:

the SnsIO.Write with retrying configured

withFullPublishResponse

public SnsIO.Write<T> withFullPublishResponse()

Encode the full PublishResult object, including sdkResponseMetadata and sdkHttpMetadata with the HTTP response headers.

withFullPublishResponseWithoutHeaders

public SnsIO.Write<T> withFullPublishResponseWithoutHeaders()

Encode the full PublishResult object, including sdkResponseMetadata and sdkHttpMetadata but excluding the HTTP response headers.

withCoder

public SnsIO.Write<T> withCoder(Coder<PublishResponse> coder)

Encode the PublishResult with the given coder.

expand

public PCollection<PublishResponse> expand(PCollection<T> 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<T>,PCollection<PublishResponse>>