@azure/storage-file-datalake 12.26.0 → 12.27.0-beta.1

package/dist/commonjs/DataLakeFileSystemClient.js

@@ -0,0 +1,683 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataLakeFileSystemClient = void 0;
+const tslib_1 = require("tslib");
+const storage_blob_1 = require("@azure/storage-blob");
+const Pipeline_js_1 = require("./Pipeline.js");
+const StorageSharedKeyCredential_js_1 = require("./credentials/StorageSharedKeyCredential.js");
+const storage_blob_2 = require("@azure/storage-blob");
+const DataLakeLeaseClient_js_1 = require("./DataLakeLeaseClient.js");
+const index_js_1 = require("./generated/src/operations/index.js");
+const StorageClient_js_1 = require("./StorageClient.js");
+const transforms_js_1 = require("./transforms.js");
+const tracing_js_1 = require("./utils/tracing.js");
+const utils_common_js_1 = require("./utils/utils.common.js");
+const clients_js_1 = require("./clients.js");
+const DataLakeSASSignatureValues_js_1 = require("./sas/DataLakeSASSignatureValues.js");
+const constants_js_1 = require("./utils/constants.js");
+const PathClientInternal_js_1 = require("./utils/PathClientInternal.js");
+/**
+ * A DataLakeFileSystemClient represents a URL to the Azure Storage file system
+ * allowing you to manipulate its directories and files.
+ */
+class DataLakeFileSystemClient extends StorageClient_js_1.StorageClient {
+    constructor(url, credentialOrPipeline, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options) {
+        if ((0, Pipeline_js_1.isPipelineLike)(credentialOrPipeline)) {
+            super(url, credentialOrPipeline);
+        }
+        else {
+            let credential;
+            if (credentialOrPipeline === undefined) {
+                credential = new storage_blob_2.AnonymousCredential();
+            }
+            else {
+                credential = credentialOrPipeline;
+            }
+            const pipeline = (0, Pipeline_js_1.newPipeline)(credential, options);
+            super(url, pipeline);
+        }
+        this.fileSystemContext = new index_js_1.FileSystemOperationsImpl(this.storageClientContext);
+        this.fileSystemContextToBlobEndpoint = new index_js_1.FileSystemOperationsImpl(this.storageClientContextToBlobEndpoint);
+        this.blobContainerClient = new storage_blob_1.ContainerClient(this.blobEndpointUrl, this.pipeline);
+    }
+    /**
+     * Name of current file system.
+     *
+     * @readonly
+     */
+    get name() {
+        return this.blobContainerClient.containerName;
+    }
+    /**
+     * Creates a {@link DataLakeDirectoryClient} object under current file system.
+     *
+     * @param directoryName -
+     */
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-subclients */
+    getDirectoryClient(directoryName) {
+        return new clients_js_1.DataLakeDirectoryClient((0, utils_common_js_1.appendToURLPath)(this.url, (0, utils_common_js_1.EscapePath)(directoryName)), this.pipeline);
+    }
+    /**
+     * Creates a {@link DataLakeFileClient} object under current file system.
+     *
+     * @param fileName -
+     */
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-subclients */
+    getFileClient(fileName) {
+        return new clients_js_1.DataLakeFileClient((0, utils_common_js_1.appendToURLPath)(this.url, (0, utils_common_js_1.EscapePath)(fileName)), this.pipeline);
+    }
+    /**
+     * Get a {@link DataLakeLeaseClient} that manages leases on the file system.
+     *
+     * @param proposeLeaseId - Optional. Initial proposed lease Id.
+     */
+    getDataLakeLeaseClient(proposeLeaseId) {
+        return new DataLakeLeaseClient_js_1.DataLakeLeaseClient(this.blobContainerClient.getBlobLeaseClient(proposeLeaseId));
+    }
+    /**
+     * Creates a new file system under the specified account. If the file system with
+     * the same name already exists, the operation fails.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
+     *
+     * @param options - Optional. Options when creating file system.
+     */
+    async create(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-create", options, async (updatedOptions) => {
+            return this.blobContainerClient.create(Object.assign(Object.assign({}, options), { access: (0, transforms_js_1.toContainerPublicAccessType)(options.access), tracingOptions: updatedOptions.tracingOptions, containerEncryptionScope: options.fileSystemEncryptionScope }));
+        });
+    }
+    /**
+     * Creates a new file system under the specified account. If the file system with
+     * the same name already exists, it is not changed.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
+     *
+     * @param options -
+     */
+    async createIfNotExists(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-createIfNotExists", options, async (updatedOptions) => {
+            return this.blobContainerClient.createIfNotExists(Object.assign(Object.assign({}, options), { access: (0, transforms_js_1.toContainerPublicAccessType)(options.access), containerEncryptionScope: options.fileSystemEncryptionScope, tracingOptions: updatedOptions.tracingOptions }));
+        });
+    }
+    /**
+     * Returns true if the File system represented by this client exists; false otherwise.
+     *
+     * NOTE: use this function with care since an existing file system might be deleted by other clients or
+     * applications. Vice versa new file system with the same name might be added by other clients or
+     * applications after this function completes.
+     *
+     * @param options -
+     */
+    async exists(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-exists", options, async (updatedOptions) => {
+            return this.blobContainerClient.exists(updatedOptions);
+        });
+    }
+    /**
+     * Delete current file system.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
+     *
+     * @param options - Optional. Options when deleting file system.
+     */
+    async delete(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-delete", options, async (updatedOptions) => {
+            return this.blobContainerClient.delete(Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+        });
+    }
+    /**
+     * Delete current file system if it exists.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
+     *
+     * @param options -
+     */
+    async deleteIfExists(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-deleteIfExists", options, async (updatedOptions) => {
+            return this.blobContainerClient.deleteIfExists(updatedOptions);
+        });
+    }
+    /**
+     * Returns all user-defined metadata and system properties for the specified
+     * file system.
+     *
+     * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
+     * they originally contained uppercase characters. This differs from the metadata keys returned by
+     * the `listFileSystems` method of {@link DataLakeServiceClient} using the `includeMetadata` option, which
+     * will retain their original casing.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties
+     *
+     * @param options - Optional. Options when getting file system properties.
+     */
+    async getProperties(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-getProperties", options, async (updatedOptions) => {
+            const rawResponse = await this.blobContainerClient.getProperties(Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+            // Transfer and rename blobPublicAccess to publicAccess
+            const response = rawResponse;
+            response.publicAccess = (0, transforms_js_1.toPublicAccessType)(rawResponse.blobPublicAccess);
+            response._response.parsedHeaders.publicAccess = response.publicAccess;
+            delete rawResponse.blobPublicAccess;
+            delete rawResponse._response.parsedHeaders.blobPublicAccess;
+            return response;
+        });
+    }
+    /**
+     * Sets one or more user-defined name-value pairs for the specified file system.
+     *
+     * If no option provided, or no metadata defined in the parameter, the file system
+     * metadata will be removed.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
+     *
+     * @param metadata - Replace existing metadata with this value.
+     *                              If no value provided the existing metadata will be removed.
+     * @param options - Optional. Options when setting file system metadata.
+     */
+    async setMetadata(metadata, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-setMetadata", options, async (updatedOptions) => {
+            return this.blobContainerClient.setMetadata(metadata, Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+        });
+    }
+    /**
+     * Gets the permissions for the specified file system. The permissions indicate
+     * whether file system data may be accessed publicly.
+     *
+     * WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
+     * For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-acl
+     *
+     * @param options - Optional. Options when getting file system access policy.
+     */
+    async getAccessPolicy(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-getAccessPolicy", options, async (updatedOptions) => {
+            const rawResponse = await this.blobContainerClient.getAccessPolicy(Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+            // Transfer and rename blobPublicAccess to publicAccess
+            const response = rawResponse;
+            response.publicAccess = (0, transforms_js_1.toPublicAccessType)(rawResponse.blobPublicAccess);
+            response._response.parsedHeaders.publicAccess = response.publicAccess;
+            delete rawResponse.blobPublicAccess;
+            delete rawResponse._response.parsedHeaders.blobPublicAccess;
+            return response;
+        });
+    }
+    /**
+     * Sets the permissions for the specified file system. The permissions indicate
+     * whether directories or files in a file system may be accessed publicly.
+     *
+     * When you set permissions for a file system, the existing permissions are replaced.
+     * If no access or containerAcl provided, the existing file system ACL will be
+     * removed.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
+     *
+     * @param access - Optional. The level of public access to data in the file system.
+     * @param fileSystemAcl - Optional. Array of elements each having a unique Id and details of the access policy.
+     * @param options - Optional. Options when setting file system access policy.
+     */
+    async setAccessPolicy(access, fileSystemAcl, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-setAccessPolicy", options, async (updatedOptions) => {
+            return this.blobContainerClient.setAccessPolicy((0, transforms_js_1.toContainerPublicAccessType)(access), fileSystemAcl, Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+        });
+    }
+    /**
+     * Returns an async iterable iterator to list all the paths (directories and files)
+     * under the specified file system.
+     *
+     * .byPage() returns an async iterable iterator to list the paths in pages.
+     *
+     * Example using `for await` syntax:
+     *
+     * ```ts snippet:ReadmeSampleListPaths
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * const paths = fileSystemClient.listPaths();
+     * for await (const path of paths) {
+     *   console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
+     * }
+     * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```ts snippet:ReadmeSampleListPaths_Iterator
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * const paths = fileSystemClient.listPaths();
+     * let { value, done } = await paths.next();
+     * while (!done) {
+     *   console.log(`Path ${i++}: ${value.name}, is directory: ${value.isDirectory}`);
+     *   ({ value, done } = await paths.next());
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```ts snippet:ReadmeSampleListPaths_ByPage
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
+     *   if (response.pathItems) {
+     *     for (const path of response.pathItems) {
+     *       console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * Example using paging with a marker:
+     *
+     * ```ts snippet:ReadmeSampleListPaths_Continuation
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * let paths = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
+     * let response = (await paths.next()).value;
+     * // Prints 2 paths
+     * if (response.pathItems) {
+     *   for (const path of response.pathItems) {
+     *     console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
+     *   }
+     * }
+     * // Gets next marker
+     * let marker = response.continuationToken;
+     * // Passing next marker as continuationToken
+     * paths = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
+     * response = (await paths.next()).value;
+     * // Prints 10 paths
+     * if (response.pathItems) {
+     *   for (const path of response.pathItems) {
+     *     console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
+     *   }
+     * }
+     * ```
+     *
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
+     *
+     * @param options - Optional. Options when listing paths.
+     */
+    listPaths(options = {}) {
+        options.path = options.path === "" ? undefined : options.path;
+        const iter = this.listItems(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings = {}) => {
+                return this.listSegments(settings.continuationToken, Object.assign({ maxResults: settings.maxPageSize }, options));
+            },
+        };
+    }
+    listItems() {
+        return tslib_1.__asyncGenerator(this, arguments, function* listItems_1(options = {}) {
+            var _a, e_1, _b, _c;
+            try {
+                for (var _d = true, _e = tslib_1.__asyncValues(this.listSegments(undefined, options)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+                    _c = _f.value;
+                    _d = false;
+                    const response = _c;
+                    yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(response.pathItems || [])));
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = _e.return)) yield tslib_1.__await(_b.call(_e));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    listSegments(continuation_1) {
+        return tslib_1.__asyncGenerator(this, arguments, function* listSegments_1(continuation, options = {}) {
+            let response;
+            if (!!continuation || continuation === undefined) {
+                do {
+                    response = yield tslib_1.__await(this.listPathsSegment(continuation, options));
+                    continuation = response.continuation;
+                    yield yield tslib_1.__await(response);
+                } while (continuation);
+            }
+        });
+    }
+    async listPathsSegment(continuation, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-listPathsSegment", options, async (updatedOptions) => {
+            const rawResponse = await this.fileSystemContext.listPaths(options.recursive || false, Object.assign(Object.assign({ continuation }, updatedOptions), { upn: options.userPrincipalName }));
+            const response = rawResponse;
+            response.pathItems = [];
+            for (const path of rawResponse.paths || []) {
+                response.pathItems.push(Object.assign(Object.assign({}, path), { permissions: (0, transforms_js_1.toPermissions)(path.permissions), createdOn: (0, utils_common_js_1.windowsFileTimeTicksToTime)(path.creationTime), expiresOn: (0, utils_common_js_1.windowsFileTimeTicksToTime)(path.expiryTime) }));
+            }
+            delete rawResponse.paths;
+            return response;
+        });
+    }
+    /**
+     * Returns an async iterable iterator to list all the paths (directories and files)
+     * under the specified file system.
+     *
+     * .byPage() returns an async iterable iterator to list the paths in pages.
+     *
+     * Example using `for await` syntax:
+     *
+     * ```ts snippet:ReadmeSampleListDeletedPaths
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * const deletedPaths = fileSystemClient.listDeletedPaths();
+     * for await (const deletedPath of deletedPaths) {
+     *   console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
+     * }
+     * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```ts snippet:ReadmeSampleListDeletedPaths_Iterator
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * const deletedPaths = fileSystemClient.listDeletedPaths();
+     * let { value, done } = await deletedPaths.next();
+     * while (!done) {
+     *   console.log(`Deleted path ${i++}: ${value.name}, deleted on: ${value.deletedOn}`);
+     *   ({ value, done } = await deletedPaths.next());
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```ts snippet:ReadmeSampleListDeletedPaths_ByPage
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
+     *   if (response.pathItems) {
+     *     for (const deletedPath of response.pathItems) {
+     *       console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * Example using paging with a marker:
+     *
+     * ```ts snippet:ReadmeSampleListDeletedPaths_Continuation
+     * import { DataLakeServiceClient } from "@azure/storage-file-datalake";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const datalakeServiceClient = new DataLakeServiceClient(
+     *   `https://${account}.dfs.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const fileSystemName = "<file system name>";
+     * const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
+     *
+     * let i = 1;
+     * let deletedPaths = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
+     * let response = (await deletedPaths.next()).value;
+     * // Prints 2 deleted paths
+     * if (response.deletedPathItems) {
+     *   for (const deletedPath of response.deletedPathItems) {
+     *     console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
+     *   }
+     * }
+     * // Gets next marker
+     * let marker = response.continuationToken;
+     * // Passing next marker as continuationToken
+     * deletedPaths = fileSystemClient
+     *   .listDeletedPaths()
+     *   .byPage({ continuationToken: marker, maxPageSize: 10 });
+     * response = (await deletedPaths.next()).value;
+     * // Prints 10 deleted paths
+     * if (response.deletedPathItems) {
+     *   for (const deletedPath of response.deletedPathItems) {
+     *     console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
+     *   }
+     * }
+     * ```
+     *
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
+     *
+     * @param options - Optional. Options when listing deleted paths.
+     */
+    listDeletedPaths(options = {}) {
+        const iter = this.listDeletedItems(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings = {}) => {
+                return this.listDeletedSegments(settings.continuationToken, Object.assign({ maxResults: settings.maxPageSize }, options));
+            },
+        };
+    }
+    listDeletedItems() {
+        return tslib_1.__asyncGenerator(this, arguments, function* listDeletedItems_1(options = {}) {
+            var _a, e_2, _b, _c;
+            try {
+                for (var _d = true, _e = tslib_1.__asyncValues(this.listDeletedSegments(undefined, options)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+                    _c = _f.value;
+                    _d = false;
+                    const response = _c;
+                    yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(response.pathItems || [])));
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = _e.return)) yield tslib_1.__await(_b.call(_e));
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        });
+    }
+    listDeletedSegments(continuation_1) {
+        return tslib_1.__asyncGenerator(this, arguments, function* listDeletedSegments_1(continuation, options = {}) {
+            let response;
+            if (!!continuation || continuation === undefined) {
+                do {
+                    response = yield tslib_1.__await(this.listDeletedPathsSegment(continuation, options));
+                    continuation = response.continuation;
+                    yield yield tslib_1.__await(response);
+                } while (continuation);
+            }
+        });
+    }
+    async listDeletedPathsSegment(continuation, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-listDeletedPathsSegment", options, async (updatedOptions) => {
+            const rawResponse = await this.fileSystemContextToBlobEndpoint.listBlobHierarchySegment(Object.assign(Object.assign({ marker: continuation }, updatedOptions), { prefix: options.prefix === "" ? undefined : options.prefix }));
+            const response = rawResponse;
+            response.pathItems = [];
+            for (const path of rawResponse.segment.blobItems || []) {
+                response.pathItems.push({
+                    name: path.name,
+                    deletionId: path.deletionId,
+                    deletedOn: path.properties.deletedTime,
+                    remainingRetentionDays: path.properties.remainingRetentionDays,
+                });
+            }
+            if (response.nextMarker) {
+                response.continuation = response.nextMarker;
+            }
+            return response;
+        });
+    }
+    /**
+     * Restores a soft deleted path.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob
+     *
+     * @param deletedPath - Required.  The path of the deleted path.
+     *
+     * @param deletionId - Required.  The deletion ID associated with the soft deleted path.
+     *
+     */
+    async undeletePath(deletedPath, deletionId, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("DataLakeFileSystemClient-undeletePath", options, async (updatedOptions) => {
+            const pathClient = new PathClientInternal_js_1.PathClientInternal((0, utils_common_js_1.appendToURLPath)(this.blobEndpointUrl, (0, utils_common_js_1.EscapePath)(deletedPath)), this.pipeline);
+            const rawResponse = (0, utils_common_js_1.assertResponse)(await pathClient.blobPathContext.undelete(Object.assign(Object.assign({ undeleteSource: "?" + constants_js_1.DeletionIdKey + "=" + deletionId }, options), { tracingOptions: updatedOptions.tracingOptions })));
+            if (rawResponse.resourceType === constants_js_1.PathResultTypeConstants.DirectoryResourceType) {
+                return Object.assign({ pathClient: this.getDirectoryClient(deletedPath) }, rawResponse);
+            }
+            else {
+                return Object.assign({ pathClient: this.getFileClient(deletedPath) }, rawResponse);
+            }
+        });
+    }
+    /**
+     * Only available for DataLakeFileSystemClient constructed with a shared key credential.
+     *
+     * Generates a Service Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     *
+     * @param options - Optional parameters.
+     * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateSasUrl(options) {
+        return new Promise((resolve) => {
+            if (!(this.credential instanceof StorageSharedKeyCredential_js_1.StorageSharedKeyCredential)) {
+                throw RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
+            }
+            const sas = (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParameters)(Object.assign({ fileSystemName: this.name }, options), this.credential).toString();
+            resolve((0, utils_common_js_1.appendToURLQuery)(this.url, sas));
+        });
+    }
+    /**
+     * Only available for DataLakeFileSystemClient constructed with a shared key credential.
+     *
+     * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     *
+     * @param options - Optional parameters.
+     * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+    generateSasStringToSign(options) {
+        if (!(this.credential instanceof StorageSharedKeyCredential_js_1.StorageSharedKeyCredential)) {
+            throw RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
+        }
+        return (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParametersInternal)(Object.assign({ fileSystemName: this.name }, options), this.credential).stringToSign;
+    }
+    /**
+     * Generates a Service Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the input user delegation key.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     *
+     * @param options - Optional parameters.
+     * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
+     * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateUserDelegationSasUrl(options, userDelegationKey) {
+        return new Promise((resolve) => {
+            const sas = (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParameters)(Object.assign({ fileSystemName: this.name }, options), userDelegationKey, this.accountName).toString();
+            resolve((0, utils_common_js_1.appendToURLQuery)(this.url, sas));
+        });
+    }
+    /**
+     * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the input user delegation key.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     *
+     * @param options - Optional parameters.
+     * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
+     * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateUserDelegationSasStringToSign(options, userDelegationKey) {
+        return (0, DataLakeSASSignatureValues_js_1.generateDataLakeSASQueryParametersInternal)(Object.assign({ fileSystemName: this.name }, options), userDelegationKey, this.accountName).stringToSign;
+    }
+}
+exports.DataLakeFileSystemClient = DataLakeFileSystemClient;
+//# sourceMappingURL=DataLakeFileSystemClient.js.map