ComplianceDocumentSummary¶
- class oci.cloud_guard.models.ComplianceDocumentSummary(**kwargs)¶
Bases:
objectA summary representation of the compliance document.
Methods:
__init__(**kwargs)Initializes a new ComplianceDocumentSummary object with values from keyword arguments.
Attributes:
Gets the defined_tags of this ComplianceDocumentSummary.
[Required] Gets the document_file_name of this ComplianceDocumentSummary.
Gets the freeform_tags of this ComplianceDocumentSummary.
[Required] Gets the id of this ComplianceDocumentSummary.
[Required] Gets the lifecycle_state of this ComplianceDocumentSummary.
[Required] Gets the name of this ComplianceDocumentSummary.
[Required] Gets the platform of this ComplianceDocumentSummary.
Gets the saas_service_name of this ComplianceDocumentSummary.
Gets the system_tags of this ComplianceDocumentSummary.
Gets the time_created of this ComplianceDocumentSummary.
[Required] Gets the time_updated of this ComplianceDocumentSummary.
[Required] Gets the type of this ComplianceDocumentSummary.
[Required] Gets the version of this ComplianceDocumentSummary.
- __init__(**kwargs)¶
Initializes a new ComplianceDocumentSummary 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 ComplianceDocumentSummary.
name (str) – The value to assign to the name property of this ComplianceDocumentSummary.
time_created (datetime) – The value to assign to the time_created property of this ComplianceDocumentSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ComplianceDocumentSummary.
document_file_name (str) – The value to assign to the document_file_name property of this ComplianceDocumentSummary.
version (int) – The value to assign to the version property of this ComplianceDocumentSummary.
type (str) – The value to assign to the type property of this ComplianceDocumentSummary.
platform (str) – The value to assign to the platform property of this ComplianceDocumentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ComplianceDocumentSummary.
saas_service_name (str) – The value to assign to the saas_service_name property of this ComplianceDocumentSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ComplianceDocumentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ComplianceDocumentSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ComplianceDocumentSummary.
- property defined_tags¶
Gets the defined_tags of this ComplianceDocumentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this ComplianceDocumentSummary.
- Return type
dict(str, dict(str, object))
- property document_file_name¶
[Required] Gets the document_file_name of this ComplianceDocumentSummary. The file name of the compliance document.
- Returns
The document_file_name of this ComplianceDocumentSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ComplianceDocumentSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
Avoid entering confidential information.
- Returns
The freeform_tags of this ComplianceDocumentSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ComplianceDocumentSummary. A unique identifier for the document that is assigned when you create the document as an Oracle Cloud Infrastructure resource and is immutable.
- Returns
The id of this ComplianceDocumentSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ComplianceDocumentSummary. The current lifecycle state of the compliance document.
- Returns
The lifecycle_state of this ComplianceDocumentSummary.
- Return type
str
- property name¶
[Required] Gets the name of this ComplianceDocumentSummary. A friendly name or title for the compliance document. You cannot update this value later. Avoid entering confidential information.
- Returns
The name of this ComplianceDocumentSummary.
- Return type
str
- property platform¶
[Required] Gets the platform of this ComplianceDocumentSummary. The environment, also known as platform or business pillar, to which the compliance document belongs.
- Returns
The platform of this ComplianceDocumentSummary.
- Return type
str
- property saas_service_name¶
Gets the saas_service_name of this ComplianceDocumentSummary. The saas service name to which compliance document belongs.
- Returns
The saas_service_name of this ComplianceDocumentSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this ComplianceDocumentSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this ComplianceDocumentSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this ComplianceDocumentSummary. The date and time the compliance document was created, expressed in RFC 3339 timestamp format.
- Returns
The time_created of this ComplianceDocumentSummary.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this ComplianceDocumentSummary. The date and time the compliance document was last updated, expressed in RFC 3339 timestamp format.
- Returns
The time_updated of this ComplianceDocumentSummary.
- Return type
datetime
- property type¶
[Required] Gets the type of this ComplianceDocumentSummary. The type of compliance document.
- Returns
The type of this ComplianceDocumentSummary.
- Return type
str
- property version¶
[Required] Gets the version of this ComplianceDocumentSummary. The version number of the compliance document.
- Returns
The version of this ComplianceDocumentSummary.
- Return type
int