REST client error interface. Extends IImperativeError to provide additional details specified to REST/HTTP errors.

interface

  IRestClientError

### Hierarchy

- IImperativeError
  - IRestClientError

## Index

### Properties

- additionalDetails
- authType
- authTypeOrder
- availableCreds
- basePath
- causeErrors
- errno
- errorCode
- headers
- host
- httpStatus
- msg
- payload
- port
- protocol
- request
- resource
- source
- stack
- suppressDump
- syscall

## Properties

### Optional additionalDetails

additionalDetails: string

Inherited from IImperativeError.additionalDetails

- Defined in @zowe/imperative/src/error/src/doc/IImperativeError.ts:38

any other extra contextual information (e.g. details pulled out of the cause errors)

memberof

  IImperativeError

### Optional authType

authType: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:85

The type of authentication used by this request

### Optional authTypeOrder

authTypeOrder: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:90

The order in which authentication was selected

### Optional availableCreds

availableCreds: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:95

The credentials that were available for this request

### Optional basePath

basePath: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:60

The "base path" for the URI. Specified on the session object.

### Optional causeErrors

causeErrors: any

Inherited from IImperativeError.causeErrors

- Defined in @zowe/imperative/src/error/src/doc/IImperativeError.ts:31

Original errors that caused/influenced this one

memberof

  IImperativeError

### Optional errno

errno: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:34

The "errno" provided from the Node.js http interface. when client.on("error") is invoked.

### Optional errorCode

errorCode: string

Inherited from IImperativeError.errorCode

- Defined in @zowe/imperative/src/error/src/doc/IImperativeError.ts:52

If applicable, an error code, for example, HTTP status code surrounding the error

memberof

  IImperativeError

### Optional headers

headers: any[]

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:70

Any HTTP headers added to the request.

### Optional host

host: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:39

The hostname supplied on the session object.

### Optional httpStatus

httpStatus: number

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:28

The HTTP status code from the request. Might not be populated if a "client" error occurred (e.g. ECONNREFUSED).

### msg

msg: string

Inherited from IImperativeError.msg

- Defined in @zowe/imperative/src/error/src/doc/IImperativeError.ts:24

Message text of the error

memberof

  IImperativeError

### Optional payload

payload: any

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:75

The request payload.

### Optional port

port: number

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:55

The port number of the remote host. Specified on the session object.

### Optional protocol

protocol: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:50

The protocol used to connect to the remote host. Specified on the session object.

### Optional request

request: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:80

The HTTP method/verb (e.g. PUT)

### Optional resource

resource: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:65

The URI or resource of the request being made.

### source

source: RestErrorSource

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:103

The error "source". Indicates where the error occurred in the REST client. "client" indicates that the error occurred before the request to the remote system could be fulfilled (normally due to network, bad host/port, etc.). "http" indicates that a non-OK HTTP status code was presented.

### Optional stack

stack: string

Inherited from IImperativeError.stack

- Defined in @zowe/imperative/src/error/src/doc/IImperativeError.ts:45

Error status

memberof

  IImperativeError

### Optional suppressDump

suppressDump: boolean

Inherited from IImperativeError.suppressDump

- Defined in @zowe/imperative/src/error/src/doc/IImperativeError.ts:59

Whether or not the error should suppress a full error dump, like in Imperative init

memberof

  IImperativeError

### Optional syscall

syscall: string

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:45

The syscall provided from the Node.js http interface when client.on("error") is invoked. Usually accompanied by an "errno".

Generated using TypeDoc