> ## 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.AdminSwitchoverRequest > kinetica.AdminSwitchoverRequest — Kinetica C# API

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

Inheritance diagram for kinetica.AdminSwitchoverRequest:
Collaboration diagram for kinetica.AdminSwitchoverRequest:

Classes
struct   Options
  A set of string constants for the parameter AdminSwitchoverRequest.options. More...
 

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

Properties
IList\< string >  processes = new List\() \[get, set]
  Indicates the process identifier to switch over to another host.
 
IList\< string >  destinations = new List\() \[get, set]
  Indicates to which host to switch over each corresponding process given in AdminSwitchoverRequest.processes.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.adminSwitchover.

Manually switch over one or more processes to another host. Individual ranks or entire hosts may be moved to another host.

Definition at line 17 of file AdminSwitchover.cs.

Constructor & Destructor Documentation

◆ AdminSwitchoverRequest() \[1/4]

kinetica.AdminSwitchoverRequest.AdminSwitchoverRequest ( )
inline

Constructs an AdminSwitchoverRequest object with default parameters.

Definition at line 111 of file AdminSwitchover.cs.

◆ AdminSwitchoverRequest() \[2/4]

kinetica.AdminSwitchoverRequest.AdminSwitchoverRequest ( IList\< string > processes,
IList\< string > destinations,
IDictionary\< string, string > options = null )
inline

Constructs an AdminSwitchoverRequest object with the specified parameters.

Parameters
processes Indicates the process identifier to switch over to another host. Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address' or 'rank\[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in destinations .
destinations Indicates to which host to switch over each corresponding process given in processes . Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address'. Each entry in this array will receive the corresponding process entry at the same index in processes .
options Optional parameters.
  • DRY\_RUN: If set to TRUE, only validation checks will be performed. Nothing is switched over. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 161 of file AdminSwitchover.cs.

◆ AdminSwitchoverRequest() \[3/4]

kinetica.AdminSwitchoverRequest.AdminSwitchoverRequest ( )
inline

Constructs an AdminSwitchoverRequest object with default parameters.

Definition at line 111 of file AdminSwitchover.cs.

◆ AdminSwitchoverRequest() \[4/4]

kinetica.AdminSwitchoverRequest.AdminSwitchoverRequest ( IList\< string > processes,
IList\< string > destinations,
IDictionary\< string, string > options = null )
inline

Constructs an AdminSwitchoverRequest object with the specified parameters.

Parameters
processes Indicates the process identifier to switch over to another host. Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address' or 'rank\[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in destinations .
destinations Indicates to which host to switch over each corresponding process given in processes . Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address'. Each entry in this array will receive the corresponding process entry at the same index in processes .
options Optional parameters.
  • DRY\_RUN: If set to TRUE, only validation checks will be performed. Nothing is switched over. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 161 of file AdminSwitchover.cs.

Property Documentation

◆ destinations

IList\< string > kinetica.AdminSwitchoverRequest.destinations = new List\()
getset

Indicates to which host to switch over each corresponding process given in AdminSwitchoverRequest.processes.

Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address'. Each entry in this array will receive the corresponding process entry at the same index in AdminSwitchoverRequest.processes.

Definition at line 77 of file AdminSwitchover.cs.

◆ options

IDictionary\< string, string > kinetica.AdminSwitchoverRequest.options = new Dictionary\()
getset

Optional parameters.

  • DRY\_RUN: If set to TRUE, only validation checks will be performed. Nothing is switched over. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 107 of file AdminSwitchover.cs.

◆ processes

IList\< string > kinetica.AdminSwitchoverRequest.processes = new List\()
getset

Indicates the process identifier to switch over to another host.

Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host\[N].address' or 'rank\[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in AdminSwitchoverRequest.destinations.

Definition at line 65 of file AdminSwitchover.cs.

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