azure-arm-datalake-store/lib/filesystem/operations/index.d.ts

Microsoft Azure Data Lake Store Management Client Library for node

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 * Changes may cause incorrect behavior and will be lost if the code is
 * regenerated.
*/

import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest';
import * as stream from 'stream';
import * as models from '../models';


/**
 * @class
 * FileSystem
 * __NOTE__: An instance of this class is automatically created for an
 * instance of the DataLakeStoreFileSystemManagementClient.
 */
export interface FileSystem {


    /**
     * Sets or removes the expiration time on the specified file. This operation
     * can only be executed against files. Folders are not supported.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file on which to set or remove the expiration time.
     *
     * @param {string} expiryOption 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. Possible values include:
     * 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute'
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.expireTime] The time that the file will expire,
     * corresponding to the ExpiryOption that was set.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    setFileExpiryWithHttpOperationResponse(accountName: string, path: string, expiryOption: string, options?: { expireTime? : number, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;

    /**
     * Sets or removes the expiration time on the specified file. This operation
     * can only be executed against files. Folders are not supported.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file on which to set or remove the expiration time.
     *
     * @param {string} expiryOption 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. Possible values include:
     * 'NeverExpire', 'RelativeToNow', 'RelativeToCreationDate', 'Absolute'
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.expireTime] The time that the file will expire,
     * corresponding to the ExpiryOption that was set.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {null} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {null} [result]   - The deserialized result object if an error did not occur.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    setFileExpiry(accountName: string, path: string, expiryOption: string, options?: { expireTime? : number, customHeaders? : { [headerName: string]: string; } }): Promise<void>;
    setFileExpiry(accountName: string, path: string, expiryOption: string, callback: ServiceCallback<void>): void;
    setFileExpiry(accountName: string, path: string, expiryOption: string, options: { expireTime? : number, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;


    /**
     * 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.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file to which to append using concurrent append.
     *
     * @param {object} streamContents 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.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {string} [options.appendMode] Indicates the concurrent append call
     * should create the file if it doesn't exist or just open the existing file
     * for append. Possible values include: 'autocreate'
     *
     * @param {string} [options.syncFlag] Optionally indicates what to do after
     * completion of the concurrent append. DATA indicates that more data will be
     * sent immediately by the client, the file handle should remain open/locked,
     * and file metadata (including file length, last modified time) should NOT get
     * updated. METADATA indicates that more data will be sent immediately by the
     * client, the file handle should remain open/locked, and file metadata should
     * get updated. CLOSE indicates that the client is done sending data, the file
     * handle should be closed/unlocked, and file metadata should get updated.
     * Possible values include: 'DATA', 'METADATA', 'CLOSE'
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    concurrentAppendWithHttpOperationResponse(accountName: string, path: string, streamContents: stream.Readable, options?: { appendMode? : string, syncFlag? : string, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;

    /**
     * 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.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file to which to append using concurrent append.
     *
     * @param {object} streamContents 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.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {string} [options.appendMode] Indicates the concurrent append call
     * should create the file if it doesn't exist or just open the existing file
     * for append. Possible values include: 'autocreate'
     *
     * @param {string} [options.syncFlag] Optionally indicates what to do after
     * completion of the concurrent append. DATA indicates that more data will be
     * sent immediately by the client, the file handle should remain open/locked,
     * and file metadata (including file length, last modified time) should NOT get
     * updated. METADATA indicates that more data will be sent immediately by the
     * client, the file handle should remain open/locked, and file metadata should
     * get updated. CLOSE indicates that the client is done sending data, the file
     * handle should be closed/unlocked, and file metadata should get updated.
     * Possible values include: 'DATA', 'METADATA', 'CLOSE'
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {null} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {null} [result]   - The deserialized result object if an error did not occur.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    concurrentAppend(accountName: string, path: string, streamContents: stream.Readable, options?: { appendMode? : string, syncFlag? : string, customHeaders? : { [headerName: string]: string; } }): Promise<void>;
    concurrentAppend(accountName: string, path: string, streamContents: stream.Readable, callback: ServiceCallback<void>): void;
    concurrentAppend(accountName: string, path: string, streamContents: stream.Readable, options: { appendMode? : string, syncFlag? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;


    /**
     * Checks if the specified access is available at the given path.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file or directory for which to check access.
     *
     * @param {string} fsaction File system operation read/write/execute in string
     * form, matching regex pattern '[rwx-]{3}'
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    checkAccessWithHttpOperationResponse(accountName: string, path: string, fsaction: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;

    /**
     * Checks if the specified access is available at the given path.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file or directory for which to check access.
     *
     * @param {string} fsaction File system operation read/write/execute in string
     * form, matching regex pattern '[rwx-]{3}'
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {null} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {null} [result]   - The deserialized result object if an error did not occur.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    checkAccess(accountName: string, path: string, fsaction: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>;
    checkAccess(accountName: string, path: string, fsaction: string, callback: ServiceCallback<void>): void;
    checkAccess(accountName: string, path: string, fsaction: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;


    /**
     * Creates a directory.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * directory to create.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.permission] Optional octal permission with which
     * the directory should be created.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<FileOperationResult>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    mkdirsWithHttpOperationResponse(accountName: string, path: string, options?: { permission? : number, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.FileOperationResult>>;

    /**
     * Creates a directory.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * directory to create.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.permission] Optional octal permission with which
     * the directory should be created.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {FileOperationResult} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {FileOperationResult} [result]   - The deserialized result object if an error did not occur.
     *                      See {@link FileOperationResult} for more information.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    mkdirs(accountName: string, path: string, options?: { permission? : number, customHeaders? : { [headerName: string]: string; } }): Promise<models.FileOperationResult>;
    mkdirs(accountName: string, path: string, callback: ServiceCallback<models.FileOperationResult>): void;
    mkdirs(accountName: string, path: string, options: { permission? : number, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.FileOperationResult>): void;


    /**
     * Concatenates the list of source files into the destination file, removing
     * all source files upon success.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * destination file resulting from the concatenation.
     *
     * @param {array} sources A list of comma separated Data Lake Store paths
     * (starting with '/') of the files to concatenate, in the order in which they
     * should be concatenated.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    concatWithHttpOperationResponse(accountName: string, path: string, sources: string[], options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;

    /**
     * Concatenates the list of source files into the destination file, removing
     * all source files upon success.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * destination file resulting from the concatenation.
     *
     * @param {array} sources A list of comma separated Data Lake Store paths
     * (starting with '/') of the files to concatenate, in the order in which they
     * should be concatenated.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {null} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {null} [result]   - The deserialized result object if an error did not occur.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    concat(accountName: string, path: string, sources: string[], options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>;
    concat(accountName: string, path: string, sources: string[], callback: ServiceCallback<void>): void;
    concat(accountName: string, path: string, sources: string[], options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;


    /**
     * 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.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * destination file resulting from the concatenation.
     *
     * @param {object} streamContents A list of Data Lake Store paths (starting
     * with '/') of the source files. Must be a comma-separated path list in the
     * format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {boolean} [options.deleteSourceDirectory] Indicates that as an
     * optimization instead of deleting each individual source stream, delete the
     * source stream folder if all streams are in the same folder instead. This
     * results in a substantial performance improvement when the only streams in
     * the folder are part of the concatenation operation. WARNING: This includes
     * the deletion of any other files that are not source files. Only set this to
     * true when source files are the only files in the source directory.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    msConcatWithHttpOperationResponse(accountName: string, path: string, streamContents: stream.Readable, options?: { deleteSourceDirectory? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;

    /**
     * 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.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * destination file resulting from the concatenation.
     *
     * @param {object} streamContents A list of Data Lake Store paths (starting
     * with '/') of the source files. Must be a comma-separated path list in the
     * format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {boolean} [options.deleteSourceDirectory] Indicates that as an
     * optimization instead of deleting each individual source stream, delete the
     * source stream folder if all streams are in the same folder instead. This
     * results in a substantial performance improvement when the only streams in
     * the folder are part of the concatenation operation. WARNING: This includes
     * the deletion of any other files that are not source files. Only set this to
     * true when source files are the only files in the source directory.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {null} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {null} [result]   - The deserialized result object if an error did not occur.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    msConcat(accountName: string, path: string, streamContents: stream.Readable, options?: { deleteSourceDirectory? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<void>;
    msConcat(accountName: string, path: string, streamContents: stream.Readable, callback: ServiceCallback<void>): void;
    msConcat(accountName: string, path: string, streamContents: stream.Readable, options: { deleteSourceDirectory? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;


    /**
     * Get the list of file status objects specified by the file path, with
     * optional pagination parameters
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * directory to list.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.listSize] Gets or sets the number of items to
     * return. Optional.
     *
     * @param {string} [options.listAfter] Gets or sets the item or lexographical
     * index after which to begin returning results. For example, a file list of
     * 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also
     * return 'd'. Optional.
     *
     * @param {string} [options.listBefore] Gets or sets the item or lexographical
     * index before which to begin returning results. For example, a file list of
     * 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c'
     * will also return 'a','b'. Optional.
     *
     * @param {boolean} [options.tooId] An optional switch to return friendly names
     * in place of owner and group. tooid=false returns friendly names instead of
     * the AAD Object ID. Default value is true, returning AAD object IDs.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<FileStatusesResult>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    listFileStatusWithHttpOperationResponse(accountName: string, path: string, options?: { listSize? : number, listAfter? : string, listBefore? : string, tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.FileStatusesResult>>;

    /**
     * Get the list of file status objects specified by the file path, with
     * optional pagination parameters
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * directory to list.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.listSize] Gets or sets the number of items to
     * return. Optional.
     *
     * @param {string} [options.listAfter] Gets or sets the item or lexographical
     * index after which to begin returning results. For example, a file list of
     * 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also
     * return 'd'. Optional.
     *
     * @param {string} [options.listBefore] Gets or sets the item or lexographical
     * index before which to begin returning results. For example, a file list of
     * 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c'
     * will also return 'a','b'. Optional.
     *
     * @param {boolean} [options.tooId] An optional switch to return friendly names
     * in place of owner and group. tooid=false returns friendly names instead of
     * the AAD Object ID. Default value is true, returning AAD object IDs.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {FileStatusesResult} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {FileStatusesResult} [result]   - The deserialized result object if an error did not occur.
     *                      See {@link FileStatusesResult} for more information.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    listFileStatus(accountName: string, path: string, options?: { listSize? : number, listAfter? : string, listBefore? : string, tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<models.FileStatusesResult>;
    listFileStatus(accountName: string, path: string, callback: ServiceCallback<models.FileStatusesResult>): void;
    listFileStatus(accountName: string, path: string, options: { listSize? : number, listAfter? : string, listBefore? : string, tooId? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.FileStatusesResult>): void;


    /**
     * Gets the file content summary object specified by the file path.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file for which to retrieve the summary.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<ContentSummaryResult>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    getContentSummaryWithHttpOperationResponse(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.ContentSummaryResult>>;

    /**
     * Gets the file content summary object specified by the file path.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file for which to retrieve the summary.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {ContentSummaryResult} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {ContentSummaryResult} [result]   - The deserialized result object if an error did not occur.
     *                      See {@link ContentSummaryResult} for more information.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    getContentSummary(accountName: string, path: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.ContentSummaryResult>;
    getContentSummary(accountName: string, path: string, callback: ServiceCallback<models.ContentSummaryResult>): void;
    getContentSummary(accountName: string, path: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.ContentSummaryResult>): void;


    /**
     * Get the file status object specified by the file path.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file or directory for which to retrieve the status.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {boolean} [options.tooId] An optional switch to return friendly names
     * in place of owner and group. tooid=false returns friendly names instead of
     * the AAD Object ID. Default value is true, returning AAD object IDs.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<FileStatusResult>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    getFileStatusWithHttpOperationResponse(accountName: string, path: string, options?: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.FileStatusResult>>;

    /**
     * Get the file status object specified by the file path.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file or directory for which to retrieve the status.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {boolean} [options.tooId] An optional switch to return friendly names
     * in place of owner and group. tooid=false returns friendly names instead of
     * the AAD Object ID. Default value is true, returning AAD object IDs.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {FileStatusResult} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {FileStatusResult} [result]   - The deserialized result object if an error did not occur.
     *                      See {@link FileStatusResult} for more information.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    getFileStatus(accountName: string, path: string, options?: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<models.FileStatusResult>;
    getFileStatus(accountName: string, path: string, callback: ServiceCallback<models.FileStatusResult>): void;
    getFileStatus(accountName: string, path: string, options: { tooId? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.FileStatusResult>): void;


    /**
     * Opens and reads from the specified file.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file to open.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.length] The number of bytes that the server will
     * attempt to retrieve. It will retrieve <= length bytes.
     *
     * @param {number} [options.offset] The byte offset to start reading data from.
     *
     * @param {uuid} [options.fileSessionId] Optional unique GUID per file
     * indicating all the reads with the same fileSessionId are from the same
     * client and same session. This will give a performance benefit.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<Object>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    openWithHttpOperationResponse(accountName: string, path: string, options?: { length? : number, offset? : number, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<stream.Readable>>;

    /**
     * Opens and reads from the specified file.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file to open.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.length] The number of bytes that the server will
     * attempt to retrieve. It will retrieve <= length bytes.
     *
     * @param {number} [options.offset] The byte offset to start reading data from.
     *
     * @param {uuid} [options.fileSessionId] Optional unique GUID per file
     * indicating all the reads with the same fileSessionId are from the same
     * client and same session. This will give a performance benefit.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {Object} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {Object} [result]   - The deserialized result object if an error did not occur.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    open(accountName: string, path: string, options?: { length? : number, offset? : number, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise<stream.Readable>;
    open(accountName: string, path: string, callback: ServiceCallback<stream.Readable>): void;
    open(accountName: string, path: string, options: { length? : number, offset? : number, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<stream.Readable>): void;


    /**
     * 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.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file to which to append.
     *
     * @param {object} streamContents 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.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.offset] The optional offset in the stream to begin
     * the append operation. Default is to append at the end of the stream.
     *
     * @param {string} [options.syncFlag] Optionally indicates what to do after
     * completion of the concurrent append. DATA indicates that more data will be
     * sent immediately by the client, the file handle should remain open/locked,
     * and file metadata (including file length, last modified time) should NOT get
     * updated. METADATA indicates that more data will be sent immediately by the
     * client, the file handle should remain open/locked, and file metadata should
     * get updated. CLOSE indicates that the client is done sending data, the file
     * handle should be closed/unlocked, and file metadata should get updated.
     * Possible values include: 'DATA', 'METADATA', 'CLOSE'
     *
     * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure
     * single writer semantics, meaning that only clients that append to the file
     * with the same leaseId will be allowed to do so.
     *
     * @param {uuid} [options.fileSessionId] Optional unique GUID per file
     * indicating all the appends with the same fileSessionId are from the same
     * client and same session. This will give a performance benefit when syncFlag
     * is DATA or METADATA.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @returns {Promise} A promise is returned
     *
     * @resolve {HttpOperationResponse<null>} - The deserialized result object.
     *
     * @reject {Error|ServiceError} - The error object.
     */
    appendWithHttpOperationResponse(accountName: string, path: string, streamContents: stream.Readable, options?: { offset? : number, syncFlag? : string, leaseId? : string, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;

    /**
     * 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.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file to which to append.
     *
     * @param {object} streamContents 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.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {number} [options.offset] The optional offset in the stream to begin
     * the append operation. Default is to append at the end of the stream.
     *
     * @param {string} [options.syncFlag] Optionally indicates what to do after
     * completion of the concurrent append. DATA indicates that more data will be
     * sent immediately by the client, the file handle should remain open/locked,
     * and file metadata (including file length, last modified time) should NOT get
     * updated. METADATA indicates that more data will be sent immediately by the
     * client, the file handle should remain open/locked, and file metadata should
     * get updated. CLOSE indicates that the client is done sending data, the file
     * handle should be closed/unlocked, and file metadata should get updated.
     * Possible values include: 'DATA', 'METADATA', 'CLOSE'
     *
     * @param {uuid} [options.leaseId] Optional unique GUID per file to ensure
     * single writer semantics, meaning that only clients that append to the file
     * with the same leaseId will be allowed to do so.
     *
     * @param {uuid} [options.fileSessionId] Optional unique GUID per file
     * indicating all the appends with the same fileSessionId are from the same
     * client and same session. This will give a performance benefit when syncFlag
     * is DATA or METADATA.
     *
     * @param {object} [options.customHeaders] Headers that will be added to the
     * request
     *
     * @param {ServiceCallback} [optionalCallback] - The optional callback.
     *
     * @returns {ServiceCallback|Promise} If a callback was passed as the last
     * parameter then it returns the callback else returns a Promise.
     *
     * {Promise} A promise is returned.
     *
     *                      @resolve {null} - The deserialized result object.
     *
     *                      @reject {Error|ServiceError} - The error object.
     *
     * {ServiceCallback} optionalCallback(err, result, request, response)
     *
     *                      {Error|ServiceError}  err        - The Error object if an error occurred, null otherwise.
     *
     *                      {null} [result]   - The deserialized result object if an error did not occur.
     *
     *                      {WebResource} [request]  - The HTTP Request object if an error did not occur.
     *
     *                      {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
     */
    append(accountName: string, path: string, streamContents: stream.Readable, options?: { offset? : number, syncFlag? : string, leaseId? : string, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }): Promise<void>;
    append(accountName: string, path: string, streamContents: stream.Readable, callback: ServiceCallback<void>): void;
    append(accountName: string, path: string, streamContents: stream.Readable, options: { offset? : number, syncFlag? : string, leaseId? : string, fileSessionId? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;


    /**
     * Creates a file with optionally specified content. NOTE: If content is
     * provided, the resulting file cannot be modified using ConcurrentAppend.
     *
     * @param {string} accountName The Azure Data Lake Store account to execute
     * filesystem operations on.
     *
     * @param {string} path The Data Lake Store path (starting with '/') of the
     * file to create.
     *
     * @param {object} [options] Optional Parameters.
     *
     * @param {object} [options.streamContents] The file contents to include when
     * creating the file. This parameter is optional, resulting in an empty file if
     * not specified.  The maximum content size is 4MB.  For content larger than
     * 4MB you must append the content in 4MB chunks.
     *
     * @param {boolean} [options.overwrite] The indication of if the file should be