A set of parameters for Kinetica.adminRemoveHost. More...

Inheritance diagram for AdminRemoveHostRequest:

Collaboration diagram for AdminRemoveHostRequest:

Classes
struct	Options
	A set of string constants for the parameter options. 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 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 = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

Additional Inherited Members
Static Public Member Functions inherited from 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.

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 or manually switched over to a new host using Kinetica.adminSwitchover 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.

Definition at line 24 of file AdminRemoveHost.cs.

Constructor & Destructor Documentation

◆ AdminRemoveHostRequest() [1/2]

AdminRemoveHostRequest.AdminRemoveHostRequest ( )

inline

Constructs an AdminRemoveHostRequest object with default parameters.

Definition at line 79 of file AdminRemoveHost.cs.

◆ AdminRemoveHostRequest() [2/2]

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

inline

Constructs an AdminRemoveHostRequest 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. DRY_RUN: If set to TRUE, only validation checks will be performed. No host is removed. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 107 of file AdminRemoveHost.cs.

Property Documentation

◆ host

string 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 53 of file AdminRemoveHost.cs.

◆ options

IDictionary<string, string> AdminRemoveHostRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

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

The default value is an empty Dictionary.

Definition at line 75 of file AdminRemoveHost.cs.

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

Kinetica/Protocol/AdminRemoveHost.cs

Classes

Public Member Functions

Properties