-
Notifications
You must be signed in to change notification settings - Fork 85
/
ICollectParms.ts
49 lines (45 loc) · 1.85 KB
/
ICollectParms.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { IConsoleParms } from "./IConsoleParms";
/**
* Interface for Collect command parameters
* @export
* @interface ICollectParms
*/
export interface ICollectParms extends IConsoleParms {
/**
* The command response key for follow up messages
* API call.
* @type {string}
* @memberof ICollectParms
*/
commandResponseKey: string;
/**
* Indicates that you would like to wait 'n' number of seconds before issues a follow-up request for
* additional messages (assuming a command response key is present). Will wait the specified amount of
* time before each follow-up request is issued.
* @type {string}
* @memberof ICollectParms
*/
waitToCollect?: number;
/**
* The default is 1, however you may specify the number of follow-up attempts. This can be useful when multiple
* multi-line WTO command responses are issued in direct response to a command. zOS consoles do NOT have any
* awareness of how many multi-line WTO messages will be issued in response to a command. Use this parameter
* in conjunction with waitToCollect to "fine-tune" your requests. The follow-up counter is decremented when
* no command response (response text) is present in the request. Meaning, if a command is issued, follow-up
* attempts is 1, and the first 2 requests provided command response data, it will issue 1 final
* follow up request before returning (resulting in 3 total API calls).
* @type {number}
* @memberof ICollectParms
*/
followUpAttempts?: number;
}