Class RestClientError

Hierarchy

ImperativeError
- RestClientError

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new RestClientError(mDetails: IRestClientError, parms?: IImperativeErrorParms): RestClientError

Overrides ImperativeError.constructor
- Defined in @zowe/imperative/src/rest/src/client/RestClientError.ts:16
Creates an instance of RestClientError.

Parameters
- mDetails: IRestClientError
  
  The IRestClientError details provided by the rest client. Contains "relevant" diagnostic information such as host/port/request details, etc.
- Optional parms: IImperativeErrorParms
Returns RestClientError

Properties

mDetails

mDetails: IRestClientError

The IRestClientError details provided by the rest client. Contains "relevant" diagnostic information such as host/port/request details, etc.

name

name: string

Accessors

additionalDetails

get additionalDetails(): string

Inherited from BadCredentialManagerError.additionalDetails
- Defined in @zowe/imperative/src/error/src/ImperativeError.ts:69
Return additionalDetails

readonly

memberof

ImperativeError

Returns string

causeErrors

get causeErrors(): any

Inherited from BadCredentialManagerError.causeErrors
- Defined in @zowe/imperative/src/error/src/ImperativeError.ts:59
Return causeErrors

readonly

memberof

ImperativeError

Returns any

details

get details(): IRestClientError

Overrides BadCredentialManagerError.details
- Defined in @zowe/imperative/src/rest/src/client/RestClientError.ts:31
Accessor for IRestClientError error details.

Returns IRestClientError

errorCode

get errorCode(): string

Inherited from BadCredentialManagerError.errorCode
- Defined in @zowe/imperative/src/error/src/ImperativeError.ts:89
Return errorCode

readonly

memberof

ImperativeError

Returns string

message

get message(): string

Inherited from BadCredentialManagerError.message

Overrides Error.message
- Defined in @zowe/imperative/src/error/src/ImperativeError.ts:119
Accessor for the error message.

readonly

memberof

ImperativeError

Returns string

: The error message

stack

get stack(): string

Inherited from BadCredentialManagerError.stack

Overrides Error.stack
- Defined in @zowe/imperative/src/error/src/ImperativeError.ts:109
Return stack info

readonly

memberof

ImperativeError

Returns string

suppressDump

get suppressDump(): boolean

Inherited from BadCredentialManagerError.suppressDump
- Defined in @zowe/imperative/src/error/src/ImperativeError.ts:99
Return whether or not the error dump should be suppressed

readonly

memberof

ImperativeError

Returns boolean

Generated using TypeDoc