@zowe/cli/lib/zosfiles/download/Download.options.js

Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.

"use strict";
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.DownloadOptions = exports.maxConcurrentRequestsMaxValue = void 0;
// Does not use the import in anticipation of some internationalization work to be done later.
const strings = require("../-strings-/en").default.DOWNLOAD.OPTIONS;
/** @internal */
exports.maxConcurrentRequestsMaxValue = 100;
/**
 * Object containing all options to be used by the Download data set API
 */
exports.DownloadOptions = {
    /**
     * The volume serial
     * @type {ICommandOptionDefinition}
     */
    volume: {
        name: "volume-serial",
        aliases: ["vs"],
        description: strings.VOLUME,
        type: "string"
    },
    /**
     * The binary option
     * @type {ICommandOptionDefinition}
     */
    binary: {
        name: "binary",
        aliases: ["b"],
        description: strings.BINARY,
        type: "boolean"
    },
    /**
     * The record option
     * @type {ICommandOptionDefinition}
     */
    record: {
        name: "record",
        aliases: ["r"],
        description: strings.RECORD,
        type: "boolean",
        conflictsWith: ["binary"]
    },
    /**
     * The encoding option
     * @type {ICommandOptionDefinition}
     */
    encoding: {
        name: "encoding",
        aliases: ["ec"],
        description: strings.ENCODING,
        type: "string"
    },
    /**
     * The local file to download the data set to
     * @type {ICommandOptionDefinition}
     */
    file: {
        name: "file",
        aliases: ["f"],
        description: strings.FILE,
        type: "string"
    },
    /**
     * The file extension to use for the downloaded file
     * @type {ICommandOptionDefinition}
     */
    extension: {
        name: "extension",
        aliases: ["e"],
        description: strings.EXTENSION,
        type: "stringOrEmpty"
    },
    /**
     * The directory to download all members to
     * @type {ICommandOptionDefinition}
     */
    directory: {
        name: "directory",
        aliases: ["d"],
        description: strings.DIRECTORY,
        type: "string"
    },
    directoryUss: {
        name: "directory",
        aliases: ["d"],
        description: strings.DIRECTORY_USS,
        type: "string"
    },
    /**
     * The pattern to be excluded
     * @type {ICommandOptionDefinition}
     */
    excludePattern: {
        name: "exclude-patterns",
        aliases: ["ep"],
        description: strings.EXCLUDE_PATTERN,
        type: "string"
    },
    /**
     * The extension-map to use for the downloaded file
     * @type {ICommandOptionDefinition}
     */
    extensionMap: {
        name: "extension-map",
        aliases: ["em"],
        description: strings.EXTENSION_MAP,
        type: "string",
        conflictsWith: ["extension"]
    },
    /**
     *  The maximum concurrent requests for "download all-members"
     * @type {ICommandOptionDefinition}
     */
    maxConcurrentRequests: {
        name: "max-concurrent-requests",
        aliases: ["mcr"],
        description: strings.MAX_CONCURRENT_REQUESTS,
        type: "number",
        defaultValue: 1,
        numericValueRange: [0, exports.maxConcurrentRequestsMaxValue]
    },
    maxConcurrentRequestsUss: {
        name: "max-concurrent-requests",
        aliases: ["mcr"],
        description: strings.MAX_CONCURRENT_REQUESTS_USS,
        type: "number",
        defaultValue: 1,
        numericValueRange: [0, exports.maxConcurrentRequestsMaxValue]
    },
    preserveOriginalLetterCase: {
        name: "preserve-original-letter-case",
        aliases: ["po"],
        description: strings.PRESERVE_ORIGINAL_LETTER_CASE,
        type: "boolean",
        defaultValue: false
    },
    failFast: {
        name: "fail-fast",
        aliases: ["ff"],
        description: strings.FAIL_FAST,
        type: "boolean",
        defaultValue: true
    },
    failFastUss: {
        name: "fail-fast",
        aliases: ["ff"],
        description: strings.FAIL_FAST_USS,
        type: "boolean",
        defaultValue: true
    },
    /**
     * The attributes option to specify the path to a zos-files-attributes file
     */
    attributes: {
        name: "attributes",
        aliases: ["attrs"],
        description: strings.ATTRIBUTES,
        type: "existingLocalFile",
        conflictsWith: ["binary", "record"]
    },
    /**
     * The include hidden option for download
     */
    includeHidden: {
        name: "include-hidden",
        aliases: ["ih"],
        description: strings.INCLUDE_HIDDEN,
        type: "boolean"
    },
    /**
     * The include hidden option for download
     */
    overwrite: {
        name: "overwrite",
        aliases: ["ow"],
        description: strings.OVERWRITE,
        type: "boolean"
    }
};
//# sourceMappingURL=Download.options.js.map