@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias BrokerInfo

    Provides information on a broker node.

    type BrokerInfo = {
        brokerId: string;
        host: string;
        nodeId: number;
        partitions: Partition[];
        port: number;
        version: string;
    }
    Index
    brokerId: string

    The unique (within a cluster) broker identifier. When the cluster is not zoned, then it's a string that represents the nodeId (an integer). When the cluster is zoned, instead, it's of the form "$zoneName_$nodeId", providing uniqueness even across zones.

    host: string

    The hostname for reaching the broker.

    nodeId: number

    The node ID for the broker. The uniqueness of this identifier depends if the cluster is zone-aware or not. - non zone-aware: (default) nodeId is unique across the cluster - zone-aware: (opt-in) nodeId is unique only within its zone. If you are migrating to a zone aware cluster, you must use brokerId instead. This property is deprecated, as it's been replaced by brokerId.

    partitions: Partition[]

    A list of partitions managed or replicated on this broker.

    port: number

    The port for reaching the broker.

    version: string

    The broker version.