UNPKG

@zowe/cli

Version:

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

github.com/zowe/zowe-cli

zowe/zowe-cli

77 lines (76 loc) • 3.61 kB
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
import { AbstractSession } from "@zowe/imperative"; import { IZosFilesResponse } from "../../doc/IZosFilesResponse"; import { IListOptions } from "./doc/IListOptions"; import { IUSSListOptions } from "./doc/IUSSListOptions"; import { IFsOptions } from "./doc/IFsOptions"; /** * This class holds helper functions that are used to list data sets and its members through the z/OS MF APIs */ export declare class List { /** * Retrieve all members from a PDS * * @param {AbstractSession} session - z/OS MF connection info * @param {string} dataSetName - contains the data set name * @param {IListOptions} [options={}] - contains the options to be sent * * @returns {Promise<IZosFilesResponse>} A response indicating the outcome of the API * * @throws {ImperativeError} data set name must be set * @throws {Error} When the {@link ZosmfRestClient} throws an error * * @see https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua700/IZUHPINFO_API_GetListDataSetMembers.htm */ static allMembers(session: AbstractSession, dataSetName: string, options?: IListOptions): Promise<IZosFilesResponse>; /** * Retrieve all members from a data set name * * @param {AbstractSession} session - z/OS MF connection info * @param {string} dataSetName - contains the data set name * @param {IListOptions} [options={}] - contains the options to be sent * * @returns {Promise<IZosFilesResponse>} A response indicating the outcome of the API * * @throws {ImperativeError} data set name must be set * @throws {Error} When the {@link ZosmfRestClient} throws an error */ static dataSet(session: AbstractSession, dataSetName: string, options?: IListOptions): Promise<IZosFilesResponse>; /** * Retrieve a list of all files from a path name * * @param {AbstractSession} session - z/OS MF connection info * @param {string} path - contains the uss path name * @param {IUSSListOptions} [options={}] - contains the options to be sent * * @returns {Promise<IZosFilesResponse>} A response indicating the outcome of the API * * @throws {ImperativeError} data set name must be set * @throws {Error} When the {@link ZosmfRestClient} throws an error */ static fileList(session: AbstractSession, path: string, options?: IUSSListOptions): Promise<IZosFilesResponse>; /** * Retrieve zfs files * * @param {AbstractSession} session - z/OS MF connection info * @param {IZfsOptions} [options={}] - contains the options to be sent * * @returns {Promise<IZosFilesResponse>} A response indicating the outcome of the API * * @throws {ImperativeError} data set name must be set * @throws {Error} When the {@link ZosmfRestClient} throws an error */ static fs(session: AbstractSession, options?: IFsOptions): Promise<IZosFilesResponse>; /** * Retrieve zfs files if indicated path * * @param {AbstractSession} session - z/OS MF connection info * @param {IZfsOptions} [options={}] - contains the options to be sent * * @returns {Promise<IZosFilesResponse>} A response indicating the outcome of the API * * @throws {ImperativeError} data set name must be set * @throws {Error} When the {@link ZosmfRestClient} throws an error */ static fsWithPath(session: AbstractSession, options?: IFsOptions): Promise<IZosFilesResponse>; private static get log(); }