@zowe/zos-files-for-zowe-sdk/lib/methods/copy/doc/ICopyDatasetOptions.d.ts

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

import { IHandlerProgressApi, ITaskWithStatus } from "@zowe/imperative";
import { IDataSet } from "../../../doc/IDataSet";
import { IZosFilesOptions } from "../../../doc/IZosFilesOptions";
/**
 * This interface defines the options that can be sent into the copy data set function.
 */
export interface ICopyDatasetOptions extends IZosFilesOptions {
    /**
     * The dataset to copy from.
     * @type {IDataSet}
     */
    "from-dataset": IDataSet;
    /**
     * Enq option
     * Allow values are: SHR, SHRW, EXCLU.
     * @type {string}
     */
    enq?: string;
    /**
     * Replace option
     * @type {boolean}
     */
    replace?: boolean;
    /**
     * Overwrite option
     * @type {boolean}
     */
    overwrite?: boolean;
    /**
     * Safe replace option
     * @type {boolean};
     */
    safeReplace?: boolean;
    /**
     * Prompt callback that will be invoked before overwiting a data set.
     * @param targetDSN Name of data set that already exists
     * @returns True if target data set should be overwritten
     */
    promptFn?: (targetDSN: string) => Promise<boolean>;
    /**
     * Prompt for duplicates
     * @returns `True` if the copy operation will overwrite an existing member; `false` otherwise
     */
    promptForIdenticalNamedMembers?: () => Promise<boolean>;
    /**
     * Task status object used by CLI handlers to create progress bars
     * Optional
     * @type {ITaskWithStatus}
     */
    task?: ITaskWithStatus;
    /**
     * Apis to create and destroy progress bars during the command.
     * @type {IHandlerProgressApi}
     * @memberof IHandlerResponseApi
     */
    progress?: IHandlerProgressApi;
}
//# sourceMappingURL=ICopyDatasetOptions.d.ts.map