Report¶
-
class
oci.data_safe.models.
Report
(**kwargs)¶ Bases:
object
The description of the report.
Attributes
DATA_SOURCE_ALERTS
A constant which can be used with the data_source property of a Report. DATA_SOURCE_ALLOWED_SQL
A constant which can be used with the data_source property of a Report. DATA_SOURCE_EVENTS
A constant which can be used with the data_source property of a Report. DATA_SOURCE_SECURITY_ASSESSMENT
A constant which can be used with the data_source property of a Report. DATA_SOURCE_VIOLATIONS
A constant which can be used with the data_source property of a Report. LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a Report. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a Report. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a Report. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a Report. MIME_TYPE_JSON
A constant which can be used with the mime_type property of a Report. MIME_TYPE_PDF
A constant which can be used with the mime_type property of a Report. MIME_TYPE_XLS
A constant which can be used with the mime_type property of a Report. TYPE_GENERATED
A constant which can be used with the type property of a Report. TYPE_SCHEDULED
A constant which can be used with the type property of a Report. compartment_id
[Required] Gets the compartment_id of this Report. data_source
Gets the data_source of this Report. defined_tags
Gets the defined_tags of this Report. description
Gets the description of this Report. display_name
[Required] Gets the display_name of this Report. freeform_tags
Gets the freeform_tags of this Report. id
[Required] Gets the id of this Report. lifecycle_details
Gets the lifecycle_details of this Report. lifecycle_state
[Required] Gets the lifecycle_state of this Report. mime_type
Gets the mime_type of this Report. report_definition_id
Gets the report_definition_id of this Report. system_tags
Gets the system_tags of this Report. time_created
Gets the time_created of this Report. time_generated
[Required] Gets the time_generated of this Report. time_updated
Gets the time_updated of this Report. type
Gets the type of this Report. Methods
__init__
(**kwargs)Initializes a new Report object with values from keyword arguments. -
DATA_SOURCE_ALERTS
= 'ALERTS'¶ A constant which can be used with the data_source property of a Report. 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 Report. 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 Report. This constant has a value of “EVENTS”
-
DATA_SOURCE_SECURITY_ASSESSMENT
= 'SECURITY_ASSESSMENT'¶ A constant which can be used with the data_source property of a Report. This constant has a value of “SECURITY_ASSESSMENT”
-
DATA_SOURCE_VIOLATIONS
= 'VIOLATIONS'¶ A constant which can be used with the data_source property of a Report. This constant has a value of “VIOLATIONS”
-
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a Report. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a Report. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a Report. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶ A constant which can be used with the lifecycle_state property of a Report. This constant has a value of “UPDATING”
-
MIME_TYPE_JSON
= 'JSON'¶ A constant which can be used with the mime_type property of a Report. This constant has a value of “JSON”
-
MIME_TYPE_PDF
= 'PDF'¶ A constant which can be used with the mime_type property of a Report. This constant has a value of “PDF”
-
MIME_TYPE_XLS
= 'XLS'¶ A constant which can be used with the mime_type property of a Report. This constant has a value of “XLS”
-
TYPE_GENERATED
= 'GENERATED'¶ A constant which can be used with the type property of a Report. This constant has a value of “GENERATED”
-
TYPE_SCHEDULED
= 'SCHEDULED'¶ A constant which can be used with the type property of a Report. This constant has a value of “SCHEDULED”
-
__init__
(**kwargs)¶ Initializes a new Report object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - id (str) – The value to assign to the id property of this Report.
- display_name (str) – The value to assign to the display_name property of this Report.
- report_definition_id (str) – The value to assign to the report_definition_id property of this Report.
- description (str) – The value to assign to the description property of this Report.
- compartment_id (str) – The value to assign to the compartment_id property of this Report.
- mime_type (str) – The value to assign to the mime_type property of this Report. 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’.
- time_generated (datetime) – The value to assign to the time_generated property of this Report.
- time_created (datetime) – The value to assign to the time_created property of this Report.
- time_updated (datetime) – The value to assign to the time_updated property of this Report.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this Report. Allowed values for this property are: “UPDATING”, “ACTIVE”, “CREATING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- type (str) – The value to assign to the type property of this Report. Allowed values for this property are: “GENERATED”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- data_source (str) – The value to assign to the data_source property of this Report. Allowed values for this property are: “EVENTS”, “ALERTS”, “SECURITY_ASSESSMENT”, “VIOLATIONS”, “ALLOWED_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this Report.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Report.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Report.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Report.
-
compartment_id
¶ [Required] Gets the compartment_id of this Report. The OCID of the compartment containing the report.
Returns: The compartment_id of this Report. Return type: str
-
data_source
¶ Gets the data_source of this Report. Specifies the name of a resource that provides data for the report. For example alerts, events.
Allowed values for this property are: “EVENTS”, “ALERTS”, “SECURITY_ASSESSMENT”, “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 Report. Return type: str
Gets the defined_tags of this Report. 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 Report. Return type: dict(str, dict(str, object))
-
description
¶ Gets the description of this Report. Specifies a description of the report.
Returns: The description of this Report. Return type: str
-
display_name
¶ [Required] Gets the display_name of this Report. Name of the report.
Returns: The display_name of this Report. Return type: str
Gets the freeform_tags of this Report. 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 Report. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this Report. The OCID of the report.
Returns: The id of this Report. Return type: str
-
lifecycle_details
¶ Gets the lifecycle_details of this Report. Details about the current state of the report in Data Safe.
Returns: The lifecycle_details of this Report. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this Report. The current state of the audit report.
Allowed values for this property are: “UPDATING”, “ACTIVE”, “CREATING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The lifecycle_state of this Report. Return type: str
-
mime_type
¶ Gets the mime_type of this Report. Specifies the format of report to be .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 mime_type of this Report. Return type: str
-
report_definition_id
¶ Gets the report_definition_id of this Report. The OCID of the report definition.
Returns: The report_definition_id of this Report. Return type: str
Gets the system_tags of this Report. 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 Report. Return type: dict(str, dict(str, object))
-
time_created
¶ Gets the time_created of this Report. Specifies the time at which the report was created.
Returns: The time_created of this Report. Return type: datetime
-
time_generated
¶ [Required] Gets the time_generated of this Report. Specifies the date and time the report was generated.
Returns: The time_generated of this Report. Return type: datetime
-
time_updated
¶ Gets the time_updated of this Report. The date and time of the report update in Data Safe.
Returns: The time_updated of this Report. Return type: datetime
-
type
¶ Gets the type of this Report. The type of the audit report.
Allowed values for this property are: “GENERATED”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The type of this Report. Return type: str
-