DataLakeStoreFileSystemManagementClient (preview:2015-10-01)

2025/09/19 • 4 new methods

FileSystem_ConcurrentAppend (new)
Description :  Appends to the specified file. This method supports multiple concurrent appends to the file. NOTE: ConcurrentAppend and normal (serial) Append CANNOT be used interchangeably; once a file has been appended to using either of these append options, it can only be appended to using that append option. ConcurrentAppend DOES NOT guarantee order and can result in duplicated data landing in the target file. In order to close a file after using ConcurrentAppend, call the Flush method.
Reference :  Link ¶

⚼ Request

POST:  /WebHdfsExt/{filePath}
{
filePath:
{
Description: The Data Lake Store path (starting with '/') of the file to which to append using concurrent append. ,
Required: True ,
}
string ,
streamContents:
{
Description: The file contents to include when appending to the file. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks. ,
Required: True ,
}
object ,
appendMode:
{
Description: Indicates the concurrent append call should create the file if it doesn't exist or just open the existing file for append ,
Required: False ,
}
string ,
op:
{
Description: The constant value for the operation. ,
Required: True ,
}
string ,
Transfer-Encoding:
{
Description: Indicates the data being sent to the server is being streamed in chunks. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
RemoteException:
{
Description: the object representing the actual WebHDFS exception being returned. ,
Required: False ,
}
{
exception:
{
Description: the class name of the exception thrown, such as 'IllegalArgumentException'. ,
Required: True ,
}
string ,
javaClassName:
{
Description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'. ,
Required: False ,
}
string ,
message:
{
Description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'. ,
Required: False ,
}
string ,
}
,
}
FileSystem_SetFileExpiry (new)
Description :  Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported.
Reference :  Link ¶

⚼ Request

PUT:  /WebHdfsExt/{filePath}
{
filePath:
{
Description: The Data Lake Store path (starting with '/') of the file on which to set or remove the expiration time. ,
Required: True ,
}
string ,
expiryOption:
{
Description: Indicates the type of expiration to use for the file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is an integer in milliseconds representing the expiration date relative to when file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an integer in milliseconds representing the expiration date relative to file creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00. ,
Required: True ,
}
string ,
expireTime:
{
Description: The time that the file will expire, corresponding to the ExpiryOption that was set. ,
Format: int64 ,
Required: False ,
}
integer ,
op:
{
Description: The constant value for the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
RemoteException:
{
Description: the object representing the actual WebHDFS exception being returned. ,
Required: False ,
}
{
exception:
{
Description: the class name of the exception thrown, such as 'IllegalArgumentException'. ,
Required: True ,
}
string ,
javaClassName:
{
Description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'. ,
Required: False ,
}
string ,
message:
{
Description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'. ,
Required: False ,
}
string ,
}
,
}
FileSystem_CheckAccess (new)
Description :  Checks if the specified access is available at the given path.
Reference :  Link ¶

⚼ Request

GET:  /webhdfs/v1/{path}
{
path:
{
Description: The Data Lake Store path (starting with '/') of the file or directory for which to check access. ,
Required: True ,
}
string ,
fsaction:
{
Description: File system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}' ,
Required: False ,
}
string ,
op:
{
Description: The constant value for the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
RemoteException:
{
Description: the object representing the actual WebHDFS exception being returned. ,
Required: False ,
}
{
exception:
{
Description: the class name of the exception thrown, such as 'IllegalArgumentException'. ,
Required: True ,
}
string ,
javaClassName:
{
Description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'. ,
Required: False ,
}
string ,
message:
{
Description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'. ,
Required: False ,
}
string ,
}
,
}
FileSystem_Mkdirs (new)
Description :  Creates a directory.
Reference :  Link ¶

⚼ Request

PUT:  /webhdfs/v1/{path}
{
path:
{
Description: The Data Lake Store path (starting with '/') of the directory to create. ,
Required: True ,
}
string ,
op:
{
Description: The constant value for the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boolean:
{
Description: the result of the operation or request. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
RemoteException:
{
Description: the object representing the actual WebHDFS exception being returned. ,
Required: False ,
}
{
exception:
{
Description: the class name of the exception thrown, such as 'IllegalArgumentException'. ,
Required: True ,
}
string ,
javaClassName:
{
Description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'. ,
Required: False ,
}
string ,
message:
{
Description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'. ,
Required: False ,
}
string ,
}
,
}