A set of parameters for Kinetica.adminOffline. More…
Classes | |
| struct | Offline |
| A set of string constants for the parameter AdminOfflineRequest.offline. More… | |
| struct | Options |
| A set of string constants for the parameter AdminOfflineRequest.options. More… | |
Public Member Functions | |
| AdminOfflineRequest () | |
| Constructs an AdminOfflineRequest object with default parameters. | |
| AdminOfflineRequest (bool offline, IDictionary< string, string > options=null) | |
| Constructs an AdminOfflineRequest object with the specified parameters. | |
| AdminOfflineRequest () | |
| Constructs an AdminOfflineRequest object with default parameters. | |
| AdminOfflineRequest (bool offline, IDictionary< string, string > options=null) | |
| Constructs an AdminOfflineRequest 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 | |
| bool | offline [get, set] |
| Set to true if desired state is offline. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.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/4]
| inline |
Constructs an AdminOfflineRequest object with default parameters.
Definition at line 101 of file AdminOffline.cs.
◆ AdminOfflineRequest() [2/4]
| inline |
Constructs an AdminOfflineRequest object with the specified parameters.
| offline | Set to true if desired state is offline. Supported values:
|
| options | Optional parameters.
|
Definition at line 139 of file AdminOffline.cs.
◆ AdminOfflineRequest() [3/4]
| inline |
Constructs an AdminOfflineRequest object with default parameters.
Definition at line 101 of file AdminOffline.cs.
◆ AdminOfflineRequest() [4/4]
| inline |
Constructs an AdminOfflineRequest object with the specified parameters.
| offline | Set to true if desired state is offline. Supported values:
|
| options | Optional parameters.
|
Definition at line 139 of file AdminOffline.cs.
Property Documentation
◆ offline
| getset |
Set to true if desired state is offline.
Supported values:
- true
- false
Definition at line 72 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 97 of file AdminOffline.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AdminOffline.cs
- Kinetica/Protocol/AdminOffline.cs