@hpcc-js/comms 2.91.3 → 2.92.1

package/types-3.4/ecl/workunit.d.ts

@@ -1,8 +1,8 @@
-import { Cache, StateCallback, StateEvents, StateObject, StatePropCallback, StringAnyMap, XMLNode } from "@hpcc-js/util";
+import { Cache, RecursivePartial, StateCallback, StateEvents, StateObject, StatePropCallback, StringAnyMap, XMLNode } from "@hpcc-js/util";
 import { IConnection, IOptions } from "../connection";
 import { WsSMC } from "../services/wsSMC";
 import * as WsTopology from "../services/wsTopology";
-import * as WsWorkunits from "../services/wsWorkunits";
+import { WsWorkunits, WUStateID, WorkunitsService, WUUpdate } from "../services/wsWorkunits";
 import { ECLGraph, ScopeGraph, XGMMLGraph } from "./graph";
 import { Resource } from "./resource";
 import { Result } from "./result";
@@ -58,7 +58,7 @@ export interface DebugState {
     [key: string]: any;
 }
 export interface IWorkunit {
-    ResultViews: WsWorkunits.WUInfo.ResultViews;
+    ResultViews: WsWorkunits.ResultViews;
     HelpersCount: number;
 }
 export interface IDebugWorkunit {
@@ -71,49 +71,49 @@ export interface ITimeElapsed {
     finish: string;
 }
 export type WorkunitEvents = "completed" | StateEvents;
-export type UWorkunitState = WsWorkunits.WUQuery.ECLWorkunit & WsWorkunits.WUInfo.Workunit & WsSMC.ActiveWorkunit & IWorkunit & IDebugWorkunit;
-export type IWorkunitState = WsWorkunits.WUQuery.ECLWorkunit | WsWorkunits.WUInfo.Workunit | WsSMC.ActiveWorkunit | IWorkunit | IDebugWorkunit;
-export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState> implements WsWorkunits.WUInfo.Workunit {
-    connection: WsWorkunits.WorkunitsService;
+export type UWorkunitState = WsWorkunits.ECLWorkunit & WsWorkunits.Workunit & WsSMC.ActiveWorkunit & IWorkunit & IDebugWorkunit;
+export type IWorkunitState = WsWorkunits.ECLWorkunit | WsWorkunits.Workunit | WsSMC.ActiveWorkunit | IWorkunit | IDebugWorkunit;
+export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState> implements WsWorkunits.Workunit {
+    connection: WorkunitsService;
     topologyConnection: WsTopology.TopologyService;
     readonly BaseUrl: string;
     private _debugMode;
     private _debugAllGraph;
     private _submitAction;
-    readonly properties: WsWorkunits.WUQuery.ECLWorkunit & WsWorkunits.WUInfo.Workunit;
+    readonly properties: WsWorkunits.ECLWorkunit & WsWorkunits.Workunit;
     readonly Wuid: string;
     readonly Owner: string;
     readonly Cluster: string;
     readonly Jobname: string;
     readonly Description: string;
     readonly ActionEx: string;
-    readonly StateID: WsWorkunits.WUStateID;
+    readonly StateID: WUStateID;
     readonly State: string;
     readonly Protected: boolean;
-    readonly Exceptions: WsWorkunits.WUInfo.Exceptions2;
-    readonly ResultViews: WsWorkunits.WUInfo.ResultViews;
+    readonly Exceptions: WsWorkunits.Exceptions2;
+    readonly ResultViews: WsWorkunits.ResultViews;
     private _resultCache;
     readonly ResultCount: number;
-    readonly Results: WsWorkunits.WUInfo.Results;
+    readonly Results: WsWorkunits.Results;
     readonly CResults: Result[];
     readonly SequenceResults: {
         [key: number]: Result;
     };
-    readonly Timers: WsWorkunits.WUInfo.Timers;
+    readonly Timers: WsWorkunits.Timers;
     readonly CTimers: Timer[];
     private _graphCache;
     readonly GraphCount: number;
-    readonly Graphs: WsWorkunits.WUInfo.Graphs;
+    readonly Graphs: WsWorkunits.Graphs;
     readonly CGraphs: ECLGraph[];
-    readonly ThorLogList: WsWorkunits.WUInfo.ThorLogList;
+    readonly ThorLogList: WsWorkunits.ThorLogList;
     readonly ResourceURLCount: number;
-    readonly ResourceURLs: WsWorkunits.WUInfo.ResourceURLs;
+    readonly ResourceURLs: WsWorkunits.ResourceURLs;
     readonly CResourceURLs: Resource[];
     readonly TotalClusterTime: string;
     readonly DateTimeScheduled: string;
     readonly IsPausing: boolean;
     readonly ThorLCR: boolean;
-    readonly ApplicationValues: WsWorkunits.WUInfo.ApplicationValues;
+    readonly ApplicationValues: WsWorkunits.ApplicationValues;
     readonly HasArchiveQuery: boolean;
     readonly StateEx: string;
     readonly PriorityClass: number;
@@ -121,21 +121,20 @@ export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState
     readonly Snapshot: string;
     readonly ResultLimit: number;
     readonly EventSchedule: number;
-    readonly HaveSubGraphTimings: boolean;
-    readonly Query: WsWorkunits.WUInfo.Query;
+    readonly Query: WsWorkunits.Query;
     readonly HelpersCount: number;
-    readonly Helpers: WsWorkunits.WUInfo.Helpers;
-    readonly DebugValues: WsWorkunits.WUInfo.DebugValues;
-    readonly AllowedClusters: WsWorkunits.WUInfo.AllowedClusters;
+    readonly Helpers: WsWorkunits.Helpers;
+    readonly DebugValues: WsWorkunits.DebugValues;
+    readonly AllowedClusters: WsWorkunits.AllowedClusters;
     readonly ErrorCount: number;
     readonly WarningCount: number;
     readonly InfoCount: number;
     readonly AlertCount: number;
     readonly SourceFileCount: number;
-    readonly SourceFiles: WsWorkunits.WUInfo.SourceFiles;
+    readonly SourceFiles: WsWorkunits.SourceFiles;
     readonly CSourceFiles: SourceFile[];
     readonly VariableCount: number;
-    readonly Variables: WsWorkunits.WUInfo.Variables;
+    readonly Variables: WsWorkunits.Variables;
     readonly TimerCount: number;
     readonly HasDebugValue: boolean;
     readonly ApplicationValueCount: number;
@@ -154,8 +153,8 @@ export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState
     readonly Scope: string;
     readonly AbortBy: string;
     readonly AbortTime: string;
-    readonly Workflows: WsWorkunits.WUInfo.Workflows;
-    readonly TimingData: WsWorkunits.WUInfo.TimingData;
+    readonly Workflows: WsWorkunits.Workflows;
+    readonly TimingData: WsWorkunits.TimingData;
     readonly HelpersDesc: string;
     readonly GraphsDesc: string;
     readonly SourceFilesDesc: string;
@@ -165,71 +164,73 @@ export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState
     readonly DebugValuesDesc: string;
     readonly ApplicationValuesDesc: string;
     readonly WorkflowsDesc: string;
-    readonly ServiceNames: WsWorkunits.WUInfo.ServiceNames;
+    readonly ServiceNames: WsWorkunits.ServiceNames;
     readonly CompileCost: number;
     readonly ExecuteCost: number;
     readonly FileAccessCost: number;
+    readonly NoAccess: boolean;
+    readonly ECLWUProcessList: WsWorkunits.ECLWUProcessList;
     static create(optsConnection: IOptions | IConnection): Promise<Workunit>;
     static attach(optsConnection: IOptions | IConnection, wuid: string, state?: IWorkunitState): Workunit;
     static existsLocal(baseUrl: string, wuid: string): boolean;
     static submit(server: IOptions | IConnection, target: string, ecl: string, compileOnly?: boolean): Promise<Workunit>;
     static compile(server: IOptions | IConnection, target: string, ecl: string): Promise<Workunit>;
-    static query(server: IOptions | IConnection, opts: WsWorkunits.WUQuery.Request): Promise<Workunit[]>;
+    static query(server: IOptions | IConnection, opts: Partial<WsWorkunits.WUQuery>): Promise<Workunit[]>;
     protected constructor(optsConnection: IOptions | IConnection, wuid?: string);
     clearState(wuid?: string): void;
-    update(request: Partial<WsWorkunits.WUUpdate.Request>): Promise<Workunit>;
-    submit(_cluster?: string, action?: WsWorkunits.WUUpdate.Action, resultLimit?: number): Promise<Workunit>;
+    update(request: Partial<WsWorkunits.WUUpdate>): Promise<Workunit>;
+    submit(_cluster?: string, action?: WUUpdate.Action, resultLimit?: number): Promise<Workunit>;
     isComplete(): boolean;
     isFailed(): boolean;
     isDeleted(): boolean;
     isDebugging(): boolean;
     isRunning(): boolean;
-    setToFailed(): Promise<WsWorkunits.WUAction.Response>;
-    pause(): Promise<WsWorkunits.WUAction.Response>;
-    pauseNow(): Promise<WsWorkunits.WUAction.Response>;
-    resume(): Promise<WsWorkunits.WUAction.Response>;
-    abort(): Promise<WsWorkunits.WUAction.Response>;
-    protect(): Promise<WsWorkunits.WUAction.Response>;
-    unprotect(): Promise<WsWorkunits.WUAction.Response>;
-    delete(): Promise<WsWorkunits.WUAction.Response>;
-    restore(): Promise<WsWorkunits.WUAction.Response>;
-    deschedule(): Promise<WsWorkunits.WUAction.Response>;
-    reschedule(): Promise<WsWorkunits.WUAction.Response>;
+    setToFailed(): Promise<WsWorkunits.WUActionResponse>;
+    pause(): Promise<WsWorkunits.WUActionResponse>;
+    pauseNow(): Promise<WsWorkunits.WUActionResponse>;
+    resume(): Promise<WsWorkunits.WUActionResponse>;
+    abort(): Promise<WsWorkunits.WUActionResponse>;
+    protect(): Promise<WsWorkunits.WUActionResponse>;
+    unprotect(): Promise<WsWorkunits.WUActionResponse>;
+    delete(): Promise<WsWorkunits.WUActionResponse>;
+    restore(): Promise<WsWorkunits.WUActionResponse>;
+    deschedule(): Promise<WsWorkunits.WUActionResponse>;
+    reschedule(): Promise<WsWorkunits.WUActionResponse>;
     resubmit(): Promise<Workunit>;
     clone(): Promise<Workunit>;
     refreshState(): Promise<this>;
-    refreshInfo(request?: Partial<WsWorkunits.WUInfo.Request>): Promise<this>;
+    refreshInfo(request?: Partial<WsWorkunits.WUInfo>): Promise<this>;
     refreshDebug(): Promise<this>;
-    refresh(full?: boolean, request?: Partial<WsWorkunits.WUInfo.Request>): Promise<this>;
-    eclExceptions(): WsWorkunits.WUInfo.ECLException[];
+    refresh(full?: boolean, request?: Partial<WsWorkunits.WUInfo>): Promise<this>;
+    eclExceptions(): WsWorkunits.ECLException[];
     fetchArchive(): Promise<string>;
-    fetchECLExceptions(): Promise<WsWorkunits.WUInfo.ECLException[]>;
+    fetchECLExceptions(): Promise<WsWorkunits.ECLException[]>;
     fetchResults(): Promise<Result[]>;
     fetchGraphs(): Promise<ECLGraph[]>;
-    fetchQuery(): Promise<WsWorkunits.WUInfo.Query>;
-    fetchHelpers(): Promise<WsWorkunits.WUInfo.ECLHelpFile[]>;
+    fetchQuery(): Promise<WsWorkunits.Query>;
+    fetchHelpers(): Promise<WsWorkunits.ECLHelpFile[]>;
     fetchAllowedClusters(): Promise<string[]>;
     fetchTotalClusterTime(): Promise<string>;
     fetchServiceNames(): Promise<string[]>;
-    fetchDetailsMeta(request?: Partial<WsWorkunits.WUDetailsMeta.Request>): Promise<WsWorkunits.WUDetailsMeta.Response>;
-    fetchDetailsRaw(request?: Partial<WsWorkunits.WUDetails.Request>): Promise<WsWorkunits.WUDetails.Scope[]>;
-    normalizeDetails(meta: WsWorkunits.WUDetailsMeta.Response, scopes: WsWorkunits.WUDetails.Scope[]): {
-        meta: WsWorkunits.WUDetailsMeta.Response;
+    fetchDetailsMeta(request?: RecursivePartial<WsWorkunits.WUDetailsMeta>): Promise<WsWorkunits.WUDetailsMetaResponse>;
+    fetchDetailsRaw(request?: RecursivePartial<WsWorkunits.WUDetails>): Promise<WsWorkunits.Scope[]>;
+    normalizeDetails(meta: WsWorkunits.WUDetailsMetaResponse, scopes: WsWorkunits.Scope[]): {
+        meta: WsWorkunits.WUDetailsMetaResponse;
         columns: {
             [id: string]: any;
         };
         data: IScope[];
     };
-    fetchDetailsNormalized(request?: Partial<WsWorkunits.WUDetails.Request>): Promise<{
-        meta: WsWorkunits.WUDetailsMeta.Response;
+    fetchDetailsNormalized(request?: RecursivePartial<WsWorkunits.WUDetails>): Promise<{
+        meta: WsWorkunits.WUDetailsMetaResponse;
         columns: {
             [id: string]: any;
         };
         data: IScope[];
     }>;
-    fetchInfo(request?: Partial<WsWorkunits.WUInfo.Request>): Promise<WsWorkunits.WUInfo.Response>;
-    fetchDetails(request?: Partial<WsWorkunits.WUDetails.Request>): Promise<Scope[]>;
-    fetchDetailsHierarchy(request?: Partial<WsWorkunits.WUDetails.Request>): Promise<Scope[]>;
+    fetchInfo(request?: Partial<WsWorkunits.WUInfo>): Promise<WsWorkunits.WUInfoResponse>;
+    fetchDetails(request?: RecursivePartial<WsWorkunits.WUDetails>): Promise<Scope[]>;
+    fetchDetailsHierarchy(request?: Partial<WsWorkunits.WUDetails>): Promise<Scope[]>;
     fetchGraphDetails(graphIDs: string[], rootTypes: string[]): Promise<BaseScope[]>;
     fetchScopeGraphs(graphIDs?: string[]): Promise<ScopeGraph>;
     fetchTimeElapsed(): Promise<ITimeElapsed[]>;
@@ -238,15 +239,15 @@ export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState
     on(eventID: WorkunitEvents, propIDorCallback: StateCallback | keyof UWorkunitState, callback?: StatePropCallback): this;
     watchUntilComplete(callback?: StateCallback): Promise<this>;
     watchUntilRunning(callback?: StateCallback): Promise<this>;
-    protected WUQuery(_request?: Partial<WsWorkunits.WUQuery.Request>): Promise<WsWorkunits.WUQuery.Response>;
-    protected WUCreate(): Promise<WsWorkunits.WUCreate.Response>;
-    protected WUInfo(_request?: Partial<WsWorkunits.WUInfo.Request>): Promise<WsWorkunits.WUInfo.Response>;
-    protected WUResubmit(request: Partial<WsWorkunits.WUResubmit.Request>): Promise<WsWorkunits.WUResubmit.Response>;
-    protected WUDetailsMeta(request: Partial<WsWorkunits.WUDetailsMeta.Request>): Promise<WsWorkunits.WUDetailsMeta.Response>;
-    protected WUDetails(request: Partial<WsWorkunits.WUDetails.Request>): Promise<WsWorkunits.WUDetails.Response>;
-    protected WUAction(actionType: WsWorkunits.WUAction.Type): Promise<WsWorkunits.WUAction.Response>;
-    publish(name?: string): Promise<WsWorkunits.WUPublishWorkunit.Response>;
-    publishEx(request: Partial<WsWorkunits.WsWorkunits.WUPublishWorkunit>): Promise<WsWorkunits.WsWorkunits.WUPublishWorkunitResponse>;
+    protected WUQuery(_request?: Partial<WsWorkunits.WUQuery>): Promise<WsWorkunits.WUQueryResponse>;
+    protected WUCreate(): Promise<WsWorkunits.WUCreateResponse>;
+    protected WUInfo(_request?: Partial<WsWorkunits.WUInfo>): Promise<WsWorkunits.WUInfoResponse>;
+    protected WUResubmit(request: Partial<WsWorkunits.WUResubmit>): Promise<WsWorkunits.WUResubmitResponse>;
+    protected WUDetailsMeta(request: Partial<WsWorkunits.WUDetailsMeta>): Promise<WsWorkunits.WUDetailsMetaResponse>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>): Promise<WsWorkunits.WUDetailsResponse>;
+    protected WUAction(actionType: WsWorkunits.ECLWUActions): Promise<WsWorkunits.WUActionResponse>;
+    publish(name?: string): Promise<WsWorkunits.WUPublishWorkunitResponse>;
+    publishEx(request: Partial<WsWorkunits.WUPublishWorkunit>): Promise<WsWorkunits.WUPublishWorkunitResponse>;
     protected WUCDebug(command: string, opts?: any): Promise<XMLNode | null>;
     debug(command: string, opts?: object): Promise<XMLNode>;
     debugStatus(): Promise<XMLNode>;