ReportDefinition¶

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

Bases: object

Description of report definition.

Attributes

`CATEGORY_ACTIVITY_AUDITING`	A constant which can be used with the category property of a ReportDefinition.
`CATEGORY_ALLOWED_SQL`	A constant which can be used with the category property of a ReportDefinition.
`CATEGORY_CUSTOM_REPORTS`	A constant which can be used with the category property of a ReportDefinition.
`CATEGORY_FIREWALL_VIOLATIONS`	A constant which can be used with the category property of a ReportDefinition.
`CATEGORY_SUMMARY`	A constant which can be used with the category property of a ReportDefinition.
`DATA_SOURCE_ALERTS`	A constant which can be used with the data_source property of a ReportDefinition.
`DATA_SOURCE_ALLOWED_SQL`	A constant which can be used with the data_source property of a ReportDefinition.
`DATA_SOURCE_EVENTS`	A constant which can be used with the data_source property of a ReportDefinition.
`DATA_SOURCE_VIOLATIONS`	A constant which can be used with the data_source property of a ReportDefinition.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ReportDefinition.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ReportDefinition.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ReportDefinition.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ReportDefinition.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ReportDefinition.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ReportDefinition.
`SCHEDULED_REPORT_MIME_TYPE_JSON`	A constant which can be used with the scheduled_report_mime_type property of a ReportDefinition.
`SCHEDULED_REPORT_MIME_TYPE_PDF`	A constant which can be used with the scheduled_report_mime_type property of a ReportDefinition.
`SCHEDULED_REPORT_MIME_TYPE_XLS`	A constant which can be used with the scheduled_report_mime_type property of a ReportDefinition.
`category`	Gets the category of this ReportDefinition.
`column_filters`	Gets the column_filters of this ReportDefinition.
`column_info`	Gets the column_info of this ReportDefinition.
`column_sortings`	Gets the column_sortings of this ReportDefinition.
`compartment_id`	[Required] Gets the compartment_id of this ReportDefinition.
`compliance_standards`	Gets the compliance_standards of this ReportDefinition.
`data_source`	Gets the data_source of this ReportDefinition.
`defined_tags`	Gets the defined_tags of this ReportDefinition.
`description`	Gets the description of this ReportDefinition.
`display_name`	[Required] Gets the display_name of this ReportDefinition.
`display_order`	Gets the display_order of this ReportDefinition.
`freeform_tags`	Gets the freeform_tags of this ReportDefinition.
`id`	[Required] Gets the id of this ReportDefinition.
`is_seeded`	Gets the is_seeded of this ReportDefinition.
`lifecycle_details`	Gets the lifecycle_details of this ReportDefinition.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ReportDefinition.
`parent_id`	Gets the parent_id of this ReportDefinition.
`record_time_span`	Gets the record_time_span of this ReportDefinition.
`schedule`	Gets the schedule of this ReportDefinition.
`scheduled_report_compartment_id`	Gets the scheduled_report_compartment_id of this ReportDefinition.
`scheduled_report_mime_type`	Gets the scheduled_report_mime_type of this ReportDefinition.
`scheduled_report_name`	Gets the scheduled_report_name of this ReportDefinition.
`scheduled_report_row_limit`	Gets the scheduled_report_row_limit of this ReportDefinition.
`scim_filter`	Gets the scim_filter of this ReportDefinition.
`summary`	Gets the summary of this ReportDefinition.
`system_tags`	Gets the system_tags of this ReportDefinition.
`time_created`	Gets the time_created of this ReportDefinition.
`time_updated`	Gets the time_updated of this ReportDefinition.

Methods

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

CATEGORY_ACTIVITY_AUDITING = 'ACTIVITY_AUDITING'¶: A constant which can be used with the category property of a ReportDefinition. 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 ReportDefinition. 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 ReportDefinition. 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 ReportDefinition. This constant has a value of “FIREWALL_VIOLATIONS”

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

DATA_SOURCE_ALERTS = 'ALERTS'¶: A constant which can be used with the data_source property of a ReportDefinition. 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 ReportDefinition. 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 ReportDefinition. This constant has a value of “EVENTS”

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

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

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ReportDefinition. This constant has a value of “FAILED”

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

SCHEDULED_REPORT_MIME_TYPE_JSON = 'JSON'¶: A constant which can be used with the scheduled_report_mime_type property of a ReportDefinition. This constant has a value of “JSON”

SCHEDULED_REPORT_MIME_TYPE_PDF = 'PDF'¶: A constant which can be used with the scheduled_report_mime_type property of a ReportDefinition. This constant has a value of “PDF”

SCHEDULED_REPORT_MIME_TYPE_XLS = 'XLS'¶: A constant which can be used with the scheduled_report_mime_type property of a ReportDefinition. This constant has a value of “XLS”

__init__(**kwargs)¶

Initializes a new ReportDefinition 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 ReportDefinition.
id (str) – The value to assign to the id property of this ReportDefinition.
parent_id (str) – The value to assign to the parent_id property of this ReportDefinition.
category (str) – The value to assign to the category property of this ReportDefinition. 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 ReportDefinition.
data_source (str) – The value to assign to the data_source property of this ReportDefinition. 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’.
is_seeded (bool) – The value to assign to the is_seeded property of this ReportDefinition.
display_order (int) – The value to assign to the display_order property of this ReportDefinition.
time_created (datetime) – The value to assign to the time_created property of this ReportDefinition.
time_updated (datetime) – The value to assign to the time_updated property of this ReportDefinition.
scim_filter (str) – The value to assign to the scim_filter property of this ReportDefinition.
column_info (list[oci.data_safe.models.Column]) – The value to assign to the column_info property of this ReportDefinition.
column_filters (list[oci.data_safe.models.ColumnFilter]) – The value to assign to the column_filters property of this ReportDefinition.
column_sortings (list[oci.data_safe.models.ColumnSorting]) – The value to assign to the column_sortings property of this ReportDefinition.
summary (list[oci.data_safe.models.Summary]) – The value to assign to the summary property of this ReportDefinition.
compartment_id (str) – The value to assign to the compartment_id property of this ReportDefinition.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ReportDefinition. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 ReportDefinition.
scheduled_report_mime_type (str) – The value to assign to the scheduled_report_mime_type property of this ReportDefinition. Allowed values for this property are: “PDF”, “XLS”, “JSON”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
scheduled_report_row_limit (int) – The value to assign to the scheduled_report_row_limit property of this ReportDefinition.
scheduled_report_name (str) – The value to assign to the scheduled_report_name property of this ReportDefinition.
scheduled_report_compartment_id (str) – The value to assign to the scheduled_report_compartment_id property of this ReportDefinition.
record_time_span (str) – The value to assign to the record_time_span property of this ReportDefinition.
compliance_standards (list[str]) – The value to assign to the compliance_standards property of this ReportDefinition.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ReportDefinition.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ReportDefinition.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ReportDefinition.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ReportDefinition.

category¶

Gets the category of this ReportDefinition. 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 ReportDefinition.
Return type:	str

column_filters¶

Gets the column_filters of this ReportDefinition. An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.

Returns:	The column_filters of this ReportDefinition.
Return type:	list[oci.data_safe.models.ColumnFilter]

column_info¶

Gets the column_info of this ReportDefinition. An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).

Returns:	The column_info of this ReportDefinition.
Return type:	list[oci.data_safe.models.Column]

column_sortings¶

Gets the column_sortings of this ReportDefinition. An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.

Returns:	The column_sortings of this ReportDefinition.
Return type:	list[oci.data_safe.models.ColumnSorting]

compartment_id¶

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

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

compliance_standards¶

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

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

data_source¶

Gets the data_source of this ReportDefinition. 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 ReportDefinition.
Return type:	str

defined_tags¶

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

description¶

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

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

display_name¶

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

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

display_order¶

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

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

freeform_tags¶

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

id¶

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

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

is_seeded¶

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

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

lifecycle_details¶

Gets the lifecycle_details of this ReportDefinition. Details about the current state of the report definition in Data Safe.

Returns:	The lifecycle_details of this ReportDefinition.
Return type:	str

lifecycle_state¶

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

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

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

parent_id¶

Gets the parent_id of this ReportDefinition. The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.

Returns:	The parent_id of this ReportDefinition.
Return type:	str

record_time_span¶

Gets the record_time_span of this ReportDefinition. The time span for the records in the report to be scheduled. <period-value><period> Allowed period strings - “H”,”D”,”M”,”Y” Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)

Returns:	The record_time_span of this ReportDefinition.
Return type:	str

schedule¶

Gets the schedule of this ReportDefinition. 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 workrequest 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 ReportDefinition.
Return type:	str

scheduled_report_compartment_id¶

Gets the scheduled_report_compartment_id of this ReportDefinition. The OCID of the compartment in which the scheduled resource will be created.

Returns:	The scheduled_report_compartment_id of this ReportDefinition.
Return type:	str

scheduled_report_mime_type¶

Gets the scheduled_report_mime_type of this ReportDefinition. Specifies the format of the report ( either .xls or .pdf or .json)

Allowed values for this property are: “PDF”, “XLS”, “JSON”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The scheduled_report_mime_type of this ReportDefinition.
Return type:	str

scheduled_report_name¶

Gets the scheduled_report_name of this ReportDefinition. The name of the report to be scheduled.

Returns:	The scheduled_report_name of this ReportDefinition.
Return type:	str

scheduled_report_row_limit¶

Gets the scheduled_report_row_limit of this ReportDefinition. Specifies the limit on the number of rows in the report.

Returns:	The scheduled_report_row_limit of this ReportDefinition.
Return type:	int

scim_filter¶

Gets the scim_filter of this ReportDefinition. Additional SCIM filters used to define the report.

Returns:	The scim_filter of this ReportDefinition.
Return type:	str

summary¶

Gets the summary of this ReportDefinition. An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).

Returns:	The summary of this ReportDefinition.
Return type:	list[oci.data_safe.models.Summary]

system_tags¶

Gets the system_tags of this ReportDefinition. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ReportDefinition.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this ReportDefinition. Specifies the date and time the report definition was created.

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

time_updated¶

Gets the time_updated of this ReportDefinition. The date and time the report definition was updated.

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