ReportSummary

class oci.data_safe.models.ReportSummary(**kwargs)

Bases: object

Description of report.

Attributes:

DATA_SOURCE_ALERTS

A constant which can be used with the data_source property of a ReportSummary.

DATA_SOURCE_ALLOWED_SQL

A constant which can be used with the data_source property of a ReportSummary.

DATA_SOURCE_CRYPTO_ASSESSMENT

A constant which can be used with the data_source property of a ReportSummary.

DATA_SOURCE_EVENTS

A constant which can be used with the data_source property of a ReportSummary.

DATA_SOURCE_SECURITY_ASSESSMENT

A constant which can be used with the data_source property of a ReportSummary.

DATA_SOURCE_VIOLATIONS

A constant which can be used with the data_source property of a ReportSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ReportSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a ReportSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a ReportSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a ReportSummary.

MIME_TYPE_JSON

A constant which can be used with the mime_type property of a ReportSummary.

MIME_TYPE_PDF

A constant which can be used with the mime_type property of a ReportSummary.

MIME_TYPE_XLS

A constant which can be used with the mime_type property of a ReportSummary.

TYPE_GENERATED

A constant which can be used with the type property of a ReportSummary.

TYPE_SCHEDULED

A constant which can be used with the type property of a ReportSummary.

compartment_id

[Required] Gets the compartment_id of this ReportSummary.

data_source

Gets the data_source of this ReportSummary.

defined_tags

Gets the defined_tags of this ReportSummary.

description

Gets the description of this ReportSummary.

display_name

[Required] Gets the display_name of this ReportSummary.

freeform_tags

Gets the freeform_tags of this ReportSummary.

id

[Required] Gets the id of this ReportSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this ReportSummary.

mime_type

Gets the mime_type of this ReportSummary.

report_definition_id

Gets the report_definition_id of this ReportSummary.

time_created

Gets the time_created of this ReportSummary.

time_generated

[Required] Gets the time_generated of this ReportSummary.

time_updated

Gets the time_updated of this ReportSummary.

type

Gets the type of this ReportSummary.

Methods:

__init__(**kwargs)

Initializes a new ReportSummary object with values from keyword arguments.

DATA_SOURCE_ALERTS = 'ALERTS'

A constant which can be used with the data_source property of a ReportSummary. 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 ReportSummary. This constant has a value of “ALLOWED_SQL”

DATA_SOURCE_CRYPTO_ASSESSMENT = 'CRYPTO_ASSESSMENT'

A constant which can be used with the data_source property of a ReportSummary. This constant has a value of “CRYPTO_ASSESSMENT”

DATA_SOURCE_EVENTS = 'EVENTS'

A constant which can be used with the data_source property of a ReportSummary. 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 ReportSummary. 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 ReportSummary. This constant has a value of “VIOLATIONS”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ReportSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ReportSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ReportSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ReportSummary. This constant has a value of “UPDATING”

MIME_TYPE_JSON = 'JSON'

A constant which can be used with the mime_type property of a ReportSummary. This constant has a value of “JSON”

MIME_TYPE_PDF = 'PDF'

A constant which can be used with the mime_type property of a ReportSummary. This constant has a value of “PDF”

MIME_TYPE_XLS = 'XLS'

A constant which can be used with the mime_type property of a ReportSummary. This constant has a value of “XLS”

TYPE_GENERATED = 'GENERATED'

A constant which can be used with the type property of a ReportSummary. This constant has a value of “GENERATED”

TYPE_SCHEDULED = 'SCHEDULED'

A constant which can be used with the type property of a ReportSummary. This constant has a value of “SCHEDULED”

__init__(**kwargs)

Initializes a new ReportSummary 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 ReportSummary.

  • id (str) – The value to assign to the id property of this ReportSummary.

  • report_definition_id (str) – The value to assign to the report_definition_id property of this ReportSummary.

  • description (str) – The value to assign to the description property of this ReportSummary.

  • mime_type (str) – The value to assign to the mime_type property of this ReportSummary. 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 ReportSummary.

  • time_created (datetime) – The value to assign to the time_created property of this ReportSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this ReportSummary.

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ReportSummary. 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 ReportSummary. 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 ReportSummary. Allowed values for this property are: “EVENTS”, “ALERTS”, “SECURITY_ASSESSMENT”, “CRYPTO_ASSESSMENT”, “VIOLATIONS”, “ALLOWED_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

property compartment_id

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

Returns

The compartment_id of this ReportSummary.

Return type

str

property data_source

Gets the data_source of this ReportSummary. 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”, “CRYPTO_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 ReportSummary.

Return type

str

property defined_tags

Gets the defined_tags of this ReportSummary. 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 ReportSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this ReportSummary. Description of the report.

Returns

The description of this ReportSummary.

Return type

str

property display_name

[Required] Gets the display_name of this ReportSummary. Name of the report.

Returns

The display_name of this ReportSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this ReportSummary. 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 ReportSummary.

Return type

dict(str, str)

property id

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

Returns

The id of this ReportSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this ReportSummary. The current state of the 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 ReportSummary.

Return type

str

property mime_type

Gets the mime_type of this ReportSummary. 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 ReportSummary.

Return type

str

property report_definition_id

Gets the report_definition_id of this ReportSummary. The OCID of the report definition.

Returns

The report_definition_id of this ReportSummary.

Return type

str

property time_created

Gets the time_created of this ReportSummary. Specifies the time at which the report was created.

Returns

The time_created of this ReportSummary.

Return type

datetime

property time_generated

[Required] Gets the time_generated of this ReportSummary. Specifies the time at which the report was generated.

Returns

The time_generated of this ReportSummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this ReportSummary.

Return type

datetime

property type

Gets the type of this ReportSummary. The type of the 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 ReportSummary.

Return type

str