Add Transfer Types Spec - #880
Draft
VegetarianOrc wants to merge 3 commits into
Draft
Conversation
… for collaborative review
dplyukhin
requested changes
Sep 2, 2026
Comment on lines
+7
to
+9
| ## Purpose | ||
|
|
||
| This document defines the portable behavior of Temporal transfer type converters. It specifies observable conversion semantics without prescribing SDK-specific APIs, generic type mechanisms, or converter construction strategies. |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Purpose | |
| This document defines the portable behavior of Temporal transfer type converters. It specifies observable conversion semantics without prescribing SDK-specific APIs, generic type mechanisms, or converter construction strategies. | |
| ## Motivation | |
| Sometimes you have a custom datatype that should be serializable as a payload, but you can't modify the configured data converter to support your type. Transfer types let you work around that by picking a "transfer type" that's already serializable, and associating your datatype with a "transfer type converter" that converts values of your custom type to values of the transfer type and back. |
Comment on lines
+13
to
+18
| - **Model type:** The user-facing type associated with a transfer type converter. | ||
| - **Transfer type:** The serializer-facing type produced from a model value. | ||
| - **Transfer value:** A value of the transfer type. | ||
| - **Payload conversion:** Conversion between an in-memory value and a Temporal `Payload`. | ||
| - **Payload codec:** A byte-to-byte transformation applied to a payload, such as encryption or compression. | ||
| - **Failure details:** Typed payloads stored in application failures, cancellations, timeout heartbeat details, reset failures, or nested failure causes. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Model type:** The user-facing type associated with a transfer type converter. | |
| - **Transfer type:** The serializer-facing type produced from a model value. | |
| - **Transfer value:** A value of the transfer type. | |
| - **Payload conversion:** Conversion between an in-memory value and a Temporal `Payload`. | |
| - **Payload codec:** A byte-to-byte transformation applied to a payload, such as encryption or compression. | |
| - **Failure details:** Typed payloads stored in application failures, cancellations, timeout heartbeat details, reset failures, or nested failure causes. | |
| - **Model type:** The user-facing type associated with a transfer type converter. | |
| - **Transfer type:** The serializable type produced from a model value. | |
| - **Transfer value:** A value of the transfer type. |
| - **Payload codec:** A byte-to-byte transformation applied to a payload, such as encryption or compression. | ||
| - **Failure details:** Typed payloads stored in application failures, cancellations, timeout heartbeat details, reset failures, or nested failure causes. | ||
|
|
||
| ## Normative behavior |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Normative behavior | |
| ## Behavior |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was changed
Why?
Checklist
Closes
How was this tested: