@broadcom/mat-detect-for-zowe-cli/lib/cli/scope/inc_job/Incjob.definition.js

MAT Detect plug-in for Zowe CLI

"use strict";
/*
 * Copyright (c) 2019 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.Incjob = void 0;
const PMASession_1 = require("../../PMASession");
const joblength = 8;
const desclength = 45;
exports.Incjob = {
    name: "inc-job",
    aliases: ["incj"],
    type: "command",
    summary: "Include a job in the PMA scope of work.",
    description: "Include a job in the PMA scope of work.",
    handler: __dirname + "/Incjob.handler",
    profile: {
        required: ["zosmf"],
        optional: ["pma"],
    },
    positionals: [
        {
            name: "jobname",
            description: "Specifies the name of the job that you want to add to the list of inclusions in the PMA scope (e.g. TESTPMA8).",
            type: "string",
            stringLengthRange: [1, joblength],
            required: true
        },
    ],
    options: [
        {
            name: "stepname", aliases: ["st"],
            description: "Specifies the name of the job step that you want to include in the PMA scope.",
            type: "string",
            stringLengthRange: [1, joblength],
            required: false
        },
        {
            name: "procstep", aliases: ["ps"],
            description: "Specifies the procname of the job that you want to include in the PMA scope.",
            type: "string",
            stringLengthRange: [1, joblength],
            required: false
        },
        {
            name: "description", aliases: ["dc"],
            description: "Specifies the description of the job that you want to include in the PMA scope.",
            type: "string",
            stringLengthRange: [1, desclength],
            required: false
        }
    ].concat(PMASession_1.PMASession.PMA_CONNECTION_OPTIONS),
    examples: [
        {
            description: "Include the TESTPMA8 job in the PMA scope",
            options: `TESTPMA8`,
        },
        {
            description: "Include the specific procname and step name of the TESTPMA8" +
                " job in the PMA scope and add a description to the included job",
            options: `TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE"`,
        },
        {
            description: "Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job using specific PMA profile details",
            options: `TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ`,
        },
    ],
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiSW5jam9iLmRlZmluaXRpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvY2xpL3Njb3BlL2luY19qb2IvSW5jam9iLmRlZmluaXRpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FxQkc7OztBQU9ILGlEQUE4QztBQUM5QyxNQUFNLFNBQVMsR0FBVyxDQUFDLENBQUM7QUFDNUIsTUFBTSxVQUFVLEdBQVcsRUFBRSxDQUFDO0FBQ2pCLFFBQUEsTUFBTSxHQUF1QjtJQUN0QyxJQUFJLEVBQUUsU0FBUztJQUNmLE9BQU8sRUFBRSxDQUFDLE1BQU0sQ0FBQztJQUNqQixJQUFJLEVBQUUsU0FBUztJQUNmLE9BQU8sRUFBRSx5Q0FBeUM7SUFDbEQsV0FBVyxFQUFFLHlDQUF5QztJQUN0RCxPQUFPLEVBQUUsU0FBUyxHQUFHLGlCQUFpQjtJQUN0QyxPQUFPLEVBQUU7UUFDTCxRQUFRLEVBQUUsQ0FBQyxPQUFPLENBQUM7UUFDbkIsUUFBUSxFQUFFLENBQUMsS0FBSyxDQUFDO0tBQ3BCO0lBQ0QsV0FBVyxFQUFFO1FBQ1Q7WUFDSSxJQUFJLEVBQUUsU0FBUztZQUNmLFdBQVcsRUFBRSxnSEFBZ0g7WUFDN0gsSUFBSSxFQUFFLFFBQVE7WUFDZCxpQkFBaUIsRUFBRSxDQUFDLENBQUMsRUFBRSxTQUFTLENBQUM7WUFDakMsUUFBUSxFQUFFLElBQUk7U0FDakI7S0FDSjtJQUNELE9BQU8sRUFBRztRQUNOO1lBQ0ksSUFBSSxFQUFFLFVBQVUsRUFBRSxPQUFPLEVBQUUsQ0FBQyxJQUFJLENBQUM7WUFDakMsV0FBVyxFQUFFLCtFQUErRTtZQUM1RixJQUFJLEVBQUUsUUFBUTtZQUNkLGlCQUFpQixFQUFFLENBQUMsQ0FBQyxFQUFFLFNBQVMsQ0FBQztZQUNqQyxRQUFRLEVBQUUsS0FBSztTQUNsQjtRQUNEO1lBQ0ksSUFBSSxFQUFFLFVBQVUsRUFBRSxPQUFPLEVBQUUsQ0FBQyxJQUFJLENBQUM7WUFDakMsV0FBVyxFQUFFLDhFQUE4RTtZQUMzRixJQUFJLEVBQUUsUUFBUTtZQUNkLGlCQUFpQixFQUFFLENBQUMsQ0FBQyxFQUFFLFNBQVMsQ0FBQztZQUNqQyxRQUFRLEVBQUUsS0FBSztTQUNsQjtRQUNEO1lBQ0ksSUFBSSxFQUFFLGFBQWEsRUFBRSxPQUFPLEVBQUUsQ0FBQyxJQUFJLENBQUM7WUFDcEMsV0FBVyxFQUFFLGlGQUFpRjtZQUM5RixJQUFJLEVBQUUsUUFBUTtZQUNkLGlCQUFpQixFQUFFLENBQUMsQ0FBQyxFQUFFLFVBQVUsQ0FBQztZQUNsQyxRQUFRLEVBQUUsS0FBSztTQUNsQjtLQUMyQixDQUFDLE1BQU0sQ0FBQyx1QkFBVSxDQUFDLHNCQUFzQixDQUFDO0lBQzFFLFFBQVEsRUFBRTtRQUNOO1lBQ0ksV0FBVyxFQUFFLDJDQUEyQztZQUN4RCxPQUFPLEVBQUUsVUFBVTtTQUN0QjtRQUNEO1lBQ0ksV0FBVyxFQUFFLDZEQUE2RDtnQkFDMUUsaUVBQWlFO1lBQ2pFLE9BQU8sRUFBRSx3RUFBd0U7U0FDcEY7UUFDRDtZQUNJLFdBQVcsRUFBRSwrSkFBK0o7WUFDNUssT0FBTyxFQUFFLHFJQUFxSTtTQUNqSjtLQUNKO0NBQ0osQ0FBQyJ9