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

A set of parameters for Kinetica.deleteGraph(string,IDictionary{string, string}). More...

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

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 DeleteGraphRequest ()
 Constructs a DeleteGraphRequest object with default parameters. More...
 
 DeleteGraphRequest (string graph_name, IDictionary< string, string > options=null)
 Constructs a DeleteGraphRequest 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

string graph_name [get, set]
 Name of the graph to be deleted. 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 Kinetica.deleteGraph(string,IDictionary{string, string}).


Deletes an existing graph from the graph server and/or persist.

Definition at line 19 of file DeleteGraph.cs.

Constructor & Destructor Documentation

kinetica.DeleteGraphRequest.DeleteGraphRequest ( )
inline

Constructs a DeleteGraphRequest object with default parameters.

Definition at line 111 of file DeleteGraph.cs.

kinetica.DeleteGraphRequest.DeleteGraphRequest ( string  graph_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a DeleteGraphRequest object with the specified parameters.

Parameters
graph_nameName of the graph to be deleted.
optionsOptional parameters.
  • DELETE_PERSIST: If set to true, the graph is removed from the server and persist. If set to false, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. Supported values: The default value is TRUE.
The default value is an empty Dictionary.

Definition at line 144 of file DeleteGraph.cs.

Property Documentation

string kinetica.DeleteGraphRequest.graph_name
getset

Name of the graph to be deleted.

Definition at line 78 of file DeleteGraph.cs.

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

Optional parameters.

  • DELETE_PERSIST: If set to true, the graph is removed from the server and persist. If set to false, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. Supported values: The default value is TRUE.

The default value is an empty Dictionary.

Definition at line 106 of file DeleteGraph.cs.


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