@broadcom/sysview-for-zowe-cli/lib/cli/display/Display.definition.js

Zowe CLI plugin for SYSVIEW

"use strict";
/*
* Copyright (c) 2020 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.
*
*/
const CommandDefinitionOptions_1 = require("../CommandDefinitionOptions");
const api = require("../../api");
/**
 * Command one [object] defintion. This definition is of imperative type "command" and therefore must have a
 * command handler (which performs the "work" for this command).
 *
 * In this case, "command-with-options" will echo options specified on the command.
 *
 * Property Summary:
 * =================
 * "name" of the [object]. Should be a noun (e.g. data-set)
 *
 * "aliases" normally contains a shortened form of the command
 *
 * "summary" will display when issuing the help on this [objects] [action]
 *
 * "type" is "command" which means a handler is required
 *
 * "handler" is the file path to the handler (does the work)
 *
 * "options" an array of options
 */
const DisplayDefinition = {
    name: "display", aliases: ["dsp"],
    summary: "Display a real-time SYSVIEW primary command",
    description: "Issue a SYSVIEW primary command and display output, including any messages",
    type: "command",
    handler: __dirname + "/Display.handler",
    profile: { optional: ["sysview", "sysview-format"] },
    positionals: [
        CommandDefinitionOptions_1.CommandDefinitionOptions.COMMAND_STRING_POSITIONAL
    ],
    options: [
        CommandDefinitionOptions_1.CommandDefinitionOptions.FIELDS_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.ALL_ROWS_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.ROW_START_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.ROW_END_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.CONTEXT_FIELDS_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.OVERVIEW_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.INFO_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.PRETTY_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.BLANK_IF_ZERO_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.TRUNCATE_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.TIMEOUT_OPTION,
        CommandDefinitionOptions_1.CommandDefinitionOptions.RESPONSE_FORMAT_CSV_OPTION,
        ...api.SysviewSession.SYSVIEW_CONNECTION_OPTIONS
    ],
    examples: [
        {
            options: `"CSMSTAT" --cf message`,
            description: "Issue the CSMSTAT command and show the 'message' field from the context area of the response"
        },
        {
            options: `"jobs CS&VLMC" --fields Jobname Jobid Status`,
            description: `Issue the JOBSUM command to list jobs starting with "CS" showing only the fields Jobname, Jobid, and Status`
        }
    ]
};
module.exports = DisplayDefinition;
//# sourceMappingURL=Display.definition.js.map