ReportDefinitionSummary¶

class oci.data_safe.models.ReportDefinitionSummary(**kwargs)¶

Bases: object

Summary of report definition.

Attributes

`CATEGORY_ACTIVITY_AUDITING`	A constant which can be used with the category property of a ReportDefinitionSummary.
`CATEGORY_ALLOWED_SQL`	A constant which can be used with the category property of a ReportDefinitionSummary.
`CATEGORY_CUSTOM_REPORTS`	A constant which can be used with the category property of a ReportDefinitionSummary.
`CATEGORY_FIREWALL_VIOLATIONS`	A constant which can be used with the category property of a ReportDefinitionSummary.
`CATEGORY_SUMMARY`	A constant which can be used with the category property of a ReportDefinitionSummary.
`DATA_SOURCE_ALERTS`	A constant which can be used with the data_source property of a ReportDefinitionSummary.
`DATA_SOURCE_ALLOWED_SQL`	A constant which can be used with the data_source property of a ReportDefinitionSummary.
`DATA_SOURCE_EVENTS`	A constant which can be used with the data_source property of a ReportDefinitionSummary.
`DATA_SOURCE_VIOLATIONS`	A constant which can be used with the data_source property of a ReportDefinitionSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary.
`category`	Gets the category of this ReportDefinitionSummary.
`compartment_id`	[Required] Gets the compartment_id of this ReportDefinitionSummary.
`compliance_standards`	Gets the compliance_standards of this ReportDefinitionSummary.
`data_source`	Gets the data_source of this ReportDefinitionSummary.
`defined_tags`	Gets the defined_tags of this ReportDefinitionSummary.
`description`	Gets the description of this ReportDefinitionSummary.
`display_name`	[Required] Gets the display_name of this ReportDefinitionSummary.
`display_order`	Gets the display_order of this ReportDefinitionSummary.
`freeform_tags`	Gets the freeform_tags of this ReportDefinitionSummary.
`id`	[Required] Gets the id of this ReportDefinitionSummary.
`is_seeded`	Gets the is_seeded of this ReportDefinitionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ReportDefinitionSummary.
`schedule`	Gets the schedule of this ReportDefinitionSummary.
`time_created`	[Required] Gets the time_created of this ReportDefinitionSummary.
`time_updated`	Gets the time_updated of this ReportDefinitionSummary.

Methods

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

CATEGORY_ACTIVITY_AUDITING = 'ACTIVITY_AUDITING'¶: A constant which can be used with the category property of a ReportDefinitionSummary. This constant has a value of “ACTIVITY_AUDITING”

CATEGORY_ALLOWED_SQL = 'ALLOWED_SQL'¶: A constant which can be used with the category property of a ReportDefinitionSummary. This constant has a value of “ALLOWED_SQL”

CATEGORY_CUSTOM_REPORTS = 'CUSTOM_REPORTS'¶: A constant which can be used with the category property of a ReportDefinitionSummary. This constant has a value of “CUSTOM_REPORTS”

CATEGORY_FIREWALL_VIOLATIONS = 'FIREWALL_VIOLATIONS'¶: A constant which can be used with the category property of a ReportDefinitionSummary. This constant has a value of “FIREWALL_VIOLATIONS”

CATEGORY_SUMMARY = 'SUMMARY'¶: A constant which can be used with the category property of a ReportDefinitionSummary. This constant has a value of “SUMMARY”

DATA_SOURCE_ALERTS = 'ALERTS'¶: A constant which can be used with the data_source property of a ReportDefinitionSummary. This constant has a value of “ALERTS”

DATA_SOURCE_ALLOWED_SQL = 'ALLOWED_SQL'¶: A constant which can be used with the data_source property of a ReportDefinitionSummary. This constant has a value of “ALLOWED_SQL”

DATA_SOURCE_EVENTS = 'EVENTS'¶: A constant which can be used with the data_source property of a ReportDefinitionSummary. This constant has a value of “EVENTS”

DATA_SOURCE_VIOLATIONS = 'VIOLATIONS'¶: A constant which can be used with the data_source property of a ReportDefinitionSummary. This constant has a value of “VIOLATIONS”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ReportDefinitionSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

display_name (str) – The value to assign to the display_name property of this ReportDefinitionSummary.
id (str) – The value to assign to the id property of this ReportDefinitionSummary.
category (str) – The value to assign to the category property of this ReportDefinitionSummary. Allowed values for this property are: “CUSTOM_REPORTS”, “SUMMARY”, “ACTIVITY_AUDITING”, “FIREWALL_VIOLATIONS”, “ALLOWED_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this ReportDefinitionSummary.
is_seeded (bool) – The value to assign to the is_seeded property of this ReportDefinitionSummary.
display_order (int) – The value to assign to the display_order property of this ReportDefinitionSummary.
time_created (datetime) – The value to assign to the time_created property of this ReportDefinitionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ReportDefinitionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ReportDefinitionSummary.
data_source (str) – The value to assign to the data_source property of this ReportDefinitionSummary. Allowed values for this property are: “EVENTS”, “ALERTS”, “VIOLATIONS”, “ALLOWED_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ReportDefinitionSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
schedule (str) – The value to assign to the schedule property of this ReportDefinitionSummary.
compliance_standards (list[str]) – The value to assign to the compliance_standards property of this ReportDefinitionSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ReportDefinitionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ReportDefinitionSummary.

category¶

Gets the category of this ReportDefinitionSummary. Specifies the name of the category that this report belongs to.

Allowed values for this property are: “CUSTOM_REPORTS”, “SUMMARY”, “ACTIVITY_AUDITING”, “FIREWALL_VIOLATIONS”, “ALLOWED_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The category of this ReportDefinitionSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ReportDefinitionSummary. The OCID of the compartment containing the report definition.

Returns:	The compartment_id of this ReportDefinitionSummary.
Return type:	str

compliance_standards¶

Gets the compliance_standards of this ReportDefinitionSummary. The list of data protection regulations/standards used in the report that will help demonstrate compliance.

Returns:	The compliance_standards of this ReportDefinitionSummary.
Return type:	list[str]

data_source¶

Gets the data_source of this ReportDefinitionSummary. Specifies the name of a resource that provides data for the report. For example alerts, events.

Allowed values for this property are: “EVENTS”, “ALERTS”, “VIOLATIONS”, “ALLOWED_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The data_source of this ReportDefinitionSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this ReportDefinitionSummary. 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 ReportDefinitionSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this ReportDefinitionSummary. A description of the report definition.

Returns:	The description of this ReportDefinitionSummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this ReportDefinitionSummary. Name of the report definition.

Returns:	The display_name of this ReportDefinitionSummary.
Return type:	str

display_order¶

Gets the display_order of this ReportDefinitionSummary. Specifies how the report definitions are ordered in the display.

Returns:	The display_order of this ReportDefinitionSummary.
Return type:	int

freeform_tags¶

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

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this ReportDefinitionSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ReportDefinitionSummary. The OCID of the report definition.

Returns:	The id of this ReportDefinitionSummary.
Return type:	str

is_seeded¶

Gets the is_seeded of this ReportDefinitionSummary. Signifies whether the definition is seeded or user defined. Values can either be ‘true’ or ‘false’.

Returns:	The is_seeded of this ReportDefinitionSummary.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this ReportDefinitionSummary. The current state of the audit report.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ReportDefinitionSummary.
Return type:	str

schedule¶

Gets the schedule of this ReportDefinitionSummary. The schedule to generate the report periodically in the specified format: <version-string>;<version-specific-schedule>

Allowed version strings - “v1” v1’s version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A work request is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) 4. <day-of-week> can be either ‘*’ (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is ‘*’. When not, day of week must equal the given value. 5. <day-of-month> can be either ‘*’ (without quotes or a number between 1 and 28) No constraint introduced when it is ‘*’. When not, day of month must equal the given value

Returns:	The schedule of this ReportDefinitionSummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this ReportDefinitionSummary. Specifies the time at which the report definition was created.

Returns:	The time_created of this ReportDefinitionSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this ReportDefinitionSummary. The date and time of the report definition update in Data Safe.

Returns:	The time_updated of this ReportDefinitionSummary.
Return type:	datetime