Class to contain default z/OSMF headers

export

### Hierarchy

- ZosmfHeaders

## Index

### Properties

- IF_MATCH
- IF_NONE_MATCH
- RANGE
- X_IBM_INTRDR_FILE_ENCODING
- X_IBM_INTRDR_LRECL
- X_IBM_INTRDR_RECFM
- X_IBM_JCL_SYMBOL_PARTIAL
- X_IBM_RECORD_RANGE
- X_IBM_RESPONSE_TIMEOUT
- X_IBM_TEXT_ENCODING

### Object literals

- ACCEPT_ENCODING
- OCTET_STREAM
- TEXT_PLAIN
- X_CSRF_ZOSMF_HEADER
- X_IBM_ATTRIBUTES_BASE
- X_IBM_BINARY
- X_IBM_BINARY_BY_RECORD
- X_IBM_INTRDR_CLASS_A
- X_IBM_INTRDR_LRECL_256
- X_IBM_INTRDR_LRECL_80
- X_IBM_INTRDR_MODE_TEXT
- X_IBM_INTRDR_RECFM_F
- X_IBM_JOB_MODIFY_VERSION_1
- X_IBM_JOB_MODIFY_VERSION_2
- X_IBM_MAX_ITEMS
- X_IBM_MIGRATED_RECALL_ERROR
- X_IBM_MIGRATED_RECALL_NO_WAIT
- X_IBM_MIGRATED_RECALL_WAIT
- X_IBM_NOTIFICATION_URL
- X_IBM_RECORD
- X_IBM_RETURN_ETAG
- X_IBM_TEXT

## Properties

### Static Readonly IF_MATCH

IF_MATCH: "If-Match" = "If-Match"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:201

Header to check ETag on write Request returns HTTP 412 if not matched

static
memberof

  ZosmfHeaders

### Static Readonly IF_NONE_MATCH

IF_NONE_MATCH: "If-None-Match" = "If-None-Match"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:193

Header to check ETag on read Request returns HTTP 304 if not modified

static
memberof

  ZosmfHeaders

### Static Readonly RANGE

RANGE: string = "Range"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:223

Header to set byte range

static
memberof

  ZosmfHeaders

### Static Readonly X_IBM_INTRDR_FILE_ENCODING

X_IBM_INTRDR_FILE_ENCODING: "X-IBM-Intrdr-File-Encoding" = "X-IBM-Intrdr-File-Encoding"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:25

file encoding header

memberof

  ZosmfHeaders

### Static Readonly X_IBM_INTRDR_LRECL

X_IBM_INTRDR_LRECL: "X-IBM-Intrdr-Lrecl" = "X-IBM-Intrdr-Lrecl"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:32

lrecl header

static
memberof

  ZosmfHeaders

### Static Readonly X_IBM_INTRDR_RECFM

X_IBM_INTRDR_RECFM: "X-IBM-Intrdr-Recfm" = "X-IBM-Intrdr-Recfm"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:40

recfm header

static
memberof

  ZosmfHeaders

### Static Readonly X_IBM_JCL_SYMBOL_PARTIAL

X_IBM_JCL_SYMBOL_PARTIAL: "X-IBM-JCL-Symbol-" = "X-IBM-JCL-Symbol-"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:47

jcl symbol header to be completed by API

static
memberof

  ZosmfHeaders

### Static Readonly X_IBM_RECORD_RANGE

X_IBM_RECORD_RANGE: string = "X-IBM-Record-Range"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:216

Header to set record range

static
memberof

  ZosmfHeaders

### Static Readonly X_IBM_RESPONSE_TIMEOUT

X_IBM_RESPONSE_TIMEOUT: string = "X-IBM-Response-Timeout"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:209

Header to set response timeout Timeout defaults to 30 seconds if not modified

static
memberof

  ZosmfHeaders

### Static Readonly X_IBM_TEXT_ENCODING

X_IBM_TEXT_ENCODING: string = ";fileEncoding="

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:153

encoding value for text headers

static
memberof

  ZosmfHeaders

## Object literals

### Static Readonly ACCEPT_ENCODING

ACCEPT_ENCODING: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:239

Header that specifies GZIP compression is supported Recent versions of z/OSMF issue a warning if this header is omitted

static
memberof

  ZosmfHeaders

### Accept-Encoding

Accept-Encoding: string = "gzip"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:239

### Static Readonly OCTET_STREAM

OCTET_STREAM: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:160

octet stream header

static
memberof

  ZosmfHeaders

### Content-Type

Content-Type: string = "application/octet-stream"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:160

### Static Readonly TEXT_PLAIN

TEXT_PLAIN: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:167

plain text header

static
memberof

  ZosmfHeaders

### Content-Type

Content-Type: string = "text/plain"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:167

### Static Readonly X_CSRF_ZOSMF_HEADER

X_CSRF_ZOSMF_HEADER: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:118

security header

static
memberof

  ZosmfHeaders

### X-CSRF-ZOSMF-HEADER

X-CSRF-ZOSMF-HEADER: boolean = true

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:118

### Static Readonly X_IBM_ATTRIBUTES_BASE

X_IBM_ATTRIBUTES_BASE: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:96

base header

static
memberof

  ZosmfHeaders

### X-IBM-Attributes

X-IBM-Attributes: string = "base"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:96

### Static Readonly X_IBM_BINARY

X_IBM_BINARY: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:125

binary transfer header

static
memberof

  ZosmfHeaders

### X-IBM-Data-Type

X-IBM-Data-Type: string = "binary"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:125

### Static Readonly X_IBM_BINARY_BY_RECORD

X_IBM_BINARY_BY_RECORD: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:139

binary by record header

static
memberof

  ZosmfHeaders

### X-IBM-Data-Type

X-IBM-Data-Type: string = "record"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:139

### Static Readonly X_IBM_INTRDR_CLASS_A

X_IBM_INTRDR_CLASS_A: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:54

job class header

static
memberof

  ZosmfHeaders

### X-IBM-Intrdr-Class

X-IBM-Intrdr-Class: string = "A"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:54

### Static Readonly X_IBM_INTRDR_LRECL_256

X_IBM_INTRDR_LRECL_256: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:75

256 lrecl header

static
memberof

  ZosmfHeaders

### X-IBM-Intrdr-Lrecl

X-IBM-Intrdr-Lrecl: string = "256"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:75

### Static Readonly X_IBM_INTRDR_LRECL_80

X_IBM_INTRDR_LRECL_80: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:68

80 lrecl header

static
memberof

  ZosmfHeaders

### X-IBM-Intrdr-Lrecl

X-IBM-Intrdr-Lrecl: string = "80"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:68

### Static Readonly X_IBM_INTRDR_MODE_TEXT

X_IBM_INTRDR_MODE_TEXT: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:82

text type header

static
memberof

  ZosmfHeaders

### X-IBM-Intrdr-Mode

X-IBM-Intrdr-Mode: string = "TEXT"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:82

### Static Readonly X_IBM_INTRDR_RECFM_F

X_IBM_INTRDR_RECFM_F: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:61

fixed recfm header

static
memberof

  ZosmfHeaders

### X-IBM-Intrdr-Recfm

X-IBM-Intrdr-Recfm: string = "F"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:61

### Static Readonly X_IBM_JOB_MODIFY_VERSION_1

X_IBM_JOB_MODIFY_VERSION_1: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:104

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

### X-IBM-Job-Modify-Version

X-IBM-Job-Modify-Version: string = "1.0"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:104

### Static Readonly X_IBM_JOB_MODIFY_VERSION_2

X_IBM_JOB_MODIFY_VERSION_2: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:111

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

### X-IBM-Job-Modify-Version

X-IBM-Job-Modify-Version: string = "2.0"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:111

### Static Readonly X_IBM_MAX_ITEMS

X_IBM_MAX_ITEMS: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:176

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

### X-IBM-Max-Items

X-IBM-Max-Items: string = "0"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:176

### Static Readonly X_IBM_MIGRATED_RECALL_ERROR

X_IBM_MIGRATED_RECALL_ERROR: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:185

### X-IBM-Migrated-Recall

X-IBM-Migrated-Recall: string = "error"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:185

### Static Readonly X_IBM_MIGRATED_RECALL_NO_WAIT

X_IBM_MIGRATED_RECALL_NO_WAIT: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:184

### X-IBM-Migrated-Recall

X-IBM-Migrated-Recall: string = "nowait"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:184

### Static Readonly X_IBM_MIGRATED_RECALL_WAIT

X_IBM_MIGRATED_RECALL_WAIT: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:183

data set migrated recall headers

static
memberof

  ZosmfHeaders

### X-IBM-Migrated-Recall

X-IBM-Migrated-Recall: string = "wait"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:183

### Static Readonly X_IBM_NOTIFICATION_URL

X_IBM_NOTIFICATION_URL: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:89

n/a header

static
memberof

  ZosmfHeaders

### X-IBM-Notification-URL

X-IBM-Notification-URL: string = ""

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:89

### Static Readonly X_IBM_RECORD

X_IBM_RECORD: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:132

record transfer header

static
memberof

  ZosmfHeaders

### X-IBM-Data-Type

X-IBM-Data-Type: string = "record"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:132

### Static Readonly X_IBM_RETURN_ETAG

X_IBM_RETURN_ETAG: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:231

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

### X-IBM-Return-Etag

X-IBM-Return-Etag: string = "true"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:231

### Static Readonly X_IBM_TEXT

X_IBM_TEXT: object

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:146

text transfer header

static
memberof

  ZosmfHeaders

### X-IBM-Data-Type

X-IBM-Data-Type: string = "text"

- Defined in @zowe/core-for-zowe-sdk/src/rest/ZosmfHeaders.ts:146

Generated using TypeDoc