kinetica.DeleteGraphRequest Class Reference
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 options. 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... | |
| 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... | |
| 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 = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
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... | |
| 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.
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]
|
inline |
Constructs a DeleteGraphRequest object with default parameters.
Definition at line 86 of file DeleteGraph.cs.
◆ DeleteGraphRequest() [2/4]
|
inline |
Constructs a DeleteGraphRequest object with the specified parameters.
- Parameters
-
graph_name Name of the graph to be deleted. options 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.
Definition at line 123 of file DeleteGraph.cs.
◆ DeleteGraphRequest() [3/4]
|
inline |
Constructs a DeleteGraphRequest object with default parameters.
Definition at line 86 of file DeleteGraph.cs.
◆ DeleteGraphRequest() [4/4]
|
inline |
Constructs a DeleteGraphRequest object with the specified parameters.
- Parameters
-
graph_name Name of the graph to be deleted. options 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.
Definition at line 123 of file DeleteGraph.cs.
Property Documentation
◆ graph_name
|
getset |
Name of the graph to be deleted.
Definition at line 49 of file DeleteGraph.cs.
◆ 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.
- 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 82 of file DeleteGraph.cs.
The documentation for this class was generated from the following file:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/DeleteGraph.cs
