Data

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

Bases: object

The payload of the event. Information within data comes from the resource emitting the event.

Methods:

__init__(**kwargs)

Initializes a new Data object with values from keyword arguments.

Attributes:

additional_details

Gets the additional_details of this Data.

availability_domain

Gets the availability_domain of this Data.

compartment_id

Gets the compartment_id of this Data.

compartment_name

Gets the compartment_name of this Data.

defined_tags

Gets the defined_tags of this Data.

event_grouping_id

Gets the event_grouping_id of this Data.

event_name

Gets the event_name of this Data.

freeform_tags

Gets the freeform_tags of this Data.

identity

Gets the identity of this Data.

request

Gets the request of this Data.

resource_id

Gets the resource_id of this Data.

resource_name

Gets the resource_name of this Data.

response

Gets the response of this Data.

state_change

Gets the state_change of this Data.

__init__(**kwargs)

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

Parameters
  • event_grouping_id (str) – The value to assign to the event_grouping_id property of this Data.

  • event_name (str) – The value to assign to the event_name property of this Data.

  • compartment_id (str) – The value to assign to the compartment_id property of this Data.

  • compartment_name (str) – The value to assign to the compartment_name property of this Data.

  • resource_name (str) – The value to assign to the resource_name property of this Data.

  • resource_id (str) – The value to assign to the resource_id property of this Data.

  • availability_domain (str) – The value to assign to the availability_domain property of this Data.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Data.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Data.

  • identity (oci.audit.models.Identity) – The value to assign to the identity property of this Data.

  • request (oci.audit.models.Request) – The value to assign to the request property of this Data.

  • response (oci.audit.models.Response) – The value to assign to the response property of this Data.

  • state_change (oci.audit.models.StateChange) – The value to assign to the state_change property of this Data.

  • additional_details (dict(str, object)) – The value to assign to the additional_details property of this Data.

property additional_details

Gets the additional_details of this Data. A container object for attribues unique to the resource emitting the event.

Example:

{

“imageId”: “ocid1.image.oc1.phx.<unique_ID>”, “shape”: “VM.Standard1.1”, “type”: “CustomerVmi”

}

Returns

The additional_details of this Data.

Return type

dict(str, object)

property availability_domain

Gets the availability_domain of this Data. The availability domain where the resource resides.

Returns

The availability_domain of this Data.

Return type

str

property compartment_id

Gets the compartment_id of this Data. The OCID of the compartment of the resource emitting the event.

Returns

The compartment_id of this Data.

Return type

str

property compartment_name

Gets the compartment_name of this Data. The name of the compartment. This value is the friendly name associated with compartmentId. This value can change, but the service logs the value that appeared at the time of the audit event.

Example: CompartmentA

Returns

The compartment_name of this Data.

Return type

str

property defined_tags

Gets the defined_tags of this Data. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this Data.

Return type

dict(str, dict(str, object))

property event_grouping_id

Gets the event_grouping_id of this Data. This value links multiple audit events that are part of the same API operation. For example, a long running API operations that emit an event at the start and the end of an operation would use the same value in this field for both events.

Returns

The event_grouping_id of this Data.

Return type

str

property event_name

Gets the event_name of this Data. Name of the API operation that generated this event.

Example: GetInstance

Returns

The event_name of this Data.

Return type

str

property freeform_tags

Gets the freeform_tags of this Data. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this Data.

Return type

dict(str, str)

property identity

Gets the identity of this Data.

Returns

The identity of this Data.

Return type

oci.audit.models.Identity

property request

Gets the request of this Data.

Returns

The request of this Data.

Return type

oci.audit.models.Request

property resource_id

Gets the resource_id of this Data. An OCID or some other ID for the resource emitting the event.

Returns

The resource_id of this Data.

Return type

str

property resource_name

Gets the resource_name of this Data. The name of the resource emitting the event.

Returns

The resource_name of this Data.

Return type

str

property response

Gets the response of this Data.

Returns

The response of this Data.

Return type

oci.audit.models.Response

property state_change

Gets the state_change of this Data.

Returns

The state_change of this Data.

Return type

oci.audit.models.StateChange