Share via


IFileSystemOperations Interface

Definition

FileSystemOperations operations.

public interface IFileSystemOperations
type IFileSystemOperations = interface
Public Interface IFileSystemOperations

Methods

AppendWithHttpMessagesAsync(String, String, Stream, Nullable<Int64>, Nullable<SyncFlag>, Nullable<Guid>, Nullable<Guid>, Dictionary<String, List<String>>, CancellationToken)

Used for serial appends to the specified file. NOTE: The target must not contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file.

CheckAccessWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Checks if the specified access is available at the given path.

ConcatWithHttpMessagesAsync(String, String, IList<String>, Dictionary<String,List<String>>, CancellationToken)

Concatenates the list of source files into the destination file, removing all source files upon success.

ConcurrentAppendWithHttpMessagesAsync(String, String, Stream, Nullable<AppendModeType>, Nullable<SyncFlag>, Dictionary<String, List<String>>, CancellationToken)

Appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file.

CreateWithHttpMessagesAsync(String, String, Stream, Nullable<Boolean>, Nullable<SyncFlag>, Nullable<Guid>, Nullable<Int32>, Dictionary<String, List<String>>, CancellationToken)

Creates a file with optionally specified content. NOTE: If content is provided, the resulting file cannot be modified using ConcurrentAppend.

DeleteWithHttpMessagesAsync(String, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Deletes the requested file or directory, optionally recursively.

DownloadFile(String, String, String, Int32, Boolean, Boolean, IProgress<TransferProgress>, CancellationToken)

Downloads a file from the specified Data Lake Store account.

DownloadFolder(String, String, String, Int32, Int32, Boolean, Boolean, Boolean, IProgress<TransferFolderProgress>, CancellationToken)

Downloads a folder from the specified Data Lake Store account.

GetAclStatusWithHttpMessagesAsync(String, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Gets Access Control List (ACL) entries for the specified file or directory.

GetContentSummaryWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Gets the file content summary object specified by the file path.

GetFileStatusWithHttpMessagesAsync(String, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Get the file status object specified by the file path.

ListFileStatusWithHttpMessagesAsync(String, String, Nullable<Int32>, String, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Get the list of file status objects specified by the file path, with optional pagination parameters

MkdirsWithHttpMessagesAsync(String, String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken)

Creates a directory.

ModifyAclEntriesWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Modifies existing Access Control List (ACL) entries on a file or folder.

MsConcatWithHttpMessagesAsync(String, String, Stream, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Concatenates the list of source files into the destination file, deleting all source files upon success. This method accepts more source file paths than the Concat method. This method and the parameters it accepts are subject to change for usability in an upcoming version.

OpenWithHttpMessagesAsync(String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Guid>, Dictionary<String,List<String>>, CancellationToken)

Opens and reads from the specified file.

PathExistsWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Test the existence of a file or directory object specified by the file path.

RemoveAclEntriesWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Removes existing Access Control List (ACL) entries for a file or folder.

RemoveAclWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Removes the existing Access Control List (ACL) of the specified file or directory.

RemoveDefaultAclWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Removes the existing Default Access Control List (ACL) of the specified directory.

RenameWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Rename a file or directory.

SetAclWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Sets the Access Control List (ACL) for a file or folder.

SetFileExpiryWithHttpMessagesAsync(String, String, ExpiryOptionType, Nullable<Int64>, Dictionary<String,List<String>>, CancellationToken)

Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported.

SetOwnerWithHttpMessagesAsync(String, String, String, String, Dictionary<String,List<String>>, CancellationToken)

Sets the owner of a file or directory.

SetPermissionWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken)

Sets the permission of the file or folder.

UploadFile(String, String, String, Int32, Boolean, Boolean, Boolean, IProgress<TransferProgress>, CancellationToken)

Uploads a file to the specified Data Lake Store account.

UploadFolder(String, String, String, Int32, Int32, Boolean, Boolean, Boolean, Boolean, IProgress<TransferFolderProgress>, CancellationToken)

Uploads a folder to the specified Data Lake Store account.

Extension Methods

Append(IFileSystemOperations, String, String, Stream, Nullable<Int64>, Nullable<SyncFlag>, Nullable<Guid>, Nullable<Guid>)

Used for serial appends to the specified file. NOTE: The target must not contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file.

AppendAsync(IFileSystemOperations, String, String, Stream, Nullable<Int64>, Nullable<SyncFlag>, Nullable<Guid>, Nullable<Guid>, CancellationToken)

Used for serial appends to the specified file. NOTE: The target must not contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file.

CheckAccess(IFileSystemOperations, String, String, String)

Checks if the specified access is available at the given path.

CheckAccessAsync(IFileSystemOperations, String, String, String, CancellationToken)

Checks if the specified access is available at the given path.

Concat(IFileSystemOperations, String, String, IList<String>)

Concatenates the list of source files into the destination file, removing all source files upon success.

ConcatAsync(IFileSystemOperations, String, String, IList<String>, CancellationToken)

Concatenates the list of source files into the destination file, removing all source files upon success.

ConcurrentAppend(IFileSystemOperations, String, String, Stream, Nullable<AppendModeType>, Nullable<SyncFlag>)

Appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file.

ConcurrentAppendAsync(IFileSystemOperations, String, String, Stream, Nullable<AppendModeType>, Nullable<SyncFlag>, CancellationToken)

Appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file.

Create(IFileSystemOperations, String, String, Stream, Nullable<Boolean>, Nullable<SyncFlag>, Nullable<Guid>, Nullable<Int32>)

Creates a file with optionally specified content. NOTE: If content is provided, the resulting file cannot be modified using ConcurrentAppend.

CreateAsync(IFileSystemOperations, String, String, Stream, Nullable<Boolean>, Nullable<SyncFlag>, Nullable<Guid>, Nullable<Int32>, CancellationToken)

Creates a file with optionally specified content. NOTE: If content is provided, the resulting file cannot be modified using ConcurrentAppend.

Delete(IFileSystemOperations, String, String, Nullable<Boolean>)

Deletes the requested file or directory, optionally recursively.

DeleteAsync(IFileSystemOperations, String, String, Nullable<Boolean>, CancellationToken)

Deletes the requested file or directory, optionally recursively.

GetAclStatus(IFileSystemOperations, String, String, Nullable<Boolean>)

Gets Access Control List (ACL) entries for the specified file or directory.

GetAclStatusAsync(IFileSystemOperations, String, String, Nullable<Boolean>, CancellationToken)

Gets Access Control List (ACL) entries for the specified file or directory.

GetContentSummary(IFileSystemOperations, String, String)

Gets the file content summary object specified by the file path.

GetContentSummaryAsync(IFileSystemOperations, String, String, CancellationToken)

Gets the file content summary object specified by the file path.

GetFileStatus(IFileSystemOperations, String, String, Nullable<Boolean>)

Get the file status object specified by the file path.

GetFileStatusAsync(IFileSystemOperations, String, String, Nullable<Boolean>, CancellationToken)

Get the file status object specified by the file path.

ListFileStatus(IFileSystemOperations, String, String, Nullable<Int32>, String, String, Nullable<Boolean>)

Get the list of file status objects specified by the file path, with optional pagination parameters

ListFileStatusAsync(IFileSystemOperations, String, String, Nullable<Int32>, String, String, Nullable<Boolean>, CancellationToken)

Get the list of file status objects specified by the file path, with optional pagination parameters

Mkdirs(IFileSystemOperations, String, String, Nullable<Int32>)

Creates a directory.

MkdirsAsync(IFileSystemOperations, String, String, Nullable<Int32>, CancellationToken)

Creates a directory.

ModifyAclEntries(IFileSystemOperations, String, String, String)

Modifies existing Access Control List (ACL) entries on a file or folder.

ModifyAclEntriesAsync(IFileSystemOperations, String, String, String, CancellationToken)

Modifies existing Access Control List (ACL) entries on a file or folder.

MsConcat(IFileSystemOperations, String, String, Stream, Nullable<Boolean>)

Concatenates the list of source files into the destination file, deleting all source files upon success. This method accepts more source file paths than the Concat method. This method and the parameters it accepts are subject to change for usability in an upcoming version.

MsConcatAsync(IFileSystemOperations, String, String, Stream, Nullable<Boolean>, CancellationToken)

Concatenates the list of source files into the destination file, deleting all source files upon success. This method accepts more source file paths than the Concat method. This method and the parameters it accepts are subject to change for usability in an upcoming version.

Open(IFileSystemOperations, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Guid>)

Opens and reads from the specified file.

OpenAsync(IFileSystemOperations, String, String, Nullable<Int64>, Nullable<Int64>, Nullable<Guid>, CancellationToken)

Opens and reads from the specified file.

PathExists(IFileSystemOperations, String, String)

Test the existence of a file or directory object specified by the file path.

PathExistsAsync(IFileSystemOperations, String, String, CancellationToken)

Test the existence of a file or directory object specified by the file path.

RemoveAcl(IFileSystemOperations, String, String)

Removes the existing Access Control List (ACL) of the specified file or directory.

RemoveAclAsync(IFileSystemOperations, String, String, CancellationToken)

Removes the existing Access Control List (ACL) of the specified file or directory.

RemoveAclEntries(IFileSystemOperations, String, String, String)

Removes existing Access Control List (ACL) entries for a file or folder.

RemoveAclEntriesAsync(IFileSystemOperations, String, String, String, CancellationToken)

Removes existing Access Control List (ACL) entries for a file or folder.

RemoveDefaultAcl(IFileSystemOperations, String, String)

Removes the existing Default Access Control List (ACL) of the specified directory.

RemoveDefaultAclAsync(IFileSystemOperations, String, String, CancellationToken)

Removes the existing Default Access Control List (ACL) of the specified directory.

Rename(IFileSystemOperations, String, String, String)

Rename a file or directory.

RenameAsync(IFileSystemOperations, String, String, String, CancellationToken)

Rename a file or directory.

SetAcl(IFileSystemOperations, String, String, String)

Sets the Access Control List (ACL) for a file or folder.

SetAclAsync(IFileSystemOperations, String, String, String, CancellationToken)

Sets the Access Control List (ACL) for a file or folder.

SetFileExpiry(IFileSystemOperations, String, String, ExpiryOptionType, Nullable<Int64>)

Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported.

SetFileExpiryAsync(IFileSystemOperations, String, String, ExpiryOptionType, Nullable<Int64>, CancellationToken)

Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported.

SetOwner(IFileSystemOperations, String, String, String, String)

Sets the owner of a file or directory.

SetOwnerAsync(IFileSystemOperations, String, String, String, String, CancellationToken)

Sets the owner of a file or directory.

SetPermission(IFileSystemOperations, String, String, String)

Sets the permission of the file or folder.

SetPermissionAsync(IFileSystemOperations, String, String, String, CancellationToken)

Sets the permission of the file or folder.

Applies to