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 options. More... | |
Public Member Functions | |
| AdminSwitchoverRequest () | |
| Constructs an AdminSwitchoverRequest object with default parameters. More... | |
| AdminSwitchoverRequest (IList< string > processes, IList< string > destinations, IDictionary< string, string > options=null) | |
| Constructs an AdminSwitchoverRequest 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 | |
| IList< string > | processes = new List<string>() [get, set] |
| Indicates the process identifier to switch over to another host. More... | |
| IList< string > | destinations = new List<string>() [get, set] |
| Indicates to which host to switch over each corresponding process given in processes. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.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/2]
|
inline |
Constructs an AdminSwitchoverRequest object with default parameters.
Definition at line 91 of file AdminSwitchover.cs.
◆ AdminSwitchoverRequest() [2/2]
|
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. The default value is an empty Dictionary.
Definition at line 135 of file AdminSwitchover.cs.
Property Documentation
◆ destinations
|
getset |
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.
Definition at line 64 of file AdminSwitchover.cs.
◆ options
|
getset |
◆ processes
|
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 destinations.
Definition at line 53 of file AdminSwitchover.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AdminSwitchover.cs
