KafkaTransportOptions

Defined in: packages/pubsub/src/kafka/types.ts:55

Options for creating a Kafka-backed pubsub transport.

Properties

adminConfig?

optional adminConfig?: AdminConstructorConfig

Defined in: packages/pubsub/src/kafka/types.ts:59

Optional Kafka admin constructor config.

---

client

client: Kafka

Defined in: packages/pubsub/src/kafka/types.ts:57

@confluentinc/kafka-javascript Kafka client.

---

consumerConfig?

optional consumerConfig?: KafkaConsumerOptions

Defined in: packages/pubsub/src/kafka/types.ts:65

Optional Kafka consumer constructor config.

---

defaultSource?

optional defaultSource?: string

Defined in: packages/pubsub/src/kafka/types.ts:75

Default CloudEvent source for publishers using this transport.

---

interceptors?

optional interceptors?: PubSubInterceptor[]

Defined in: packages/pubsub/src/kafka/types.ts:77

Optional interceptors for transport operations.

---

producerConfig?

optional producerConfig?: ProducerConstructorConfig

Defined in: packages/pubsub/src/kafka/types.ts:61

Optional Kafka producer constructor config.

---

publishTimeoutMs?

optional publishTimeoutMs?: number

Defined in: packages/pubsub/src/kafka/types.ts:63

Optional timeout for Kafka producer sends in milliseconds.

---

scheduler?

optional scheduler?: PubSubScheduler

Defined in: packages/pubsub/src/kafka/types.ts:73

Optional scheduler used for durable notBefore publish and delayed retry.

Immediate publish/subscribe does not require a scheduler. If a publish call provides notBefore, or a handler returns ctx.retry({ delay }), the transport throws unless a scheduler was supplied.

---

signal?

optional signal?: AbortSignal

Defined in: packages/pubsub/src/kafka/types.ts:79

Optional signal that closes this transport when aborted.