ComplianceDocument

class oci.cloud_guard.models.ComplianceDocument(**kwargs)

Bases: object

A compliance document that exists in the tenancy.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_INACTIVE

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

document_file_name

[Required] Gets the document_file_name of this ComplianceDocument.

id

[Required] Gets the id of this ComplianceDocument.

lifecycle_state

[Required] Gets the lifecycle_state of this ComplianceDocument.

name

[Required] Gets the name of this ComplianceDocument.

platform

[Required] Gets the platform of this ComplianceDocument.

saas_service_name

Gets the saas_service_name of this ComplianceDocument.

time_created

[Required] Gets the time_created of this ComplianceDocument.

time_updated

[Required] Gets the time_updated of this ComplianceDocument.

type

[Required] Gets the type of this ComplianceDocument.

version

[Required] Gets the version of this ComplianceDocument.

Methods:

__init__(**kwargs)

Initializes a new ComplianceDocument object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

__init__(**kwargs)

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

  • name (str) – The value to assign to the name property of this ComplianceDocument.

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ComplianceDocument. Allowed values for this property are: “ACTIVE”, “INACTIVE”

  • document_file_name (str) – The value to assign to the document_file_name property of this ComplianceDocument.

  • version (int) – The value to assign to the version property of this ComplianceDocument.

  • type (str) – The value to assign to the type property of this ComplianceDocument.

  • platform (str) – The value to assign to the platform property of this ComplianceDocument.

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

  • saas_service_name (str) – The value to assign to the saas_service_name property of this ComplianceDocument.

property document_file_name

[Required] Gets the document_file_name of this ComplianceDocument. The file name of the compliance document.

Returns

The document_file_name of this ComplianceDocument.

Return type

str

property id

[Required] Gets the id of this ComplianceDocument. The OCID of the compliance document, which is assigned when you create the document as an Oracle Cloud Infrastructure resource and is immutable.

Returns

The id of this ComplianceDocument.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this ComplianceDocument. The current lifecycle state of the compliance document.

Allowed values for this property are: “ACTIVE”, “INACTIVE”

Returns

The lifecycle_state of this ComplianceDocument.

Return type

str

property name

[Required] Gets the name of this ComplianceDocument. A friendly name or title for the compliance document. You cannot update this value later. Avoid entering confidential information.

Returns

The name of this ComplianceDocument.

Return type

str

property platform

[Required] Gets the platform of this ComplianceDocument. The information technology infrastructure platform, or set of services, to which the compliance document belongs. A platform can also be described as an environment or a business pillar. For definitions of supported environments, see Types of Environments.

Returns

The platform of this ComplianceDocument.

Return type

str

property saas_service_name

Gets the saas_service_name of this ComplianceDocument. The saas service name to which compliance document belongs. For other types such as ‘OCI’ / ‘PaaS’ this value will be null.

Returns

The saas_service_name of this ComplianceDocument.

Return type

str

property time_created

[Required] Gets the time_created of this ComplianceDocument. The date and time the compliance document was created, expressed in RFC 3339 timestamp format.

Returns

The time_created of this ComplianceDocument.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this ComplianceDocument. The date and time the compliance document was last updated, expressed in RFC 3339 timestamp format.

Returns

The time_updated of this ComplianceDocument.

Return type

datetime

property type

[Required] Gets the type of this ComplianceDocument. The type of compliance document. For definitions of supported types of compliance documents, see Types of Compliance Documents.

Returns

The type of this ComplianceDocument.

Return type

str

property version

[Required] Gets the version of this ComplianceDocument. The version number of the compliance document.

Returns

The version of this ComplianceDocument.

Return type

int