sdk

10 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.

Data Converter API references by language

Data Converter API references are available for: Go at https://pkg.go.dev/go.temporal.io/sdk/converter#DataConverter, Java at https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/common/converter/DataConverter.html, Python at https://python.temporal.io/temporalio.converter.DataConverter.html, and TypeScript at https://typescript.temporal.io/api/interfaces/common.DataConverter

What is a Payload Converter

A Payload Converter serializes data, converting values to bytes and back. This is how you serialize application objects into a Payload and deserialize them back into application objects. A Payload is a binary form suitable for network transmission that may include metadata. The serialization process transforms an object (like those in JSON or Protobuf formats) into a binary format and vice versa.

Payload Converter workflow execution input serialization

When you initiate a Workflow Execution through a Client and pass data as input, the input is serialized using a Data Converter that runs it through a set of Payload Converters. When your Workflow Execution starts, this data input is deserialized and passed as input to your Workflow.

Payload Converters run in Workflow sandbox with constraints

Payload Converters run inside the Workflow sandbox. Consequently, Payload Converters cannot access external services or employ non-deterministic modules, which excludes most types of encryption due to their non-deterministic nature.

Composite Data Converter definition and ordering

A Composite Data Converter is used to apply custom, type-specific Payload Converters in a specified order. A Composite Data Converter can be comprised of custom rules you created, and it can also leverage the default Data Converters built into Temporal. The order in which the Payload Converters are applied is important. During serialization, the Data Converter tries the Payload Converters in that specific order until a Payload Converter returns a non-nil Payload.

Custom PayloadConverter required functions

A custom PayloadConverter must implement the functions: FromPayload (for a single value) or FromPayloads (for a list of values) to convert values from a Payload, and ToPayload (for a single value) or ToPayloads (for a list of values) to convert values to a Payload.

Custom data handling does not always require Composite Data Converter

Defining a new Composite Data Converter is not always necessary to implement custom data handling. Each SDK allows you to override or configure the default Converter with a custom Payload Codec.

Supported SDKs for Dynamic Handlers

Dynamic Handlers are supported in the following Temporal SDKs: Java, Python, .NET, Go, and Ruby.

Official Temporal SDKs supported languages

The officially supported SDKs are: Go SDK, Java SDK, Python SDK, TypeScript SDK, .NET SDK, Ruby SDK, PHP SDK, and Rust SDK. Each SDK targets a specific programming language.

Third-party Temporal SDKs not officially supported

Third-party SDKs exist for Swift (from Swift Community), Haskell (from MercuryTechnologies), Clojure (from Manetu), and Scala (from vitaliihonta), but these are not officially supported by Temporal.

Give your agent this brain