/
Delete.ts
40 lines (35 loc) · 1.64 KB
/
Delete.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { AbstractSession } from "@zowe/imperative";
import { ZosmfRestClient, nozOSMFVersion } from "@zowe/core-for-zowe-sdk";
import { WorkflowConstants, noWorkflowKey } from "./WorkflowConstants";
import { WorkflowValidator } from "./WorkflowValidator";
/**
* Class to handle deletion of zOSMF workflow instance
*/
export class DeleteWorkflow {
/**
* Delete a workflow instance
* @param {AbstractSession} session - z/OSMF connection info
* @param {string} workflowKey - Unique identifier of the workflow instance.
* @param {string} zOSMFVersion - Identifies the version of the zOSMF workflow service.
* @returns {string}
*/
public static async deleteWorkflow(session: AbstractSession, workflowKey: string,
zOSMFVersion = WorkflowConstants.ZOSMF_VERSION){
WorkflowValidator.validateSession(session);
WorkflowValidator.validateNotEmptyString(zOSMFVersion, nozOSMFVersion.message);
WorkflowValidator.validateNotEmptyString(workflowKey, noWorkflowKey.message);
let resourcesQuery: string = `${WorkflowConstants.RESOURCE}/${zOSMFVersion}/`;
resourcesQuery += `${WorkflowConstants.WORKFLOW_RESOURCE}/${workflowKey}`;
return ZosmfRestClient.deleteExpectString(session, resourcesQuery, []);
}
}