Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AdminRemoveHostRequest Class Reference

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

+ Inheritance diagram for kinetica.AdminRemoveHostRequest:
+ Collaboration diagram for kinetica.AdminRemoveHostRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 AdminRemoveHostRequest ()
 Constructs an AdminRemoveHostRequest object with default parameters. More...
 
 AdminRemoveHostRequest (string host, IDictionary< string, string > options=null)
 Constructs an AdminRemoveHostRequest 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. 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.adminRemoveHost(string,IDictionary{string, string}).


Removes a host from an existing cluster. If the host to be removed has any ranks running on it, the ranks must be removed using Kinetica.adminRemoveRanks(IList{string},IDictionary{string, string}) or manually switched over to a new host using Kinetica.adminSwitchover(IList{string},IList{string},IDictionary{string, string}) prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using Kinetica.adminSwitchover(IList{string},IList{string},IDictionary{string, string}).

Definition at line 28 of file AdminRemoveHost.cs.

Constructor & Destructor Documentation

kinetica.AdminRemoveHostRequest.AdminRemoveHostRequest ( )
inline

Constructs an AdminRemoveHostRequest object with default parameters.

Definition at line 113 of file AdminRemoveHost.cs.

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

Constructs an AdminRemoveHostRequest object with the specified parameters.

Parameters
hostIdentifies 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
optionsOptional parameters.
  • DRY_RUN: If set to true, only validation checks will be performed. No host is removed. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 145 of file AdminRemoveHost.cs.

Property Documentation

string kinetica.AdminRemoveHostRequest.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 83 of file AdminRemoveHost.cs.

IDictionary<string, string> kinetica.AdminRemoveHostRequest.options
getset

Optional parameters.

  • DRY_RUN: If set to true, only validation checks will be performed. No host is removed. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 108 of file AdminRemoveHost.cs.


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