Response

class oci.audit.models.Response(**kwargs)

Bases: object

A container object for response attributes.

Example:

Methods

__init__(**kwargs) Initializes a new Response object with values from keyword arguments.

Attributes

headers Gets the headers of this Response.
message Gets the message of this Response.
payload Gets the payload of this Response.
response_time Gets the response_time of this Response.
status Gets the status of this Response.

{ “status”: “200”, “responseTime”: “2019-09-18T00:10:59.278Z”, “headers”: { “ETag”: [ “<unique_ID>” ], “Connection”: [ “close” ], “Content-Length”: [ “1828” ], “opc-request-id”: [ “<unique_ID>” ], “Date”: [ “Wed, 18 Sep 2019 00:10:59 GMT” ], “Content-Type”: [ “application/json” ] }, “payload”: { “resourceName”: “my_instance”, “id”: “ocid1.instance.oc1.phx.<unique_ID>” }, “message”: null } —–

__init__(**kwargs)

Initializes a new Response object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • status (str) – The value to assign to the status property of this Response.
  • response_time (datetime) – The value to assign to the response_time property of this Response.
  • headers (dict(str, list[str])) – The value to assign to the headers property of this Response.
  • payload (dict(str, object)) – The value to assign to the payload property of this Response.
  • message (str) – The value to assign to the message property of this Response.
headers

Gets the headers of this Response. The headers of the response.

Example:

{
“ETag”: [
“<unique_ID>”

], “Connection”: [

“close”

], “Content-Length”: [

“1828”

], “opc-request-id”: [

“<unique_ID>”

], “Date”: [

“Wed, 18 Sep 2019 00:10:59 GMT”

], “Content-Type”: [

“application/json”

]

}

Returns:The headers of this Response.
Return type:dict(str, list[str])
message

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

Returns:The message of this Response.
Return type:str
payload

Gets the payload of this Response. 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.<unique_ID>”

}

Returns:The payload of this Response.
Return type:dict(str, object)
response_time

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

Example: 2019-09-18T00:10:59.278Z

Returns:The response_time of this Response.
Return type:datetime
status

Gets the status of this Response. The status code of the response.

Example: 200

Returns:The status of this Response.
Return type:str