Pub/Sub topic

Fan-out topic. Every subscriber receives every message.

Category: Messaging
Properties: 5
Components: 13
Rules: 1

Properties · 5 defined by this kind

A node of this kind resolves each property from its own props, then the component's defaults, then the default below.

property	type	values	required	default
delivery	enum	at-most-once \| at-least-once \| exactly-once	yes	—
managed	boolean	—	no	false
ordering	enum	none \| per-key	no	none
replay	boolean	—	no	false
topicPerEventType · advanced	boolean	—	no	true

Rules for this kind · 1

Pub/Sub topic where replay is requirederror

pubsub-replay-required

The design declares that consumers must be able to replay history. A fan-out topic that does not retain messages cannot deliver that.

— all of these hold:
— the design requirement `messaging.replay` is true
— the node's `replay` is false

Components · 13

vendor-neutral

Generic Pub/Sub topicpubsub-topicgenericthe kind itself

alibabacloud

EventBridgealibaba-eventbridge2 defaults

aws

Amazon EventBridgeaws-eventbridge5 defaults Amazon SNSsns4 defaults

azure

Azure Event Gridazure-event-grid4 defaults Azure Event Grid MQTT Brokerazure-event-grid-mqtt5 defaults

default

Eclipse Mosquittomosquitto4 defaults MQTT brokermqtt-broker3 defaults NanoMQnanomq4 defaults Redis Pub/Subredis-pubsub3 defaults

gcp

Eventarcgoogle-eventarc4 defaults Google Cloud Pub/Subgoogle-pubsub4 defaults

oci

OCI Eventsoci-events4 defaults

Source

1# yaml-language-server: $schema=../schema/kind.schema.json
2# Abstract kind: Fan-out topic. Every subscriber receives every message. Contrast with queue (one consumer) and stream (replayable log).
3schemaVersion: "1"
4type: "kind"
5id: "pubsub-topic"
6category: "messaging"
7properties:
8  delivery:
9    type: "enum"
10    values: ["at-most-once", "at-least-once", "exactly-once"]
11    required: true
12  replay:
13    type: "boolean"
14    default: false
15  ordering:
16    type: "enum"
17    values: ["none", "per-key"]
18    default: "none"
19  topicPerEventType:
20    type: "boolean"
21    default: true
22    advanced: true
23  managed:
24    type: "boolean"
25    default: false

The same page as markdown, for an agent: /catalogue/kinds/pubsub-topic.md