> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.ClusterAddressInfo > kinetica.ClusterAddressInfo — Kinetica C# API

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

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

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 27 of file HAFailover.cs.

Constructor & Destructor Documentation

◆ ClusterAddressInfo() \[1/4]

kinetica.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
activeHeadNodeUrl The URL of the active head node
systemProperties System properties map from the cluster
workerRankUrls List of worker rank URLs
hostNames Set of hostnames/IP addresses in the cluster
hostManagerUrl URL for the host manager

Definition at line 67 of file HAFailover.cs.

◆ ClusterAddressInfo() \[2/4]

kinetica.ClusterAddressInfo.ClusterAddressInfo ( Uri activeHeadNodeUrl,
int hostManagerPort )
inline

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

Parameters
activeHeadNodeUrl The URL of the active head node
hostManagerPort The port for the host manager

Definition at line 90 of file HAFailover.cs.

◆ ClusterAddressInfo() \[3/4]

kinetica.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
activeHeadNodeUrl The URL of the active head node
systemProperties System properties map from the cluster
workerRankUrls List of worker rank URLs
hostNames Set of hostnames/IP addresses in the cluster
hostManagerUrl URL for the host manager

Definition at line 67 of file HAFailover.cs.

◆ ClusterAddressInfo() \[4/4]

kinetica.ClusterAddressInfo.ClusterAddressInfo ( Uri activeHeadNodeUrl,
int hostManagerPort )
inline

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

Parameters
activeHeadNodeUrl The URL of the active head node
hostManagerPort The port for the host manager

Definition at line 90 of file HAFailover.cs.

Member Function Documentation

◆ DoesClusterContainNode() \[1/2]

bool kinetica.ClusterAddressInfo.DoesClusterContainNode ( string hostName )
inline

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

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

Definition at line 146 of file HAFailover.cs.

◆ DoesClusterContainNode() \[2/2]

bool kinetica.ClusterAddressInfo.DoesClusterContainNode ( string hostName )
inline

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

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

Definition at line 146 of file HAFailover.cs.

◆ Equals() \[1/2]

override bool kinetica.ClusterAddressInfo.Equals ( object? obj )
inline

Equality check based on active head node URL.

Definition at line 164 of file HAFailover.cs.

◆ Equals() \[2/2]

override bool kinetica.ClusterAddressInfo.Equals ( object? obj )
inline

Equality check based on active head node URL.

Definition at line 164 of file HAFailover.cs.

◆ GetHashCode() \[1/2]

override int kinetica.ClusterAddressInfo.GetHashCode ( )
inline

Hash code based on active head node URL.

Definition at line 176 of file HAFailover.cs.

◆ GetHashCode() \[2/2]

override int kinetica.ClusterAddressInfo.GetHashCode ( )
inline

Hash code based on active head node URL.

Definition at line 176 of file HAFailover.cs.

◆ ToString() \[1/2]

override string kinetica.ClusterAddressInfo.ToString ( )
inline

Returns a string representation of this cluster address info.

Definition at line 154 of file HAFailover.cs.

◆ ToString() \[2/2]

override string kinetica.ClusterAddressInfo.ToString ( )
inline

Returns a string representation of this cluster address info.

Definition at line 154 of file HAFailover.cs.

Property Documentation

◆ ActiveHeadNodeUrl

Uri kinetica.ClusterAddressInfo.ActiveHeadNodeUrl
getset

The active head node URL for the cluster.

Definition at line 32 of file HAFailover.cs.

◆ HostManagerUrl

Uri kinetica.ClusterAddressInfo.HostManagerUrl
getset

URL for the host manager.

Definition at line 52 of file HAFailover.cs.

◆ HostNames

HashSet\< string > kinetica.ClusterAddressInfo.HostNames
getset

Set of hostnames/IP addresses in the cluster.

Definition at line 47 of file HAFailover.cs.

◆ IsPrimaryCluster

bool kinetica.ClusterAddressInfo.IsPrimaryCluster
getset

Whether this is the primary cluster.

Definition at line 57 of file HAFailover.cs.

◆ SystemProperties

IDictionary\< string, string > kinetica.ClusterAddressInfo.SystemProperties
getset

System properties map from the cluster.

Definition at line 37 of file HAFailover.cs.

◆ WorkerRankUrls

IList\< Uri > kinetica.ClusterAddressInfo.WorkerRankUrls
getset

List of worker rank URLs.

Definition at line 42 of file HAFailover.cs.

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