Databricks SDK for JavaScript
    Preparing search index...

    Interface Stream

    A Stream is a governed UC entity representing an external streaming data source. The source_config oneof determines the streaming platform source (e.g. Kafka, Kinesis, etc.).

    interface Stream {
        browseOnly?: boolean;
        connectionConfig?: StreamConnectionConfig;
        createdBy?: string;
        createTime?: Instant;
        description?: string;
        ingestionConfig?: IngestionConfig;
        name?: string;
        schemaConfig?: StreamSchemaConfig;
        sourceConfig?: StreamSourceConfig;
        updatedBy?: string;
        updateTime?: Instant;
    }
    Index

    Properties

    browseOnly? connectionConfig? createdBy? createTime? description? ingestionConfig? name? schemaConfig? sourceConfig? updatedBy? updateTime?

    Properties

    browseOnly?: boolean

    Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

    connectionConfig?: StreamConnectionConfig

    Specifies how to connect and authenticate to the stream platform.

    createdBy?: string

    Username of the Stream creator.

    createTime?: Instant

    Time at which this Stream was created.

    description?: string

    User-provided description.

    ingestionConfig?: IngestionConfig

    Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.

    name?: string

    Full three-part (catalog.schema.stream) name of the stream.

    schemaConfig?: StreamSchemaConfig

    Schema definitions for the stream. Currently only direct schemas are supported. In a future milestone, we will support schema registries through a UC Connection.

    sourceConfig?: StreamSourceConfig

    Source-specific configuration. Determines the streaming platform source.

    updatedBy?: string

    Username of user who last modified the Stream.

    updateTime?: Instant

    Time at which this Stream was last modified.

    Settings

    Member Visibility

    On This Page

    Properties