Class ExternalStorageRunner

java.lang.Object

io.temporal.internal.payload.storage.ExternalStorageRunner

public final class ExternalStorageRunner
extends Object

External storage offloads large payloads via StorageDrivers. It walks messages using PayloadVisitors transforming payloads to and from ExternalStorageReference using ExternalStoragePayloadTransformer. Use ExternalStorage via create(io.temporal.payload.storage.ExternalStorage) to configure external storage.

Method Summary

Modifier and Type	Method	Description
static ExternalStorageRunner	create(ExternalStorage options)
<T extends com.google.protobuf.Message> T	retrieve(T message, CancellationToken<CancellationException> cancellationToken)
<T extends com.google.protobuf.Message> CompletableFuture<T>	retrieveAsync(T message, CancellationToken<CancellationException> cancellationToken)
void	store(com.google.protobuf.Message.Builder builder, StorageDriverTargetInfo target, MessageVisitor<StorageDriverTargetInfo> targetVisitor, CancellationToken<CancellationException> cancellationToken)
CompletableFuture<Void>	storeAsync(com.google.protobuf.Message.Builder builder, StorageDriverTargetInfo target, MessageVisitor<StorageDriverTargetInfo> targetVisitor, CancellationToken<CancellationException> cancellationToken)
static void	throwIfContainsReference(com.google.protobuf.Message message)	Throws ExternalStorageNotConfiguredException if message contains any reference payload.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static ExternalStorageRunner create(ExternalStorage options)

store

public void store(com.google.protobuf.Message.Builder builder,
 @Nullable
 StorageDriverTargetInfo target,
 @Nullable
 MessageVisitor<StorageDriverTargetInfo> targetVisitor,
 CancellationToken<CancellationException> cancellationToken)

storeAsync

public CompletableFuture<Void> storeAsync(com.google.protobuf.Message.Builder builder,
 @Nullable
 StorageDriverTargetInfo target,
 @Nullable
 MessageVisitor<StorageDriverTargetInfo> targetVisitor,
 CancellationToken<CancellationException> cancellationToken)

retrieve

public <T extends com.google.protobuf.Message> T retrieve(T message,
 CancellationToken<CancellationException> cancellationToken)

retrieveAsync

public <T extends com.google.protobuf.Message>
CompletableFuture<T> retrieveAsync(T message,
 CancellationToken<CancellationException> cancellationToken)

throwIfContainsReference

public static void throwIfContainsReference(com.google.protobuf.Message message)

Throws ExternalStorageNotConfiguredException if message contains any reference payload. Used at inbound task boundaries when external storage is not configured.