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>	withClientConfiguration(ClientConfiguration config) Configuration of SNS client.
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>	withPublishRequestBuilder(SerializableFunction<T,PublishRequest.Builder> requestBuilder) Function to convert a message into a PublishRequest.Builder (mandatory).
SnsIO.Write<T>	withPublishRequestFn(SerializableFunction<T,PublishRequest> publishRequestFn) Deprecated. Use withPublishRequestBuilder(SerializableFunction) instead.
SnsIO.Write<T>	withRetryConfiguration(SnsIO.RetryConfiguration retry) Deprecated. Use withClientConfiguration(ClientConfiguration) with RetryConfiguration instead to delegate retries to the AWS SDK.
SnsIO.Write<T>	withSnsClientProvider(AwsCredentialsProvider credentials, java.lang.String region) Deprecated. Use withClientConfiguration(ClientConfiguration) instead.
SnsIO.Write<T>	withSnsClientProvider(AwsCredentialsProvider credentials, java.lang.String region, java.net.URI endpoint) Deprecated. Use withClientConfiguration(ClientConfiguration) instead.
SnsIO.Write<T>	withSnsClientProvider(SnsClientProvider clientProvider) Deprecated. Use withClientConfiguration(ClientConfiguration) instead. Alternatively you can configure a custom ClientBuilderFactory in AwsOptions.
SnsIO.Write<T>	withTopicArn(java.lang.String topicArn) SNS topic ARN used for publishing to SNS.

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)

SNS topic ARN used for publishing to SNS.

The topic ARN is optional. If set, its existence will be validated and the SNS publish request will be configured accordingly.

withPublishRequestBuilder

public SnsIO.Write<T> withPublishRequestBuilder(SerializableFunction<T,PublishRequest.Builder> requestBuilder)

Function to convert a message into a PublishRequest.Builder (mandatory).

If an SNS topic arn is set, it will be automatically set on the PublishRequest.Builder.

withPublishRequestFn

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

Deprecated. Use withPublishRequestBuilder(SerializableFunction) instead.

Specify a function for converting a message into PublishRequest object.

withSnsClientProvider

@Deprecated
public SnsIO.Write<T> withSnsClientProvider(SnsClientProvider clientProvider)

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

withSnsClientProvider

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

Deprecated. Use withClientConfiguration(ClientConfiguration) instead.

withSnsClientProvider

@Deprecated
public SnsIO.Write<T> withSnsClientProvider(AwsCredentialsProvider credentials,
                                                        java.lang.String region,
                                                        java.net.URI endpoint)

Deprecated. Use withClientConfiguration(ClientConfiguration) instead.

withClientConfiguration

public SnsIO.Write<T> withClientConfiguration(ClientConfiguration config)

Configuration of SNS client.

withRetryConfiguration

@Deprecated
public SnsIO.Write<T> withRetryConfiguration(SnsIO.RetryConfiguration retry)

Deprecated. Use withClientConfiguration(ClientConfiguration) with RetryConfiguration instead to delegate retries to the AWS SDK.

Retry configuration of SNS client.

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