Show / Hide Table of Contents

Class ComplianceDocument

A compliance document that exists in the tenancy.

Inheritance
object
ComplianceDocument
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CloudguardService.Models
Assembly: OCI.DotNetSDK.Cloudguard.dll
Syntax
public class ComplianceDocument

Properties

DocumentFileName

Declaration
[Required(ErrorMessage = "DocumentFileName is required.")]
[JsonProperty(PropertyName = "documentFileName")]
public string DocumentFileName { get; set; }
Property Value
Type Description
string

The file name of the compliance document.

Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the compliance document, which is assigned when you create the document as an Oracle Cloud Infrastructure resource and is immutable.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public ComplianceDocument.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
ComplianceDocument.LifecycleStateEnum?

The current lifecycle state of the compliance document.

Remarks

Required

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

A friendly name or title for the compliance document. You cannot update this value later. Avoid entering confidential information.

Remarks

Required

Platform

Declaration
[Required(ErrorMessage = "Platform is required.")]
[JsonProperty(PropertyName = "platform")]
public string Platform { get; set; }
Property Value
Type Description
string

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.

Remarks

Required

SaasServiceName

Declaration
[JsonProperty(PropertyName = "saasServiceName")]
public string SaasServiceName { get; set; }
Property Value
Type Description
string

The saas service name to which compliance document belongs. For other types such as 'OCI' / 'PaaS' this value will be null.

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the compliance document was created, expressed in RFC 3339 timestamp format.

Remarks

Required

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the compliance document was last updated, expressed in RFC 3339 timestamp format.

Remarks

Required

Type

Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
public string Type { get; set; }
Property Value
Type Description
string

The type of compliance document. For definitions of supported types of compliance documents, see Types of Compliance Documents.

Remarks

Required

Version

Declaration
[Required(ErrorMessage = "Version is required.")]
[JsonProperty(PropertyName = "version")]
public int? Version { get; set; }
Property Value
Type Description
int?

The version number of the compliance document.

Remarks

Required

In this article
Back to top