kinetica.AdminOfflineRequest Class Reference
A set of parameters for Kinetica.adminOffline. More...
Inheritance diagram for kinetica.AdminOfflineRequest:
Collaboration diagram for kinetica.AdminOfflineRequest:
Classes | |
| struct | Offline |
| A set of string constants for the parameter offline. More... | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| AdminOfflineRequest () | |
| Constructs an AdminOfflineRequest object with default parameters. More... | |
| AdminOfflineRequest (bool offline, IDictionary< string, string > options=null) | |
| Constructs an AdminOfflineRequest 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 | |
| bool | offline [get, set] |
| Set to true if desired state is offline. 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.adminOffline.
Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.
Definition at line 17 of file AdminOffline.cs.
Constructor & Destructor Documentation
◆ AdminOfflineRequest() [1/2]
|
inline |
Constructs an AdminOfflineRequest object with default parameters.
Definition at line 84 of file AdminOffline.cs.
◆ AdminOfflineRequest() [2/2]
|
inline |
Constructs an AdminOfflineRequest object with the specified parameters.
- Parameters
-
offline Set to true if desired state is offline. Supported values: - true
- false
options Optional parameters. - FLUSH_TO_DISK: Flush to disk when going offline. Supported values:
Definition at line 117 of file AdminOffline.cs.
Property Documentation
◆ offline
|
getset |
Set to true if desired state is offline.
Supported values:
- true
- false
Definition at line 60 of file AdminOffline.cs.
◆ options
|
getset |
Optional parameters.
- FLUSH_TO_DISK: Flush to disk when going offline. Supported values:
The default value is an empty Dictionary.
Definition at line 80 of file AdminOffline.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AdminOffline.cs
