Class RuleSummary

A list of rule resources. One or more rules can be defined for a data entity. Each rule can be defined on one or more attributes of the data entity.

Inheritance

object

RuleSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Models

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class RuleSummary

Properties

Attributes

Declaration

[JsonProperty(PropertyName = "attributes")]
public List<RuleAttribute> Attributes { get; set; }

Property Value

Type	Description
List<RuleAttribute>	Attributes associated with a rule. A UNIQUEKEY rule would contain (at least) one attribute, for the local table column(s) on which uniqueness is defined.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Detailed description of a rule.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExternalKey

Declaration

[JsonProperty(PropertyName = "externalKey")]
public string ExternalKey { get; set; }

Property Value

Type	Description
string	External URI that can be used to reference the object. Format will differ based on the type of object.

Key

Declaration

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

Property Value

Type	Description
string	Immutable unique key of a rule.

Remarks

Required

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	State of the rule.

OriginType

Declaration

[JsonProperty(PropertyName = "originType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public RuleOriginType? OriginType { get; set; }

Property Value

Type	Description
RuleOriginType?	Origin type of the rule.

ReferencedAttributes

Declaration

[JsonProperty(PropertyName = "referencedAttributes")]
public List<RuleAttribute> ReferencedAttributes { get; set; }

Property Value

Type	Description
List<RuleAttribute>	Attributes associated with referenced rule, applicable only when rule type is FOREIGNKEY. A FOREIGNKEY rule would contain (at least) one attribute, for the local table column(s), and (at least) one referencedAttribute for referenced table column(s).

ReferencedEntityKey

Declaration

[JsonProperty(PropertyName = "referencedEntityKey")]
public string ReferencedEntityKey { get; set; }

Property Value

Type	Description
string	Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

ReferencedEntityName

Declaration

[JsonProperty(PropertyName = "referencedEntityName")]
public string ReferencedEntityName { get; set; }

Property Value

Type	Description
string	Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

ReferencedFolderKey

Declaration

[JsonProperty(PropertyName = "referencedFolderKey")]
public string ReferencedFolderKey { get; set; }

Property Value

Type	Description
string	Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.

ReferencedFolderName

Declaration

[JsonProperty(PropertyName = "referencedFolderName")]
public string ReferencedFolderName { get; set; }

Property Value

Type	Description
string	Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.

ReferencedRuleKey

Declaration

[JsonProperty(PropertyName = "referencedRuleKey")]
public string ReferencedRuleKey { get; set; }

Property Value

Type	Description
string	Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

ReferencedRuleName

Declaration

[JsonProperty(PropertyName = "referencedRuleName")]
public string ReferencedRuleName { get; set; }

Property Value

Type	Description
string	Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

RuleType

Declaration

[JsonProperty(PropertyName = "ruleType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public RuleType? RuleType { get; set; }

Property Value

Type	Description
RuleType?	Type of a rule.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the rule was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Uri

Declaration

[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }

Property Value

Type	Description
string	URI to the rule instance in the API.