SAService Architect Back to designer
SAService ArchitectDocumentation
Data connectorsKafka
Endpoint type Kafka / endpoint

Kafka endpoint

A topic contract used by a consumer Input or producer Sink.

When to use

Create this endpoint inside a Kafka connector, then select it from an Input or Sink stream.

Behavior

  • Input consumes with consumerGroup.
  • Sink produces to topic.
  • The same endpoint may form a symmetric source/sink contract when types match.

General properties

Endpoint identity

PropertyTypeDescription
namestring

Endpoint name unique in the topology.

Required

Kafka properties

Kafka endpoint contract

PropertyTypeDescription
enabledboolean

Starts topic integration.

Default: true
createTopicboolean

Creates the topic at startup when absent.

Default: false
topicstring

Kafka topic name.

Required
partitions1..1000

Partition count used for topic creation.

Default: 1
consumerGroupstring

Consumer group. Relevant to Input/source usage.

Required for a source endpoint.
replicationFactor1..1000

Replication factor used for topic creation.

Default: 1
usePartitionerboolean

Generates a custom producer partitioner hook.

Default: false

Function properties

Generated transport handler and code placement

PropertyTypeDescription
functionNamesymbol

Generated endpoint handler name.

functionPackagerelative path

Optional placement below the target-language functions root. Empty uses the root directly; folder/sub-folder is resolved relative to the root selected by publicFunction and functionModule. See Code Generation / Packages and Modules for the language matrix.

Default: empty (functions root)
publicFunctionboolean

Places the handler in shared code.

Default: false
functionDescriptiontext

Generated documentation comment.

functionInitializerGroupstring

Dependency-injection initialization group.

functionModuleModule

Shared module for the handler.

Visible when publicFunction is true.

Configuration example

name: Orders
topic: orders.v1
consumerGroup: order-service
partitions: 6