@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/list/list-mapping/ListMapping.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var MappingOptions = require('../../../options/MappingOptions.js');
var PageableOptions = require('../../../options/PageableOptions.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 ListMappingDefinition = {
    name: "mapping",
    aliases: ["m"],
    type: "command",
    handler: __dirname + "/ListMapping.handler",
    description: "List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, " +
        "the field 'system' and 'subsystem' will contain the value 'multi'.",
    summary: "List Git-Endevor mappings",
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    options: [
        MappingOptions.MappingOptions.VIEW_TYPE,
        MappingOptions.MappingOptions.EXPORT_LIST,
        PageableOptions.PageableOptions.PAGE,
        PageableOptions.PageableOptions.SIZE,
    ],
    outputFormatOptions: true,
    examples: [
        {
            description: "List all the Git-Endevor mappings using the default EBG profile",
            options: "",
        },
        {
            description: "List specific number of the Git-Endevor mappings using the default EBG profile",
            options: "--size 5",
        },
        {
            description: "Use the default EBG profile to list all Git-Endevor mappings and the details.",
            options: "--view endevor",
        },
        {
            description: "List all the Git-Endevor mappings and show all their details using the default EBG profile",
            options: "--view all",
        },
        {
            description: "List all the Git-Endevor mappings without an EBG profile",
            options: "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890",
        },
    ],
};

exports.ListMappingDefinition = ListMappingDefinition;