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

Class DynamoDBIO.Write<T>

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

DynamoDBIO

public abstract static class DynamoDBIO.Write<T>
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<T>,org.apache.beam.sdk.values.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, resourceHints

Constructor Summary

Constructors

Constructor and Description
Write()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<java.lang.Void>	expand(org.apache.beam.sdk.values.PCollection<T> input)
DynamoDBIO.Write<T>	withDeduplicateKeys(java.util.List<java.lang.String> deduplicateKeys)
DynamoDBIO.Write<T>	withDynamoDbClientProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, java.lang.String region)
DynamoDBIO.Write<T>	withDynamoDbClientProvider(software.amazon.awssdk.auth.credentials.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(org.apache.beam.sdk.transforms.SerializableFunction<T,org.apache.beam.sdk.values.KV<java.lang.String,software.amazon.awssdk.services.dynamodb.model.WriteRequest>> writeItemMapperFn)

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

withDynamoDbClientProvider

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

withDynamoDbClientProvider

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

withDynamoDbClientProvider

public DynamoDBIO.Write<T> withDynamoDbClientProvider(software.amazon.awssdk.auth.credentials.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(org.apache.beam.sdk.transforms.SerializableFunction<T,org.apache.beam.sdk.values.KV<java.lang.String,software.amazon.awssdk.services.dynamodb.model.WriteRequest>> writeItemMapperFn)

withDeduplicateKeys

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

expand

public org.apache.beam.sdk.values.PCollection<java.lang.Void> expand(org.apache.beam.sdk.values.PCollection<T> input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<T>,org.apache.beam.sdk.values.PCollection<java.lang.Void>>