Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CreateDirectoryRequest.Options Struct Reference

Optional parameters. 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 Supported values:

The default value is FALSE. More...

 
const string TRUE = "true"
 
const string FALSE = "false"
 

Detailed Description

Optional parameters.

  • CREATE_HOME_DIRECTORY: When set, a home directory is created for the user name provided in the value. The must be an empty string in this case. The user must exist.
  • 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.
  • NO_ERROR_IF_EXISTS: If true, does not return an error if the directory already exists Supported values: The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 67 of file CreateDirectory.cs.

Member Data Documentation

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 74 of file CreateDirectory.cs.

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 79 of file CreateDirectory.cs.

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

Definition at line 98 of file CreateDirectory.cs.

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 96 of file CreateDirectory.cs.

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

Definition at line 97 of file CreateDirectory.cs.


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