Databricks SDK for JavaScript
    Preparing search index...

    Interface KafkaOptions

    interface KafkaOptions {
        clientConfig?: Record<string, string>;
        keyTransformer?: Transformer;
        maxOffsetsPerTrigger?: bigint;
        startingOffset?: string;
        topicPattern?: string;
        topics?: string[];
        valueTransformer?: Transformer;
    }
    Index

    Properties

    clientConfig? keyTransformer? maxOffsetsPerTrigger? startingOffset? topicPattern? topics? valueTransformer?

    Properties

    clientConfig?: Record<string, string>

    Undocumented backdoor mechanism for overriding parameters to pass to the Kafka client. This is not supported and may break at any time.

    keyTransformer?: Transformer

    (Optional) Transformer for the message key. If not specified, the key is left as raw bytes.

    maxOffsetsPerTrigger?: bigint

    Internal option to control the maximum number of offsets to process per trigger.

    startingOffset?: string

    (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest".

    topicPattern?: string

    Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified.

    topics?: string[]

    Topics to subscribe to. Only one of topics or topic_pattern must be specified.

    valueTransformer?: Transformer

    (Optional) Transformer for the message value. If not specified, the value is left as raw bytes.

    Settings

    Member Visibility

    On This Page

    Properties