@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/work-area/reserve/WorkAreaReserve.definition.js

Endevor Bridge for Git 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.WorkAreaReserveDefinition = void 0;
const BuildOptions_1 = require("../../options/BuildOptions");
const EndevorOptions_1 = require("../../options/EndevorOptions");
exports.WorkAreaReserveDefinition = {
    name: "reserve", aliases: ["r"],
    type: "command",
    handler: __dirname + "/WorkAreaReserve.handler",
    summary: "Reserve work area in Endevor.",
    description: "Reserve the first found available Endevor work area. When success, returns the reserved work area id",
    positionals: [
        {
            name: BuildOptions_1.BuildOptions.ENDEVOR_OPTION_WORK_AREA_ID.name,
            type: "string",
            description: "Reserve the Endevor work area with the ID specified. Name-masking is not allowed."
        }
    ],
    profile: { optional: ["endevor"] },
    options: [
        EndevorOptions_1.EndevorOptions.ENDEVOR_INSTANCE,
        BuildOptions_1.BuildOptions.OPTION_WORK_DIR
    ],
    examples: [
        {
            description: "Reserve the first found available Endevor work area using an existing Endevor profile",
            options: "--endevor-instance ENDEVOR"
        },
        {
            description: "Reserve the work area with ID \"WORKAREA1\", if available, using an existing Endevor profile",
            options: "WORKAREA1 --endevor-instance ENDEVOR"
        }
    ]
};
//# sourceMappingURL=WorkAreaReserve.definition.js.map