@broadcom/ca7-for-zowe-cli/lib/cli/transaction/items/GetKey.definition.js

CA 7 Workload Automation Plug-in for Zowe CLI

"use strict";
/*
* Copyright (c) 2025 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.GetKeyDefinition = void 0;
exports.GetKeyDefinition = {
    name: "key",
    aliases: ["key"],
    summary: "Retrieves a unique transaction key to be used as command identifier",
    description: "Retrieves a unique transaction key to be passed to any CA7Onl command.\n" +
        "The key will be used to ensure the same command is not sent twice.\n" +
        "After it is used in the payload of the initial request, the transaction key can only be used when reissuing the POST on the same endpoint, with the same payload.\n" +
        "Also note that the key will expire.\n" +
        "So it should not be used if more than 60 minutes have elapsed since the initial invocation.",
    examples: [
        {
            options: "",
            description: "Retrieves a unique transaction key to be used as command identifier"
        }
    ],
    type: "command",
    handler: __dirname + "/GetKey.handler",
    profile: {
        optional: ["ca7"]
    },
    options: []
};
//# sourceMappingURL=GetKey.definition.js.map