Skip to main content

Interface: IClusterMetadata

operatorservice.v1.IClusterMetadata

Properties of a ClusterMetadata.

Hierarchy​

Properties​

address​

• Optional address: null | string

gRPC address.

Inherited from​

$Properties.address

clusterId​

• Optional clusterId: null | string

Id of the cluster.

Inherited from​

$Properties.clusterId

clusterName​

• Optional clusterName: null | string

Name of the cluster name.

Inherited from​

$Properties.clusterName

historyShardCount​

• Optional historyShardCount: null | number

History service shard number.

Inherited from​

$Properties.historyShardCount

httpAddress​

• Optional httpAddress: null | string

HTTP address, if one exists.

Inherited from​

$Properties.httpAddress

initialFailoverVersion​

• Optional initialFailoverVersion: null | Long

A unique failover version across all connected clusters.

Inherited from​

$Properties.initialFailoverVersion

isConnectionEnabled​

• Optional isConnectionEnabled: null | boolean

A flag to indicate if a connection is active.

Inherited from​

$Properties.isConnectionEnabled

isReplicationEnabled​

• Optional isReplicationEnabled: null | boolean

A flag to indicate if replication is enabled.

Inherited from​

$Properties.isReplicationEnabled