temporalio.converter.JSONProtoPayloadConverter

class documentation

class JSONProtoPayloadConverter(EncodingPayloadConverter): (source)

Constructor: JSONProtoPayloadConverter(ignore_unknown_fields)

View In Hierarchy

Converter for 'json/protobuf' payloads supporting protobuf Message values.

Method __init__ Initialize a JSON proto converter.
Method from_payload See base class.
Method to_payload See base class.
Property encoding See base class.
Instance Variable _ignore_unknown_fields Undocumented
def __init__(self, ignore_unknown_fields: bool = False): (source)

Initialize a JSON proto converter.

Parameters
ignore_unknown_fields:boolDetermines whether converter should error if unknown fields are detected
def from_payload(self, payload: temporalio.api.common.v1.Payload, type_hint: type | None = None) -> Any: (source)
overrides temporalio.converter.EncodingPayloadConverter.from_payload

See base class.

def to_payload(self, value: Any) -> temporalio.api.common.v1.Payload | None: (source)
overrides temporalio.converter.EncodingPayloadConverter.to_payload

See base class.

@property
encoding: str = (source)
overrides temporalio.converter.EncodingPayloadConverter.encoding

See base class.

_ignore_unknown_fields = (source)

Undocumented