Skip to main content

Interface: IClusterMetadata

Properties of a ClusterMetadata.

Extends​

Properties​

address?​

optional address?: string | null

gRPC address.

Inherited from​

$Properties.address


clusterId?​

optional clusterId?: string | null

Id of the cluster.

Inherited from​

$Properties.clusterId


clusterName?​

optional clusterName?: string | null

Name of the cluster name.

Inherited from​

$Properties.clusterName


historyShardCount?​

optional historyShardCount?: number | null

History service shard number.

Inherited from​

$Properties.historyShardCount


httpAddress?​

optional httpAddress?: string | null

HTTP address, if one exists.

Inherited from​

$Properties.httpAddress


initialFailoverVersion?​

optional initialFailoverVersion?: Long | null

A unique failover version across all connected clusters.

Inherited from​

$Properties.initialFailoverVersion


isConnectionEnabled?​

optional isConnectionEnabled?: boolean | null

A flag to indicate if a connection is active.

Inherited from​

$Properties.isConnectionEnabled


isReplicationEnabled?​

optional isReplicationEnabled?: boolean | null

A flag to indicate if replication is enabled.

Inherited from​

$Properties.isReplicationEnabled