Skip to main content

Interface: $Properties

v1.ClusterMetadata.$Properties

Properties of a ClusterMetadata.

Hierarchy

Properties

address

Optional address: null | string

gRPC address.


clusterId

Optional clusterId: null | string

Id of the cluster.


clusterName

Optional clusterName: null | string

Name of the cluster name.


historyShardCount

Optional historyShardCount: null | number

History service shard number.


httpAddress

Optional httpAddress: null | string

HTTP address, if one exists.


initialFailoverVersion

Optional initialFailoverVersion: null | Long

A unique failover version across all connected clusters.


isConnectionEnabled

Optional isConnectionEnabled: null | boolean

A flag to indicate if a connection is active.


isReplicationEnabled

Optional isReplicationEnabled: null | boolean

A flag to indicate if replication is enabled.