Databricks SDK for JavaScript
    Preparing search index...

    Subscription mode for Kafka topic selection, matching standard Spark Structured Streaming options.

    interface KafkaSubscriptionMode {
        subscriptionMode?:
            | { $case: "assign"; assign: string }
            | { $case: "subscribe"; subscribe: string }
            | { $case: "subscribePattern"; subscribePattern: string };
    }
    Index

    Properties

    subscriptionMode?:
        | { $case: "assign"; assign: string }
        | { $case: "subscribe"; subscribe: string }
        | { $case: "subscribePattern"; subscribePattern: string }

    Type Declaration

    • { $case: "assign"; assign: string }
      • $case: "assign"
      • assign: string

        A JSON string that contains the specific topic-partitions to consume from. For example, for '{"topicA":[0,1],"topicB":[2,4]}', topicA's 0'th and 1st partitions will be consumed from.

    • { $case: "subscribe"; subscribe: string }
      • $case: "subscribe"
      • subscribe: string

        A comma-separated list of Kafka topics to read from. For example, 'topicA,topicB,topicC'.

    • { $case: "subscribePattern"; subscribePattern: string }
      • $case: "subscribePattern"
      • subscribePattern: string

        A regular expression matching topics to subscribe to. For example, 'topic.*' will subscribe to all topics starting with 'topic'.