@zowe/cli/lib/workflows/src/api/doc/ICreateWorkflow.d.ts

Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.

import { IVariable } from "./IVariables";
export declare type accessT = "Public" | "Private" | "Restricted";
/**
 * Interface for creating workflow objects.
 * @export
 * @interface ICreateWorkflow
 */
export interface ICreateWorkflow {
    /**
     * Unique workflow name.
     * @type {string}
     * @memberof ICreateWorkflow
     */
    workflowName: string;
    /**
     * Path to workflow definition file.
     * Xml in USS or Dataset
     * @type {string}
     * @memberof ICreateWorkflow
     */
    workflowDefinitionFile: string;
    /**
     * Unique workflow name.
     * @type {string}
     * @memberof ICreateWorkflow
     */
    system: string;
    /**
     * Unique workflow name.
     * @type {string}
     * @memberof ICreateWorkflow
     */
    owner: string;
    /**
     * Path to file with variables.
     * USS file with .properties extension or Dataset
     * @type {string}
     * @memberof ICreateWorkflow
     */
    variableInputFile?: string;
    /**
     * Variables to be passed to workflow
     * Can be used to change values of variables that
     * are in input file.
     * @type {IVariable[]}
     * @memberof ICreateWorkflow
     */
    variables?: IVariable[];
    /**
     * Assign workflow steps to owner.
     * @type {string}
     * @memberof ICreateWorkflow
     */
    assignToOwner?: boolean;
    /**
     * Workflow access type
     * @type {string}
     * @memberof ICreateWorkflow
     */
    accessType?: accessT;
    /**
     * Delete completed jobs.
     * @type {string}
     * @memberof ICreateWorkflow
     */
    deleteCompletedJobs?: boolean;
}