Class ComplianceDocumentSummary

A summary representation of the compliance document.

Inheritance

object

ComplianceDocumentSummary

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 ComplianceDocumentSummary

Properties

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

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

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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.

Id

Declaration

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

Property Value

Type	Description
string	A unique identifier for the document that 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 environment, also known as platform or business pillar, to which the compliance document belongs.

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.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	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"}}

TimeCreated

Declaration

[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.

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.

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