temporalio.nexus.system

package documentation
(source)

System Nexus operation helpers.

Warning

This API is experimental and subject to change.

Package workflow_service No package docstring; 0/1 variable, 0/1 type alias, 0/2 type variable, 1/1 function, 0/1 class, 0/2 module, 0/2 package documented

From __init__.py:

Function is_system_endpoint Return whether a Nexus endpoint is the Temporal system endpoint.
Async Function maybe_visit_payload Visit nested payloads if the payload is a Temporal system Nexus envelope.
Constant TEMPORAL_SYSTEM_ENDPOINT Undocumented
Class _SystemNexusOuterPayloadConverter Payload converter for system Nexus outer proto envelopes.
Class _SystemNexusPayloadConverter Payload converter for system Nexus outer envelopes.
Class _SystemNexusUserConverters Undocumented
Function _current_user_converters Undocumented
Function _current_user_failure_converter Return the active user failure converter for system Nexus model conversion.
Function _current_user_payload_converter Return the active user payload converter for system Nexus model conversion.
Function _get_payload_converter Return the fixed payload converter for system Nexus outer envelopes.
Function _get_serialization_context Return the serialization context for a system Nexus operation.
Function _is_system_payload Undocumented
Function _user_converter_context Set the user converters for system Nexus model conversion.
Constant _SYSTEM_PAYLOAD_METADATA_KEY Undocumented
Constant _SYSTEM_PAYLOAD_METADATA_VALUE Undocumented
Variable _user_converters Undocumented
def is_system_endpoint(endpoint: str) -> bool: (source)

Return whether a Nexus endpoint is the Temporal system endpoint.

Warning

This API is experimental and subject to change.

async def maybe_visit_payload(payload: temporalio.api.common.v1.Payload, visitor_functions: VisitorFunctions, skip_search_attributes: bool) -> temporalio.api.common.v1.Payload | None: (source)

Visit nested payloads if the payload is a Temporal system Nexus envelope.

TEMPORAL_SYSTEM_ENDPOINT: str = (source)

Undocumented

Value
'__temporal_system'
def _current_user_converters() -> _SystemNexusUserConverters: (source)

Undocumented

def _current_user_failure_converter() -> temporalio.converter.FailureConverter: (source)

Return the active user failure converter for system Nexus model conversion.

def _current_user_payload_converter() -> temporalio.converter.PayloadConverter: (source)

Return the active user payload converter for system Nexus model conversion.

def _get_payload_converter(user_payload_converter: temporalio.converter.PayloadConverter, user_failure_converter: temporalio.converter.FailureConverter) -> temporalio.converter.PayloadConverter: (source)

Return the fixed payload converter for system Nexus outer envelopes.

def _get_serialization_context(service: str, operation: str, request: Any) -> temporalio.converter.SerializationContext | None: (source)

Return the serialization context for a system Nexus operation.

def _is_system_payload(payload: temporalio.api.common.v1.Payload) -> bool: (source)

Undocumented

def _user_converter_context(converters: _SystemNexusUserConverters) -> Iterator[None]: (source)

Set the user converters for system Nexus model conversion.

_SYSTEM_PAYLOAD_METADATA_KEY: str = (source)

Undocumented

Value
'__temporal_system_payload'
_SYSTEM_PAYLOAD_METADATA_VALUE: bytes = (source)

Undocumented

Value
b'true'
_user_converters: contextvars.ContextVar[_SystemNexusUserConverters | None] = (source)

Undocumented