/alter/directory

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/alter/directory

Alters an existing directory in KiFS.

Input Parameter Description

NameTypeDescription
directory_namestringName of the directory in KiFS to be altered.
directory_updates_mapmap of string to strings

Map containing the properties of the directory to be altered. Error if empty.

Supported Parameters (keys)Parameter Description
data_limitThe maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'alter_directory_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /alter/directory endpoint:

NameTypeDescription
directory_namestringValue of input parameter directory_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.