org.apache.beam.sdk.io.aws2.dynamodb

Class DynamoDBIO.Write<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<T>,PCollection<java.lang.Void>>

org.apache.beam.sdk.io.aws2.dynamodb.DynamoDBIO.Write<T>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

DynamoDBIO

public abstract static class DynamoDBIO.Write<T>
extends PTransform<PCollection<T>,PCollection<java.lang.Void>>

Write a PCollection data into DynamoDB.

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
PCollection<java.lang.Void>	expand(PCollection<T> input) Override this method to specify how this PTransform should be expanded on the given InputT.
DynamoDBIO.Write<T>	withDeduplicateKeys(java.util.List<java.lang.String> deduplicateKeys)
DynamoDBIO.Write<T>	withDynamoDbClientProvider(AwsCredentialsProvider credentialsProvider, java.lang.String region)
DynamoDBIO.Write<T>	withDynamoDbClientProvider(AwsCredentialsProvider credentialsProvider, java.lang.String region, java.net.URI serviceEndpoint)
DynamoDBIO.Write<T>	withDynamoDbClientProvider(DynamoDbClientProvider dynamoDbClientProvider)
DynamoDBIO.Write<T>	withRetryConfiguration(DynamoDBIO.RetryConfiguration retryConfiguration) Provides configuration to retry a failed request to publish a set of records to DynamoDb.
DynamoDBIO.Write<T>	withWriteRequestMapperFn(SerializableFunction<T,KV<java.lang.String,WriteRequest>> writeItemMapperFn)

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

withDynamoDbClientProvider

public DynamoDBIO.Write<T> withDynamoDbClientProvider(DynamoDbClientProvider dynamoDbClientProvider)

withDynamoDbClientProvider

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

withDynamoDbClientProvider

public DynamoDBIO.Write<T> withDynamoDbClientProvider(AwsCredentialsProvider credentialsProvider,
                                                      java.lang.String region)

withRetryConfiguration

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

Provides configuration to retry a failed request to publish a set of records to DynamoDb. 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:

 DynamoDBIO.write()
  .withRetryConfiguration(
      DynamoDBIO.RetryConfiguration.builder()
          .setMaxAttempts(4)
          .setMaxDuration(Duration.standardMinutes(1))
          .build())
   ...
 

Parameters:

retryConfiguration - the rules which govern the retry behavior

Returns:

the DynamoDBIO.Write with retrying configured

withWriteRequestMapperFn

public DynamoDBIO.Write<T> withWriteRequestMapperFn(SerializableFunction<T,KV<java.lang.String,WriteRequest>> writeItemMapperFn)

withDeduplicateKeys

public DynamoDBIO.Write<T> withDeduplicateKeys(java.util.List<java.lang.String> deduplicateKeys)

expand

public PCollection<java.lang.Void> 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<java.lang.Void>>