Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Response

A container object for response attributes.

Properties

Optional headers

headers: undefined | object

The headers of the response.

Example:

----- { \"ETag\": [ \"\" ], \"Connection\": [ \"close\" ], \"Content-Length\": [ \"1828\" ], \"opc-request-id\": [ \"\" ], \"Date\": [ \"Wed, 18 Sep 2019 00:10:59 GMT\" ], \"Content-Type\": [ \"application/json\" ] } -----

Optional message

message: undefined | string

A friendly description of what happened during the operation. Use this for troubleshooting.

Optional payload

payload: undefined | object

This value is included for backward compatibility with the Audit version 1 schema, where it contained metadata of interest from the response payload.

Example:

----- { \"resourceName\": \"my_instance\", \"id\": \"ocid1.instance.oc1.phx.\" } -----

Optional responseTime

responseTime: Date

The time of the response to the audited request, expressed in RFC 3339 timestamp format.

Example: {@code 2019-09-18T00:10:59.278Z}

Optional status

status: undefined | string

The status code of the response.

Example: {@code 200}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Response): object

getJsonObj