Class GovernanceMetadataClassificationResult

Namespace

AsiBackbone.Core.Metadata

Assembly

AsiBackbone.Core.dll

Represents the provider-neutral classification result for one governance metadata entry.

public sealed class GovernanceMetadataClassificationResult

Inheritance

object

GovernanceMetadataClassificationResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Fields

DefaultRedactedValue

Gets the default replacement value used by Redact(string, string, string).

public const string DefaultRedactedValue = "[REDACTED]"

Field Value

string

Properties

Action

Gets the action requested by the classifier.

public GovernanceMetadataSanitizationAction Action { get; }

Property Value

GovernanceMetadataSanitizationAction

Reason

Gets the stable machine-readable reason associated with a non-allow action.

public OperationReason? Reason { get; }

Property Value

OperationReason

ReplacementValue

Gets the safe replacement value used when Action is Redact.

public string? ReplacementValue { get; }

Property Value

string

Methods

Allow()

Creates an allow result.

public static GovernanceMetadataClassificationResult Allow()

Returns

GovernanceMetadataClassificationResult

An allow classification result.

Deny(string, string)

Creates a deny result that prevents the metadata collection from continuing.

public static GovernanceMetadataClassificationResult Deny(string reasonCode, string reasonMessage)

Parameters

reasonCode string

The stable machine-readable denial code.

reasonMessage string

The curated denial message.

Returns

GovernanceMetadataClassificationResult

A denial classification result.

Drop(string, string)

Creates a drop result that removes the metadata entry.

public static GovernanceMetadataClassificationResult Drop(string reasonCode, string reasonMessage)

Parameters

reasonCode string

The stable machine-readable drop code.

reasonMessage string

The curated drop message.

Returns

GovernanceMetadataClassificationResult

A drop classification result.

Redact(string, string, string)

Creates a redaction result with a safe replacement value.

public static GovernanceMetadataClassificationResult Redact(string reasonCode, string reasonMessage, string replacementValue = "[REDACTED]")

Parameters

reasonCode string

The stable machine-readable redaction code.

reasonMessage string

The curated redaction message.

replacementValue string

The safe value that replaces the classified value.

Returns

GovernanceMetadataClassificationResult

A redaction classification result.

Warn(string, string)

Creates a warning result that permits the original value to continue.

public static GovernanceMetadataClassificationResult Warn(string reasonCode, string reasonMessage)

Parameters

reasonCode string

The stable machine-readable warning code.

reasonMessage string

The curated warning message.

Returns

GovernanceMetadataClassificationResult

A warning classification result.