Kinetica   C#   API  Version 7.2.3.0
kinetica.CreateDirectoryRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes

const string CREATE_HOME_DIRECTORY = "create_home_directory"
 When set, a home directory is created for the user name provided in the value. More...
 
const string DATA_LIMIT = "data_limit"
 The maximum capacity, in bytes, to apply to the created directory. More...
 
const string NO_ERROR_IF_EXISTS = "no_error_if_exists"
 If TRUE, does not return an error if the directory already exists. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 24 of file CreateDirectory.cs.

Member Data Documentation

◆ CREATE_HOME_DIRECTORY

const string kinetica.CreateDirectoryRequest.Options.CREATE_HOME_DIRECTORY = "create_home_directory"

When set, a home directory is created for the user name provided in the value.

The directory_name must be an empty string in this case. The user must exist.

Definition at line 31 of file CreateDirectory.cs.

◆ DATA_LIMIT

const string kinetica.CreateDirectoryRequest.Options.DATA_LIMIT = "data_limit"

The maximum capacity, in bytes, to apply to the created directory.

Set to -1 to indicate no upper limit. If empty, the system default limit is applied.

Definition at line 37 of file CreateDirectory.cs.

◆ FALSE

const string kinetica.CreateDirectoryRequest.Options.FALSE = "false"

Definition at line 55 of file CreateDirectory.cs.

◆ NO_ERROR_IF_EXISTS

const string kinetica.CreateDirectoryRequest.Options.NO_ERROR_IF_EXISTS = "no_error_if_exists"

If TRUE, does not return an error if the directory already exists.

Supported values:

The default value is FALSE.

Definition at line 52 of file CreateDirectory.cs.

◆ TRUE

const string kinetica.CreateDirectoryRequest.Options.TRUE = "true"

Definition at line 54 of file CreateDirectory.cs.


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