Skip to main content

Interface: $Properties

Properties of a ClusterMetadata.

Extended by​

Properties​

address?​

optional address?: string | null

gRPC address.

clusterId?​

optional clusterId?: string | null

Id of the cluster.

clusterName?​

optional clusterName?: string | null

Name of the cluster name.

historyShardCount?​

optional historyShardCount?: number | null

History service shard number.

httpAddress?​

optional httpAddress?: string | null

HTTP address, if one exists.

initialFailoverVersion?​

optional initialFailoverVersion?: Long | null

A unique failover version across all connected clusters.

isConnectionEnabled?​

optional isConnectionEnabled?: boolean | null

A flag to indicate if a connection is active.

isReplicationEnabled?​

optional isReplicationEnabled?: boolean | null

A flag to indicate if replication is enabled.