Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AdminOfflineRequest Class Reference

A set of parameters for /admin/offline. More...

+ Inheritance diagram for kinetica.AdminOfflineRequest:
+ Collaboration diagram for kinetica.AdminOfflineRequest:

Classes

struct  Offline
 Set to true if desired state is offline. 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 [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 /admin/offline.


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 18 of file AdminOffline.cs.

Constructor & Destructor Documentation

kinetica.AdminOfflineRequest.AdminOfflineRequest ( )
inline

Constructs an AdminOfflineRequest object with default parameters.

Definition at line 44 of file AdminOffline.cs.

kinetica.AdminOfflineRequest.AdminOfflineRequest ( bool  offline,
IDictionary< string, string >  options = null 
)
inline

Constructs an AdminOfflineRequest object with the specified parameters.

Parameters
offlineSet to true if desired state is offline. Values: true, false.
optionsOptional parameters.

Definition at line 54 of file AdminOffline.cs.

Property Documentation

bool kinetica.AdminOfflineRequest.offline
getset

Set to true if desired state is offline.

Values: true, false.

Definition at line 36 of file AdminOffline.cs.

IDictionary<string, string> kinetica.AdminOfflineRequest.options
getset

Optional parameters.

Definition at line 39 of file AdminOffline.cs.


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