kinetica.AlterDirectoryRequest Class Reference

A set of parameters for Kinetica.alterDirectory. More...

Inheritance diagram for kinetica.AlterDirectoryRequest:

Collaboration diagram for kinetica.AlterDirectoryRequest:

Classes
struct	DirectoryUpdatesMap
	A set of string constants for the parameter directory_updates_map. More...

Public Member Functions
	AlterDirectoryRequest ()
	Constructs an AlterDirectoryRequest object with default parameters. More...
	AlterDirectoryRequest (string directory_name, IDictionary< string, string > directory_updates_map, IDictionary< string, string > options=null)
	Constructs an AlterDirectoryRequest object with the specified parameters. More...
	AlterDirectoryRequest ()
	Constructs an AlterDirectoryRequest object with default parameters. More...
	AlterDirectoryRequest (string directory_name, IDictionary< string, string > directory_updates_map, IDictionary< string, string > options=null)
	Constructs an AlterDirectoryRequest 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	directory_name [get, set]
	Name of the directory in KiFS to be altered. More...
IDictionary< string, string >	directory_updates_map = new Dictionary<string, string>() [get, set]
	Map containing the properties of the directory to be altered. 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.alterDirectory.

Alters an existing directory in KiFS.

Definition at line 16 of file AlterDirectory.cs.

Constructor & Destructor Documentation

AlterDirectoryRequest() [1/4]

kinetica.AlterDirectoryRequest.AlterDirectoryRequest ( )

inline

Constructs an AlterDirectoryRequest object with default parameters.

Definition at line 55 of file AlterDirectory.cs.

AlterDirectoryRequest() [2/4]

kinetica.AlterDirectoryRequest.AlterDirectoryRequest ( string  directory_name, IDictionary< string, string >  directory_updates_map, IDictionary< string, string >  options = null  )

inline

Constructs an AlterDirectoryRequest object with the specified parameters.

Parameters

directory_name	Name of the directory in KiFS to be altered.
directory_updates_map	Map containing the properties of the directory to be altered. Error if empty. DATA_LIMIT: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 76 of file AlterDirectory.cs.

AlterDirectoryRequest() [3/4]

kinetica.AlterDirectoryRequest.AlterDirectoryRequest ( )

inline

Constructs an AlterDirectoryRequest object with default parameters.

Definition at line 55 of file AlterDirectory.cs.

AlterDirectoryRequest() [4/4]

kinetica.AlterDirectoryRequest.AlterDirectoryRequest ( string  directory_name, IDictionary< string, string >  directory_updates_map, IDictionary< string, string >  options = null  )

inline

Constructs an AlterDirectoryRequest object with the specified parameters.

Parameters

directory_name	Name of the directory in KiFS to be altered.
directory_updates_map	Map containing the properties of the directory to be altered. Error if empty. DATA_LIMIT: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 76 of file AlterDirectory.cs.

Property Documentation

directory_name

string kinetica.AlterDirectoryRequest.directory_name

getset

Name of the directory in KiFS to be altered.

Definition at line 32 of file AlterDirectory.cs.

directory_updates_map

IDictionary< string, string > kinetica.AlterDirectoryRequest.directory_updates_map = new Dictionary<string, string>()

getset

Map containing the properties of the directory to be altered.

• DATA_LIMIT: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.

Definition at line 46 of file AlterDirectory.cs.

options

IDictionary< string, string > kinetica.AlterDirectoryRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 51 of file AlterDirectory.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/AlterDirectory.cs