Options
All
  • Public
  • Public/Protected
  • All
Menu

Get the response to a command that was issued asynchronously with the Issue Command service

export

Hierarchy

  • CollectCommand

Index

Properties

Static Private Readonly TO_SECONDS

TO_SECONDS: number = 1000

Methods

Static collect

  • Collect any messages related to the synchronous command response key provided and collect them into IConsoleResponse

    To control additional collection and other behaviors, populate the ICollectParms object according to your needs (see ICollectParms for details).

    static
    memberof

    CollectCommand

    Parameters

    • session: AbstractSession

      representing connection to this api

    • parms: ICollectParms

      console collect parameters, @see {ICollectParms}

    • Optional response: IConsoleResponse

      response from previous command (if present), @see {IConsoleResponse}

    Returns Promise<IConsoleResponse>

    command response on resolve, @see {IConsoleResponse}

Static collectCommon

  • collectCommon(session: AbstractSession, consoleName: string, commandResponseKey: string): any
  • Collect any messages related to the synchronous command response key provided

    static
    memberof

    CollectCommand

    Parameters

    • session: AbstractSession

      representing connection to this api

    • consoleName: string

      name of the EMCS console that is used to issue the command

    • commandResponseKey: string

      command response key from the Issue Command request

    Returns any

    command response on resolve, @see {IZosmfIssueResponse}

Static collectDefConsoleCommon

  • collectDefConsoleCommon(session: AbstractSession, commandResponseKey: string): any
  • Collect any messages (from default console) related to the synchronous command response key provided

    static
    memberof

    CollectCommand

    Parameters

    • session: AbstractSession

      representing connection to this api

    • commandResponseKey: string

      command response key from the Issue Command request

    Returns any

    command response on resolve, @see {IZosmfCollectResponse}

Static Private getFollowUpAttempts

Static getResource

  • getResource(consoleName: string, commandResponseKey: string): string
  • Get resource path for collect command

    memberof

    CollectCommand

    Parameters

    • consoleName: string

      name of the EMCS console that is used to issue the command

    • commandResponseKey: string

      command response key from the Issue Command request

    Returns string

    resource path

Static Private getTimeout

Generated using TypeDoc