@zowe/zos-files-for-zowe-sdk/lib/methods/upload/doc/IUploadOptions.d.ts

Zowe SDK to interact with files and data sets on z/OS

import { IUploadMap } from "./IUploadMap";
import { ZosFilesAttributes } from "../../../utils/ZosFilesAttributes";
import { IOptions } from "../../../doc/IOptions";
/**
 * This interface defines the options that can be sent into the upload data set function
 */
export interface IUploadOptions extends IOptions {
    /**
     * The migrated recall option
     * @example "wait, nowait, error"
     */
    recall?: string;
    /**
     * The indicator to upload the directories recursively
     */
    recursive?: boolean;
    /**
     * The list of files to be uploaded in binary mode
     */
    binary_files?: string;
    /**
     * The list of files to be uploaded in ASCII mode
     */
    ascii_files?: string;
    /**
     * The map of files and their upload mode to be used for binary_files and ascii_files
     */
    filesMap?: IUploadMap;
    /**
     * The ZosFilesAttributes instance describe upload attributes for the files and directories
     */
    attributes?: ZosFilesAttributes;
    /**
     * The maximum REST requests to perform at once
     * Increasing this value results in faster uploads but increases resource consumption
     * on z/OS and risks encountering an error caused
     * by making too many requests at once.
     * Default: 1
     */
    maxConcurrentRequests?: number;
    /**
     * Etag value to pass to z/OSMF API request.
     * It is used to check if the file was modified on target system before it is updated.
     */
    etag?: string;
    /**
     * The indicator to force return of ETag.
     * If set to 'true' it forces the response to include an "ETag" header, regardless of the size of the response data.
     * If it is not present, the the default is to only send an Etag for data sets smaller than a system determined length,
     * which is at least 8MB.
     */
    returnEtag?: boolean;
    /**
     * Specifies whether hidden files whose names begin with a dot should be uploaded.
     */
    includeHidden?: boolean;
    /**
    * Specifies whether to create parent directories if they do not exist before uploading.
    * When set to true, any missing directories in the target path will be automatically created.
    */
    makeDir?: boolean;
    /**
    * Specifies whether to skip checking if the target path is a directory before uploading.
    * When set to true, the upload will proceed assuming the target is a file path,
    * reducing additional network calls and improving performance for bulk operations.
    */
    skipDirectoryCheck?: boolean;
}
//# sourceMappingURL=IUploadOptions.d.ts.map