Skip to main content

A set of parameters for Kinetica.deleteGraph. More…

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

Classes

struct  Options
 A set of string constants for the parameter DeleteGraphRequest.options. More…
 

Public Member Functions

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

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

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

Definition at line 16 of file DeleteGraph.cs.

Constructor & Destructor Documentation

◆ DeleteGraphRequest() [1/4]

kinetica.DeleteGraphRequest.DeleteGraphRequest ()
inline

Constructs a DeleteGraphRequest object with default parameters.

Definition at line 108 of file DeleteGraph.cs.

◆ DeleteGraphRequest() [2/4]

kinetica.DeleteGraphRequest.DeleteGraphRequest (stringgraph_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.
  • SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
The default value is an empty Dictionary.

Definition at line 154 of file DeleteGraph.cs.

◆ DeleteGraphRequest() [3/4]

kinetica.DeleteGraphRequest.DeleteGraphRequest ()
inline

Constructs a DeleteGraphRequest object with default parameters.

Definition at line 108 of file DeleteGraph.cs.

◆ DeleteGraphRequest() [4/4]

kinetica.DeleteGraphRequest.DeleteGraphRequest (stringgraph_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.
  • SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
The default value is an empty Dictionary.

Definition at line 154 of file DeleteGraph.cs.

Property Documentation

◆ graph_name

string kinetica.DeleteGraphRequest.graph_name
getset

Name of the graph to be deleted.

Definition at line 62 of file DeleteGraph.cs.

◆ options

IDictionary< string, string > kinetica.DeleteGraphRequest.options = new Dictionary<string, string>()
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.
  • SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.

The default value is an empty Dictionary.

Definition at line 104 of file DeleteGraph.cs.


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