org.apache.beam.sdk.io.aws.sns

Class SnsIO.Write

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<PublishRequest>,PCollectionTuple>

org.apache.beam.sdk.io.aws.sns.SnsIO.Write

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

SnsIO

public abstract static class SnsIO.Write
extends PTransform<PCollection<PublishRequest>,PCollectionTuple>

Implementation of SnsIO.write().

See Also:

Serialized Form

Field Summary

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
PCollectionTuple	expand(PCollection<PublishRequest> input) Override this method to specify how this PTransform should be expanded on the given InputT.
SnsIO.Write	withAWSClientsProvider(AwsClientsProvider awsClientsProvider) Allows to specify custom AwsClientsProvider.
SnsIO.Write	withAWSClientsProvider(java.lang.String awsAccessKey, java.lang.String awsSecretKey, Regions region) Specify credential details and region to be used to write to SNS.
SnsIO.Write	withAWSClientsProvider(java.lang.String awsAccessKey, java.lang.String awsSecretKey, Regions region, java.lang.String serviceEndpoint) Specify credential details and region to be used to write to SNS.
SnsIO.Write	withCoder(Coder<PublishResult> coder) Encode the PublishResult with the given coder.
SnsIO.Write	withFullPublishResult() Encode the full PublishResult object, including sdkResponseMetadata and sdkHttpMetadata with the HTTP response headers.
SnsIO.Write	withFullPublishResultWithoutHeaders() Encode the full PublishResult object, including sdkResponseMetadata and sdkHttpMetadata but excluding the HTTP response headers.
SnsIO.Write	withResultOutputTag(TupleTag<PublishResult> results) Tuple tag to store results.
SnsIO.Write	withRetryConfiguration(SnsIO.RetryConfiguration retryConfiguration) Provides configuration to retry a failed request to publish a message to SNS.
SnsIO.Write	withTopicName(java.lang.String topicName) Specify the SNS topic which will be used for writing, this name is mandatory.

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

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setDisplayData, setResourceHints, toString, validate, 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

withTopicName

public SnsIO.Write withTopicName(java.lang.String topicName)

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

Parameters:

topicName - topicName

withAWSClientsProvider

public SnsIO.Write withAWSClientsProvider(AwsClientsProvider awsClientsProvider)

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

withAWSClientsProvider

public SnsIO.Write withAWSClientsProvider(java.lang.String awsAccessKey,
                                          java.lang.String awsSecretKey,
                                          Regions region)

Specify credential details and region to be used to write to SNS. If you need more sophisticated credential protocol, then you should look at withAWSClientsProvider(AwsClientsProvider).

withAWSClientsProvider

public SnsIO.Write withAWSClientsProvider(java.lang.String awsAccessKey,
                                          java.lang.String awsSecretKey,
                                          Regions region,
                                          java.lang.String serviceEndpoint)

Specify credential details and region to be used to write to SNS. If you need more sophisticated credential protocol, then you should look at withAWSClientsProvider(AwsClientsProvider).

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

withRetryConfiguration

public SnsIO.Write 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

withResultOutputTag

public SnsIO.Write withResultOutputTag(TupleTag<PublishResult> results)

Tuple tag to store results. Mandatory field.

withFullPublishResult

public SnsIO.Write withFullPublishResult()

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

withFullPublishResultWithoutHeaders

public SnsIO.Write withFullPublishResultWithoutHeaders()

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

withCoder

public SnsIO.Write withCoder(Coder<PublishResult> coder)

Encode the PublishResult with the given coder.

expand

public PCollectionTuple expand(PCollection<PublishRequest> 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<PublishRequest>,PCollectionTuple>