SAService Architect Open designer
SAService ArchitectDocumentation
Python DSLAPI: Utilities and Clients
Python API reference Golang() | DataConnectorImplementation.IBM_SARAMA | LOCAL_MODULE

Enums and sentinels — Python Architecture DSL

Use exported enum members and sentinel objects instead of reproducing serialized strings.

When to use

Import these values wherever a factory parameter presents an enum or ownership choice.

Behavior

  • Enum values serialize to the exact Service Architect contract spelling.

Runtime and graph enums properties

Core service and stream choices.

PropertyTypeDescription
Service language objectstyped config

Golang, CppUserver, CppBoost, Python, Rust, and TypeScript.

Environmentenum

Deployment environment values supported by the topology.

KubernetesWorkloadTypeenum

Kubernetes workload selection.

StreamTypeenum

All graph transformation kinds; selected implicitly by typed Pipeline methods.

CallSemanticsenum

INHERITED, FUNCTION_CALL, TASK_POOL, PRIORITY_TASK_POOL, PARALLEL_CALL.

Types and operator enums properties

Data and transformation configuration.

PropertyTypeDescription
DataTypeenum

Built-in scalar, collection, message, custom, any, and error contracts.

TypeDefinitionFormatenum

NATIVE, PROTOBUF, FLAT_BUFFERS, CAP_N_PROTO, OPENAPI.

JoinType / JoinStorageTypeenums

Join result and state storage behavior.

ProcessPatternenum

EXECUTE or COLLECT.

Integration enums properties

Connector and endpoint options.

PropertyTypeDescription
DataConnectorImplementationenum

Language-specific runtime adapters.

HTTPMethodType / GrpcMethodTypeenums

HTTP verb and gRPC streaming shape.

KafkaSecurityProtocol / KafkaSaslMechanismenums

Kafka transport authentication.

ScheduleOverlapPolicy / ScheduleMissedRunPolicyenums

Cron and Temporal schedule behavior.

TemporalExecutionTypeenum

ACTIVITY or WORKFLOW; selected implicitly by endpoint methods.

Ownership sentinels properties

Distinguish omitted, root, and explicit-local values.

PropertyTypeDescription
ROOT_PACKAGEPackage

Empty package object.

LOCAL_MODULEsentinel

Explicit local module represented as YAML null.

NULLsentinel

Explicit YAML null for supported low-level cases.

NonePython value

Omit an optional serialized field.

Python example

service = project.service(
    "Orders",
    language=Golang(version="1.25.4"),
    module=ServiceModule(path="github.com/example/orders"),
    kubernetes=Kubernetes(workload_type=KubernetesWorkloadType.DEPLOYMENT),
)
callback = Function(name="ProcessOrder", module=LOCAL_MODULE)