@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/update/update-processor-group/UpdateProcessorGroup.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var ProcessorGroupOptions = require('../../../options/ProcessorGroupOptions.js');
var EBGOptions = require('../../../options/EBGOptions.js');

/*
 * 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.
 */
const UpdateProcessorGroupDefinition = {
    name: "processor-group",
    aliases: ["pg"],
    type: "command",
    handler: __dirname + "/UpdateProcessorGroup.handler",
    description: "Update the processor group of a specific element, or all changed elements of a type, in your local repository",
    summary: "Update the processor group of an element or all changed elements",
    positionals: [ProcessorGroupOptions.ProcessorGroupOptions.PROCESSOR_GROUP],
    options: [
        EBGOptions.EBGOptions.WORK_DIRECTORY,
        ProcessorGroupOptions.ProcessorGroupOptions.ELEMENT,
        ProcessorGroupOptions.ProcessorGroupOptions.ENDEVOR_SYSTEM,
        ProcessorGroupOptions.ProcessorGroupOptions.ENDEVOR_SUBSYSTEM,
        ProcessorGroupOptions.ProcessorGroupOptions.TYPE,
        ProcessorGroupOptions.ProcessorGroupOptions.UPDATE_ALL,
    ],
    outputFormatOptions: true,
    examples: [
        {
            description: "Changes the processor group to the NEW-PROCESSOR-GROUP for the specified Endevor system, subsystem and type.",
            options: "NEW-PROCESSOR-GROUP --work-dir /path/to/mapping/directory --endevor-system sysname --endevor-subsystem subname --type COBOL",
        },
        {
            description: "Changes the processor group for the specified Endevor element",
            options: "NEW-PROCESSOR-GROUP --work-dir /path/to/mapping/directory --element elementName",
        },
    ],
};

exports.UpdateProcessorGroupDefinition = UpdateProcessorGroupDefinition;