SAService Architect Back to designer
SAService ArchitectDocumentation
Python DSLAPI: Connectors
Python API reference get() | post() | unary_method() | streaming methods | topic() | endpoint()

HTTP, gRPC, Kafka, and Custom endpoints

Create concrete endpoints whose parameters match their connector transport.

When to use

Pass returned Endpoint objects to Pipeline.input or Pipeline.sink.

Behavior

  • Every endpoint requires Function metadata and derives its key from name.
  • Endpoint objects retain their owning Connector and expose function_name for inspection.
  • Kafka topic options control provisioning and consumer behavior as well as topic identity.

HttpConnector.get() / post() properties

Typed HTTP endpoints.

PropertyTypeDescription
namestr

Endpoint name.

Required
functionFunction

Business callback metadata used to generate the implementation contract.

Required
pathstr

Route path.

Required
tracing_enabledbool | None

Inbound tracing override.

Default: None

Typed gRPC methods properties

Unary or streaming endpoint selected by the concrete method.

PropertyTypeDescription
name / functionstr / Function

Endpoint identity and callback.

Required
method_namestr | None

RPC method name; derived from endpoint name when omitted.

Default: None
factorymethod

unary_method, client_streaming_method, server_streaming_method, or bidirectional_streaming_method selects the shape.

tracing_enabledbool | None

Inbound tracing override.

Default: None

KafkaConnector.topic() properties

Kafka endpoint.

PropertyTypeDescription
name / function / topicstr / Function / str

Endpoint identity, callback, and Kafka topic.

Required
enabledbool

Enable runtime integration.

Default: True
create_topicbool | None

Allow generated provisioning.

Default: None
partitions / replication_factorint | None

Provisioned topic shape.

Default: None
consumer_groupstr | None

Consumer group identity.

Default: None
use_partitionerbool | None

Use configured producer partitioning.

Default: None

CustomConnector.endpoint() properties

Custom integration endpoint.

PropertyTypeDescription
namestr

Endpoint name.

Required
functionFunction

Business callback metadata used to generate the implementation contract.

Required
tracing_enabledbool | None

Tracing override.

Default: None

Python example

create_order = http.post(
    "Create Order",
    function=Function(name="CreateOrder", package=endpoint_package),
    path="/v1/orders",
)
order_created = kafka.topic(
    "Order Created",
    function=Function(name="OrderCreated", module=LOCAL_MODULE),
    topic="orders.created",
    consumer_group="orderservice",
)