diff --git a/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/FileSystemOperations.Customizations.cs b/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/FileSystemOperations.Customizations.cs index 89919383e8469..3b9245fdf852d 100644 --- a/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/FileSystemOperations.Customizations.cs +++ b/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/FileSystemOperations.Customizations.cs @@ -19,6 +19,7 @@ namespace Microsoft.Azure.Management.DataLake.Store using Newtonsoft.Json; using Microsoft.Rest.Azure; using Models; + using System.IO; /// /// FileSystemOperations operations. @@ -230,6 +231,57 @@ internal partial class FileSystemOperations : IServiceOperations + /// Downloads a file from the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The Data Lake Store path (starting with '/') of the file to download. + /// + /// + /// The local path to download the file to. If a directory is specified, the file name will be the same as the source file name + /// + /// + /// The maximum number of threads to use during the download. By default, this number will be computed based on file size. + /// + /// + /// A switch indicating if this download is a continuation of a previous, failed download. Default is false. + /// + /// + /// A switch indicating this download should overwrite the the target file if it exists. Default is false, and the download will fast fail if the target file exists. + /// + /// + /// An optional delegate that can be used to track the progress of the download operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid download is attempted or a file is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// public void DownloadFile( string accountName, string sourcePath, @@ -300,6 +352,60 @@ public void DownloadFile( } } + /// + /// Uploads a file to the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The local source file to upload to the Data Lake Store account. + /// + /// + /// The Data Lake Store path (starting with '/') of the directory or directory and filename to upload to. + /// + /// + /// The maximum number of threads to use during the upload. By default, this number will be computed based on file size. + /// + /// + /// A switch indicating if this upload is a continuation of a previous, failed upload. Default is false. + /// + /// + /// A switch indicating this upload should overwrite the target file if it exists. Default is false, and the upload will fast fail if the target file exists. + /// + /// + /// A switch indicating this upload should treat the file as binary, which is slightly more performant but does not ensure record boundary integrity. + /// + /// + /// An optional delegate that can be used to track the progress of the upload operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid upload is attempted or the file is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// public void UploadFile( string accountName, string sourcePath, @@ -372,6 +478,63 @@ public void UploadFile( } } + /// + /// Downloads a folder from the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The Data Lake Store path (starting with '/') of the directory to download. + /// + /// + /// The local path to download the folder to. + /// + /// + /// The maximum number of threads to use per file during the download. By default, this number will be computed based on folder structure and average file size. + /// + /// + /// The maximum number of files to download at once. By default, this number will be computed based on folder structure and number of files. + /// + /// + /// A switch indicating if this download is a continuation of a previous, failed download. Default is false. + /// + /// + /// A switch indicating this download should overwrite the contents of the target directory if it exists. Default is false, and the download will fast fail if the target location exists. + /// + /// + /// A switch indicating this download should download the source directory recursively or just the top level. Default is false, only the top level will be downloaded. + /// + /// + /// An optional delegate that can be used to track the progress of the download operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid download is attempted or a file/folder is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// public void DownloadFolder( string accountName, string sourcePath, @@ -449,6 +612,66 @@ public void DownloadFolder( } } + /// + /// Uploads a folder to the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The local source folder to upload to the Data Lake Store account. + /// + /// + /// The Data Lake Store path (starting with '/') of the directory to upload to. + /// + /// + /// The maximum number of threads to use per file during the upload. By default, this number will be computed based on folder structure and average file size. + /// + /// + /// The maximum number of files to upload at once. By default, this number will be computed based on folder structure and number of files. + /// + /// + /// A switch indicating if this upload is a continuation of a previous, failed upload. Default is false. + /// + /// + /// A switch indicating this upload should overwrite the contents of the target directory if it exists. Default is false, and the upload will fast fail if the target location exists. + /// + /// + /// A switch indicating this upload should treat all data as binary, which is slightly more performant but does not ensure record boundary integrity. This is recommended for large folders of mixed binary and text files or binary only directories. Default is false + /// + /// + /// A switch indicating this upload should upload the source directory recursively or just the top level. Default is false, only the top level will be uploaded. + /// + /// + /// An optional delegate that can be used to track the progress of the upload operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid upload is attempted or a file/folder is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// public void UploadFolder( string accountName, string sourcePath, diff --git a/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/IFileSystemOperations.Customizations.cs b/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/IFileSystemOperations.Customizations.cs index 461c739c5c522..fd5e3a73321d8 100644 --- a/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/IFileSystemOperations.Customizations.cs +++ b/src/SDKs/DataLake.Store/Management.DataLake.Store/Customizations/IFileSystemOperations.Customizations.cs @@ -12,6 +12,7 @@ namespace Microsoft.Azure.Management.DataLake.Store using Microsoft.Rest; using Microsoft.Rest.Azure; using Models; + using System.IO; /// /// FileSystemOperations operations. @@ -48,6 +49,66 @@ public partial interface IFileSystemOperations /// Task> PathExistsWithHttpMessagesAsync(string accountName, string getFilePath, Dictionary> customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)); + /// + /// Uploads a folder to the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The local source folder to upload to the Data Lake Store account. + /// + /// + /// The Data Lake Store path (starting with '/') of the directory to upload to. + /// + /// + /// The maximum number of threads to use per file during the upload. By default, this number will be computed based on folder structure and average file size. + /// + /// + /// The maximum number of files to upload at once. By default, this number will be computed based on folder structure and number of files. + /// + /// + /// A switch indicating if this upload is a continuation of a previous, failed upload. Default is false. + /// + /// + /// A switch indicating this upload should overwrite the contents of the target directory if it exists. Default is false, and the upload will fast fail if the target location exists. + /// + /// + /// A switch indicating this upload should treat all data as binary, which is slightly more performant but does not ensure record boundary integrity. This is recommended for large folders of mixed binary and text files or binary only directories. Default is false + /// + /// + /// A switch indicating this upload should upload the source directory recursively or just the top level. Default is false, only the top level will be uploaded. + /// + /// + /// An optional delegate that can be used to track the progress of the upload operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid upload is attempted or a file/folder is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// void UploadFolder( string accountName, string sourcePath, @@ -61,6 +122,63 @@ void UploadFolder( IProgress progressTracker = null, CancellationToken cancellationToken = default(CancellationToken)); + /// + /// Downloads a folder from the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The Data Lake Store path (starting with '/') of the directory to download. + /// + /// + /// The local path to download the folder to. + /// + /// + /// The maximum number of threads to use per file during the download. By default, this number will be computed based on folder structure and average file size. + /// + /// + /// The maximum number of files to download at once. By default, this number will be computed based on folder structure and number of files. + /// + /// + /// A switch indicating if this download is a continuation of a previous, failed download. Default is false. + /// + /// + /// A switch indicating this download should overwrite the contents of the target directory if it exists. Default is false, and the download will fast fail if the target location exists. + /// + /// + /// A switch indicating this download should download the source directory recursively or just the top level. Default is false, only the top level will be downloaded. + /// + /// + /// An optional delegate that can be used to track the progress of the download operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid download is attempted or a file/folder is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// void DownloadFolder( string accountName, string sourcePath, @@ -73,6 +191,60 @@ void DownloadFolder( IProgress progressTracker = null, CancellationToken cancellationToken = default(CancellationToken)); + /// + /// Uploads a file to the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The local source file to upload to the Data Lake Store account. + /// + /// + /// The Data Lake Store path (starting with '/') of the directory or directory and filename to upload to. + /// + /// + /// The maximum number of threads to use during the upload. By default, this number will be computed based on file size. + /// + /// + /// A switch indicating if this upload is a continuation of a previous, failed upload. Default is false. + /// + /// + /// A switch indicating this upload should overwrite the target file if it exists. Default is false, and the upload will fast fail if the target file exists. + /// + /// + /// A switch indicating this upload should treat the file as binary, which is slightly more performant but does not ensure record boundary integrity. + /// + /// + /// An optional delegate that can be used to track the progress of the upload operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid upload is attempted or the file is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// void UploadFile( string accountName, string sourcePath, @@ -84,6 +256,57 @@ void UploadFile( IProgress progressTracker = null, CancellationToken cancellationToken = default(CancellationToken)); + /// + /// Downloads a file from the specified Data Lake Store account. + /// + /// + /// The Azure Data Lake Store account to execute filesystem operations on. + /// + /// + /// The Data Lake Store path (starting with '/') of the file to download. + /// + /// + /// The local path to download the file to. If a directory is specified, the file name will be the same as the source file name + /// + /// + /// The maximum number of threads to use during the download. By default, this number will be computed based on file size. + /// + /// + /// A switch indicating if this download is a continuation of a previous, failed download. Default is false. + /// + /// + /// A switch indicating this download should overwrite the the target file if it exists. Default is false, and the download will fast fail if the target file exists. + /// + /// + /// An optional delegate that can be used to track the progress of the download operation asynchronously. + /// + /// + /// The cancellation token. + /// + /// + /// Thrown when the operation returned an invalid status code. + /// + /// + /// Thrown when the operation takes too long to complete or if the user explicitly cancels it. + /// + /// + /// Thrown when resume metadata is corrupt or not associated with the current operation. + /// + /// + /// Thrown when the source path cannot be found. + /// + /// + /// Thrown if an invalid download is attempted or a file is modified externally during the operation. + /// + /// + /// Thrown if the transfer operation fails. + /// + /// + /// Thrown when unable to deserialize the response + /// + /// + /// Thrown when a required parameter is null + /// void DownloadFile( string accountName, string sourcePath,