Class ArchiveWorkflow

Class to handle archiving the workflow instance in z/OSMF

export

Hierarchy

ArchiveWorkflow

Index

Methods

Methods

Static archiveWorfklowByKey

archiveWorfklowByKey(session: AbstractSession, workflowKey: string, zOSMFVersion?: string): Promise<IArchivedWorkflow>

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/ArchiveWorkflow.ts:36
Archives the workflow based on the workflow key

static

deprecated

Use archiveWorkflowByKey instead because it is spelled correctly

memberof

ArchiveWorkflow

Parameters
- session: AbstractSession
  
  z/OSMF session
- workflowKey: string
  
  Workflow key of the workflow to be archived
- Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
Returns Promise<IArchivedWorkflow>

Promise of the output of the workflow archiving

Static archiveWorkflowByKey

archiveWorkflowByKey(session: AbstractSession, workflowKey: string, zOSMFVersion?: string): Promise<IArchivedWorkflow>

- Defined in @zowe/zos-workflows-for-zowe-sdk/src/ArchiveWorkflow.ts:52
Archives the workflow based on the workflow key

static

memberof

ArchiveWorkflow

Parameters
- session: AbstractSession
  
  z/OSMF session
- workflowKey: string
  
  Workflow key of the workflow to be archived
- Default value zOSMFVersion: string = WorkflowConstants.ZOSMF_VERSION
Returns Promise<IArchivedWorkflow>

Promise of the output of the workflow archiving

Generated using TypeDoc