@broadcom/jclcheck-for-zowe-cli/lib/api/Check.d.ts

JCLCheck Plug-in for Zowe CLI

/**
 * Copyright (c) 2023. Broadcom.  All rights reserved.
 *
 * 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 CA IS EXPRESSLY ADVISED OF SUCH LOSS OR
 * DAMAGE.
 *
 * The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 **/
import { AbstractSession } from "@zowe/imperative";
import { ICheck } from "./doc/ICheck";
/**
 * Node API set for JCLCHECK REST API service
 */
export declare class Check {
    /**
     * Invokes the JCLCHECK REST API /check/jclContents endpoint, which checks the content provided in the body.
     * @param session The Rest client session object containing the host/port/credentials/etc
     * @param jcl The JCL contents to check
     * @param options
     */
    static jcl(session: AbstractSession, jcl: string, options?: string): Promise<ICheck>;
    /**
     * Invokes the JCLCHECK REST API /check/DataSet endpoint, which reads the contents of the data set
     * provided in the URI and invokes the JCLCHECK service with the contents.
     * @param session The Rest client session object containing the host/port/credentials/etc
     * @param dataSet The MVS data set (PS or PDS member with LRECL 80, RECFM FB and must be cataloged)
     * @param options The JCLCHECK runtime options
     */
    static dataSet(session: AbstractSession, dataSet: string, options?: string): Promise<ICheck>;
    /**
     * @param dataset The data set to read - placed into the URI
     * @returns the URI for the data set minus the base path
     */
    static dataSetResource(dataset: string): string;
    /**
     * @returns the jcl content URI minus the base path
     */
    static get contentResource(): string;
    /**
     * @returns the default base path
     */
    static get context(): string;
}