Class DataConverter

Namespace

Temporalio.Converters

Assembly

Temporalio.dll

Data converter which combines a payload converter, a failure converter, and a payload codec.

public record DataConverter : IWithSerializationContext<DataConverter>, IEquatable<DataConverter>

Inheritance

object

DataConverter

Implements

IWithSerializationContext<DataConverter>

IEquatable<DataConverter>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ConverterExtensions.ToExceptionAsync(DataConverter, Failure)

ConverterExtensions.ToFailureAsync(DataConverter, Exception)

ConverterExtensions.ToPayloadAsync(DataConverter, object?)

ConverterExtensions.ToPayloadsAsync(DataConverter, IReadOnlyCollection<object?>)

ConverterExtensions.ToSingleValueAsync(DataConverter, IReadOnlyCollection<Payload>, Type)

ConverterExtensions.ToSingleValueAsync<T>(DataConverter, IReadOnlyCollection<Payload>)

ConverterExtensions.ToValueAsync(DataConverter, Payload, Type)

ConverterExtensions.ToValueAsync<T>(DataConverter, Payload)

Constructors

DataConverter(IPayloadConverter, IFailureConverter, IPayloadCodec?)

Data converter which combines a payload converter, a failure converter, and a payload codec.

public DataConverter(IPayloadConverter PayloadConverter, IFailureConverter FailureConverter, IPayloadCodec? PayloadCodec = null)

Parameters

PayloadConverter IPayloadConverter

Payload converter.

FailureConverter IFailureConverter

Failure converter.

PayloadCodec IPayloadCodec

Optional payload codec.

Properties

Default

Gets default data converter instance.

public static DataConverter Default { get; }

Property Value

DataConverter

ExternalStorage

Gets the external storage configuration. When set, payloads at or above its size threshold are offloaded to a storage driver and replaced on the wire by a reference.

public ExternalStorage? ExternalStorage { get; init; }

Property Value

ExternalStorage

Remarks

WARNING: This API is experimental and may change in the future.

FailureConverter

Failure converter.

public IFailureConverter FailureConverter { get; init; }

Property Value

IFailureConverter

PayloadCodec

Optional payload codec.

public IPayloadCodec? PayloadCodec { get; init; }

Property Value

IPayloadCodec

PayloadConverter

Payload converter.

public IPayloadConverter PayloadConverter { get; init; }

Property Value

IPayloadConverter

Methods

WithSerializationContext(ISerializationContext)

Create a new instance of this converter or codec with the given serialization context.

public virtual DataConverter WithSerializationContext(ISerializationContext context)

Parameters

context ISerializationContext

Context to use to return a context-specific instance of a converter or codec.

Returns

DataConverter

Context-specific instance of a converter/codec to use. This may return this to effectively bypass the context-specific nature.

Remarks

This will be called with an instance of ISerializationContext.Activity on converters and codecs when an activity is invoked from workflow, when an activity attempt is run on an activity worker, or manually via WithSerializationContext(ISerializationContext) when using async activity completion.