@zowe/cli/lib/workflows/create/Create.common.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.CreateCommonOptions = void 0;
/**
 * Object containing all extra options to be used by the create workflow commands.
 */
exports.CreateCommonOptions = {
    /**
     * Data set containing workflow definition option.
     * @type {ICommandOptionDefinition}
     */
    dataSet: {
        name: "data-set",
        aliases: ["ds"],
        type: "string",
        description: "Data set that contains a workflow definition.",
        required: true
    },
    /**
     * Uss file containing workflow definition option.
     * @type {ICommandOptionDefinition}
     */
    ussFile: {
        name: "uss-file",
        aliases: ["uf"],
        type: "string",
        description: "USS file that contains workflow definition.",
        required: true
    },
    /**
     * Local file containing workflow definition option.
     * @type {ICommandOptionDefinition}
     */
    localFile: {
        name: "local-file",
        aliases: ["lf"],
        type: "string",
        description: "Local file that contains workflow definition.",
        required: true
    },
    /**
     * System where the workflow will run.
     * @type {ICommandOptionDefinition}
     */
    systemName: {
        name: "system-name",
        aliases: ["sn"],
        description: "z/OS system to execute the workflow.",
        type: "string",
        required: true
    },
    /**
     * User id of the owner of the workflow.
     * @type {ICommandOptionDefinition}
     */
    owner: {
        name: "owner",
        aliases: ["ow"],
        description: "User ID of the workflow owner. This user can perform the workflow steps or delegate the steps to other users.",
        type: "string",
        required: true
    },
    /**
     * Property file containing key-value pairs as workflow variables.
     * @type {ICommandOptionDefinition}
     */
    inputFile: {
        name: "variables-input-file",
        aliases: ["vif"],
        description: "Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that" +
            " are defined in the workflow definition file.",
        type: "string",
        required: false
    },
    /**
     * Variables list for workflow.
     * @type {ICommandOptionDefinition}
     */
    variables: {
        name: "variables",
        aliases: ["vs"],
        description: "Includes a list of variables for the workflow. " +
            "The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. " +
            "Make sure the value meets all regular expression requirements set for the corresponding variable.",
        type: "string",
        required: false
    },
    /**
     * Indicates whether the workflow steps are assigned to the workflow owner.
     * @type {ICommandOptionDefinition}
     */
    assignToOwner: {
        name: "assign-to-owner",
        aliases: ["ato"],
        description: "Indicates whether the workflow steps are assigned to the workflow owner.",
        type: "boolean",
        required: false
    },
    /**
     * Specifies the access type for the workflow. Public, Restricted or Private.
     * @type {ICommandOptionDefinition}
     */
    accessType: {
        name: "access-type",
        aliases: ["at"],
        description: "Specifies the access type for the workflow. Public, Restricted or Private.",
        type: "string",
        required: false,
        allowableValues: {
            values: ["Public", "Restricted", "Private"],
            caseSensitive: true
        }
    },
    /**
     * Whether the successfully completed jobs to  be deleted from the JES spool.
     * @type {ICommandOptionDefinition}
     */
    deleteCompleted: {
        name: "delete-completed",
        aliases: ["dc"],
        description: "Whether the successfully completed jobs to be deleted from the JES spool.",
        type: "boolean",
        required: false
    },
    /**
     * Specifies whether delete workflow with the same name if it already exists.
     * @type {ICommandOptionDefinition}
     */
    overwrite: {
        name: "overwrite",
        aliases: ["ov"],
        description: "Replaces an existing workflow with a new workflow. ",
        type: "boolean",
        required: false
    },
    /**
     * The remote uss directory where the files are to be uploaded.
     * @type {ICommandOptionDefinition}
     */
    remoteDirectory: {
        name: "remote-directory",
        aliases: ["rd"],
        description: "The remote USS directory where the files are to be uploaded. The directory has to exist.",
        type: "string",
        required: false
    },
    /**
     * Avoid deletion the uploaded files after successful execution.
     * @type {ICommandOptionDefinition}
     */
    keepFiles: {
        name: "keep-files",
        aliases: ["kf"],
        description: "Avoid deletion the uploaded files in /tmp or another specified directory after successful execution.",
        type: "boolean",
        defaultValue: false,
        required: false
    },
    /**
     * Identifies the version of the zOSMF workflow service.
     * @type {ICommandOptionDefinition}
     */
    zosmfVersion: {
        name: "zosmf-version",
        aliases: ["zosmf-v"],
        description: "Identifies the version of the zOSMF workflow service.",
        type: "boolean",
        required: false
    }
};
//# sourceMappingURL=Create.common.options.js.map