UNPKG

@zowe/core-for-zowe-sdk

Version:

Core libraries shared by Zowe SDK packages

199 lines 5.64 kB
import { IHeaderContent } from "@zowe/imperative"; /** * Class to contain default z/OSMF headers * @export * @class ZosmfHeaders */ export declare class ZosmfHeaders { /** * file encoding header * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_FILE_ENCODING = "X-IBM-Intrdr-File-Encoding"; /** * lrecl header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_LRECL = "X-IBM-Intrdr-Lrecl"; /** * recfm header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_RECFM = "X-IBM-Intrdr-Recfm"; /** * jcl symbol header to be completed by API * @static * @memberof ZosmfHeaders */ static readonly X_IBM_JCL_SYMBOL_PARTIAL = "X-IBM-JCL-Symbol-"; /** * job class header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_CLASS_A: IHeaderContent; /** * fixed recfm header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_RECFM_F: IHeaderContent; /** * 80 lrecl header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_LRECL_80: IHeaderContent; /** * 256 lrecl header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_LRECL_256: IHeaderContent; /** * text type header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_INTRDR_MODE_TEXT: IHeaderContent; /** * n/a header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_NOTIFICATION_URL: IHeaderContent; /** * base header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_ATTRIBUTES_BASE: IHeaderContent; /** * If you use this header, delete job API will be asynchronous. * This is the default setting, so using this header is not really necessary unless you want to be explicit. * @static * @memberof ZosmfHeaders */ static readonly X_IBM_JOB_MODIFY_VERSION_1: IHeaderContent; /** * If you use this header, delete job API will be synchronous. * But using it may cause problems for some users depending on their maintenance level and configuration. * @static * @memberof ZosmfHeaders */ static readonly X_IBM_JOB_MODIFY_VERSION_2: IHeaderContent; /** * security header * @static * @memberof ZosmfHeaders */ static readonly X_CSRF_ZOSMF_HEADER: object; /** * binary transfer header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_BINARY: IHeaderContent; /** * record transfer header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_RECORD: IHeaderContent; /** * binary by record header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_BINARY_BY_RECORD: IHeaderContent; /** * text transfer header * @static * @memberof ZosmfHeaders */ static readonly X_IBM_TEXT: IHeaderContent; /** * encoding value for text headers * @static * @memberof ZosmfHeaders */ static readonly X_IBM_TEXT_ENCODING: string; /** * octet stream header * @static * @memberof ZosmfHeaders */ static readonly OCTET_STREAM: IHeaderContent; /** * plain text header * @static * @memberof ZosmfHeaders */ static readonly TEXT_PLAIN: IHeaderContent; /** * This header value specifies the maximum number of items to return. * To request that all items be returned, set this header to 0. If you omit this header, or specify an incorrect value, * up to 1000 items are returned by default. * @static * @memberof ZosmfHeaders */ static readonly X_IBM_MAX_ITEMS: IHeaderContent; /** * data set migrated recall headers * @static * @memberof ZosmfHeaders */ static readonly X_IBM_MIGRATED_RECALL_WAIT: IHeaderContent; static readonly X_IBM_MIGRATED_RECALL_NO_WAIT: IHeaderContent; static readonly X_IBM_MIGRATED_RECALL_ERROR: IHeaderContent; /** * Header to check ETag on read * Request returns HTTP 304 if not modified * @static * @memberof ZosmfHeaders */ static readonly IF_NONE_MATCH = "If-None-Match"; /** * Header to check ETag on write * Request returns HTTP 412 if not matched * @static * @memberof ZosmfHeaders */ static readonly IF_MATCH = "If-Match"; /** * Header to set response timeout * Timeout defaults to 30 seconds if not modified * @static * @memberof ZosmfHeaders */ static readonly X_IBM_RESPONSE_TIMEOUT: string; /** * Header to set record range * @static * @memberof ZosmfHeaders */ static readonly X_IBM_RECORD_RANGE: string; /** * Header to set byte range * @static * @memberof ZosmfHeaders */ static readonly RANGE: string; /** * Header to force return of ETag in response regardless of file size * By default Etag is returned only for files smaller than a system determined value (which is at least 8mb) * @static * @memberof ZosmfHeaders */ static readonly X_IBM_RETURN_ETAG: IHeaderContent; /** * Header that specifies GZIP compression is supported * Recent versions of z/OSMF issue a warning if this header is omitted * @static * @memberof ZosmfHeaders */ static readonly ACCEPT_ENCODING: IHeaderContent; } //# sourceMappingURL=ZosmfHeaders.d.ts.map