kinetica.AdminAlterHostRequest Class Reference

A set of parameters for Kinetica.adminAlterHost(string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.AdminAlterHostRequest:

Collaboration diagram for kinetica.AdminAlterHostRequest:

Classes
struct	Options
	Optional parameters ACCEPTS_FAILOVER: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. More...

Public Member Functions
	AdminAlterHostRequest ()
	Constructs an AdminAlterHostRequest object with default parameters. More...
	AdminAlterHostRequest (string host, IDictionary< string, string > options=null)
	Constructs an AdminAlterHostRequest object with the specified parameters. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	host [get, set]
	Identifies the host this applies to. More...
IDictionary< string, string >	options [get, set]
	Optional parameters ACCEPTS_FAILOVER: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.adminAlterHost(string,IDictionary{string, string}).

Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes.

Definition at line 21 of file AdminAlterHost.cs.

Constructor & Destructor Documentation

kinetica.AdminAlterHostRequest.AdminAlterHostRequest ( )

inline

Constructs an AdminAlterHostRequest object with default parameters.

Definition at line 109 of file AdminAlterHost.cs.

kinetica.AdminAlterHostRequest.AdminAlterHostRequest ( string  host, IDictionary< string, string >  options = null  )

inline

Constructs an AdminAlterHostRequest object with the specified parameters.

Parameters

host	Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf
options	Optional parameters ACCEPTS_FAILOVER: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 142 of file AdminAlterHost.cs.

Property Documentation

string kinetica.AdminAlterHostRequest.host

getset

Identifies the host this applies to.

Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf

Definition at line 78 of file AdminAlterHost.cs.

IDictionary<string, string> kinetica.AdminAlterHostRequest.options

getset

Optional parameters

• ACCEPTS_FAILOVER: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster.

Supported values:

• TRUE
• FALSE

The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 104 of file AdminAlterHost.cs.

---

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

• Kinetica/Protocol/AdminAlterHost.cs