Kinetica   C#   API  Version 7.2.3.1
ClusterAddressInfo Class Reference

Contains address information for a Kinetica cluster. More...

Public Member Functions

 ClusterAddressInfo (Uri activeHeadNodeUrl, IDictionary< string, string > systemProperties, IList< Uri > workerRankUrls, HashSet< string > hostNames, Uri hostManagerUrl)
 Creates a new ClusterAddressInfo for an active cluster. More...
 
 ClusterAddressInfo (Uri activeHeadNodeUrl, int hostManagerPort)
 Creates a ClusterAddressInfo with just an active URL and host manager port. More...
 
bool DoesClusterContainNode (string hostName)
 Checks if the given hostname (or IP address) is part of this cluster. More...
 
override string ToString ()
 Returns a string representation of this cluster address info. More...
 
override bool Equals (object? obj)
 Equality check based on active head node URL. More...
 
override int GetHashCode ()
 Hash code based on active head node URL. More...
 

Properties

Uri ActiveHeadNodeUrl [get, set]
 The active head node URL for the cluster More...
 
IDictionary< string, string > SystemProperties [get, set]
 System properties map from the cluster More...
 
IList< Uri > WorkerRankUrls [get, set]
 List of worker rank URLs More...
 
HashSet< string > HostNames [get, set]
 Set of hostnames/IP addresses in the cluster More...
 
Uri HostManagerUrl [get, set]
 URL for the host manager More...
 
bool IsPrimaryCluster [get, set]
 Whether this is the primary cluster More...
 

Detailed Description

Contains address information for a Kinetica cluster.

Stores information about a cluster including its active head node URL, worker rank URLs, hostnames, host manager URL, and system properties.

Definition at line 30 of file HAFailover.cs.

Constructor & Destructor Documentation

◆ ClusterAddressInfo() [1/2]

ClusterAddressInfo.ClusterAddressInfo ( Uri  activeHeadNodeUrl,
IDictionary< string, string >  systemProperties,
IList< Uri >  workerRankUrls,
HashSet< string >  hostNames,
Uri  hostManagerUrl 
)
inline

Creates a new ClusterAddressInfo for an active cluster.

Parameters
activeHeadNodeUrlThe URL of the active head node
systemPropertiesSystem properties map from the cluster
workerRankUrlsList of worker rank URLs
hostNamesSet of hostnames/IP addresses in the cluster
hostManagerUrlURL for the host manager

Definition at line 70 of file HAFailover.cs.

◆ ClusterAddressInfo() [2/2]

ClusterAddressInfo.ClusterAddressInfo ( Uri  activeHeadNodeUrl,
int  hostManagerPort 
)
inline

Creates a ClusterAddressInfo with just an active URL and host manager port.

Parameters
activeHeadNodeUrlThe URL of the active head node
hostManagerPortThe port for the host manager

Definition at line 93 of file HAFailover.cs.

Member Function Documentation

◆ DoesClusterContainNode()

bool ClusterAddressInfo.DoesClusterContainNode ( string  hostName)
inline

Checks if the given hostname (or IP address) is part of this cluster.

Parameters
hostNameThe hostname or IP address to check
Returns
true if this cluster contains a machine with the given hostname or IP address

Definition at line 149 of file HAFailover.cs.

◆ Equals()

override bool ClusterAddressInfo.Equals ( object?  obj)
inline

Equality check based on active head node URL.

Definition at line 167 of file HAFailover.cs.

◆ GetHashCode()

override int ClusterAddressInfo.GetHashCode ( )
inline

Hash code based on active head node URL.

Definition at line 179 of file HAFailover.cs.

◆ ToString()

override string ClusterAddressInfo.ToString ( )
inline

Returns a string representation of this cluster address info.

Definition at line 157 of file HAFailover.cs.

Property Documentation

◆ ActiveHeadNodeUrl

Uri ClusterAddressInfo.ActiveHeadNodeUrl
getset

The active head node URL for the cluster

Definition at line 35 of file HAFailover.cs.

◆ HostManagerUrl

Uri ClusterAddressInfo.HostManagerUrl
getset

URL for the host manager

Definition at line 55 of file HAFailover.cs.

◆ HostNames

HashSet<string> ClusterAddressInfo.HostNames
getset

Set of hostnames/IP addresses in the cluster

Definition at line 50 of file HAFailover.cs.

◆ IsPrimaryCluster

bool ClusterAddressInfo.IsPrimaryCluster
getset

Whether this is the primary cluster

Definition at line 60 of file HAFailover.cs.

◆ SystemProperties

IDictionary<string, string> ClusterAddressInfo.SystemProperties
getset

System properties map from the cluster

Definition at line 40 of file HAFailover.cs.

◆ WorkerRankUrls

IList<Uri> ClusterAddressInfo.WorkerRankUrls
getset

List of worker rank URLs

Definition at line 45 of file HAFailover.cs.


The documentation for this class was generated from the following file: