Class LiabilityHandshakeRequest

Namespace

AsiBackbone.Core.Handshakes

Assembly

AsiBackbone.Core.dll

Represents a framework-neutral liability or responsibility handshake request before consequential execution.

public sealed class LiabilityHandshakeRequest

Inheritance

object

LiabilityHandshakeRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ActorDisplayName

Gets the optional display name or label associated with the actor.

public string? ActorDisplayName { get; }

Property Value

string

ActorId

Gets the stable actor identifier associated with the handshake.

public string ActorId { get; }

Property Value

string

ActorType

Gets the actor type associated with the handshake.

public AsiBackboneActorType ActorType { get; }

Property Value

AsiBackboneActorType

CorrelationId

Gets the correlation identifier associated with the handshake, when supplied by the host.

public string? CorrelationId { get; }

Property Value

string

HandshakeId

Gets the stable handshake identifier.

public string HandshakeId { get; }

Property Value

string

HasMetadata

Gets a value indicating whether this handshake contains metadata.

public bool HasMetadata { get; }

Property Value

bool

Message

Gets the human-readable message explaining why the handshake is required.

public string Message { get; }

Property Value

string

Metadata

Gets additional framework-neutral handshake metadata supplied by the host.

public IReadOnlyDictionary<string, string> Metadata { get; }

Property Value

IReadOnlyDictionary<string, string>

OperationName

Gets the operation name requiring acknowledgment.

public string OperationName { get; }

Property Value

string

PolicyHash

Gets the policy hash associated with the handshake, when supplied by the host.

public string? PolicyHash { get; }

Property Value

string

PolicyVersion

Gets the policy version associated with the handshake, when supplied by the host.

public string? PolicyVersion { get; }

Property Value

string

ReasonCode

Gets the machine-readable reason code explaining why the handshake is required.

public string ReasonCode { get; }

Property Value

string

RequiredAcknowledgmentCode

Gets the required acknowledgment code the host may display or require before execution.

public string RequiredAcknowledgmentCode { get; }

Property Value

string

RequiredAcknowledgmentText

Gets the required acknowledgment text the host may display before execution.

public string RequiredAcknowledgmentText { get; }

Property Value

string

RiskCategory

Gets the optional host-defined risk category associated with the handshake.

public string? RiskCategory { get; }

Property Value

string

RiskLevel

Gets the risk level associated with the handshake.

public LiabilityHandshakeRiskLevel RiskLevel { get; }

Property Value

LiabilityHandshakeRiskLevel

SchemaVersion

Gets the schema version for the serialized handshake request shape.

public string SchemaVersion { get; }

Property Value

string

TraceId

Gets the trace identifier associated with the handshake, when supplied by the host.

public string? TraceId { get; }

Property Value

string

Methods

Create(IAsiBackboneActorContext, string, string, string, string, string, LiabilityHandshakeRiskLevel, string?, string?, string?, string?, string?, string?, IReadOnlyDictionary<string, string>?, string?)

Creates a liability or responsibility handshake request.

public static LiabilityHandshakeRequest Create(IAsiBackboneActorContext actor, string operationName, string reasonCode, string message, string requiredAcknowledgmentCode, string requiredAcknowledgmentText, LiabilityHandshakeRiskLevel riskLevel = LiabilityHandshakeRiskLevel.Unspecified, string? riskCategory = null, string? handshakeId = null, string? correlationId = null, string? traceId = null, string? policyVersion = null, string? policyHash = null, IReadOnlyDictionary<string, string>? metadata = null, string? schemaVersion = null)

Parameters

actor IAsiBackboneActorContext

The actor associated with the handshake.

operationName string

The operation name requiring acknowledgment.

reasonCode string

The machine-readable reason code.

message string

The human-readable reason message.

requiredAcknowledgmentCode string

The required acknowledgment code.

requiredAcknowledgmentText string

The required acknowledgment text.

riskLevel LiabilityHandshakeRiskLevel

The risk level associated with the handshake.

riskCategory string

Optional host-defined risk category.

handshakeId string

Optional handshake identifier. When omitted, a new identifier is generated.

correlationId string

Optional correlation identifier.

traceId string

Optional trace identifier.

policyVersion string

Optional policy version.

policyHash string

Optional policy hash.

metadata IReadOnlyDictionary<string, string>

Optional host-provided metadata.

schemaVersion string

Optional schema version for serialized or persisted handshake records.

Returns

LiabilityHandshakeRequest

A liability handshake request.

FromDecision(IAsiBackboneActorContext, string, GovernanceDecision, string, string, LiabilityHandshakeRiskLevel, string?, string?, IReadOnlyDictionary<string, string>?, string?)

Creates a liability or responsibility handshake request from a governance decision.

public static LiabilityHandshakeRequest FromDecision(IAsiBackboneActorContext actor, string operationName, GovernanceDecision decision, string requiredAcknowledgmentCode, string requiredAcknowledgmentText, LiabilityHandshakeRiskLevel riskLevel = LiabilityHandshakeRiskLevel.Unspecified, string? riskCategory = null, string? handshakeId = null, IReadOnlyDictionary<string, string>? metadata = null, string? schemaVersion = null)

Parameters

actor IAsiBackboneActorContext

The actor associated with the handshake.

operationName string

The operation name requiring acknowledgment.

decision GovernanceDecision

The governance decision requiring acknowledgment.

requiredAcknowledgmentCode string

The required acknowledgment code.

requiredAcknowledgmentText string

The required acknowledgment text.

riskLevel LiabilityHandshakeRiskLevel

The risk level associated with the handshake.

riskCategory string

Optional host-defined risk category.

handshakeId string

Optional handshake identifier. When omitted, a new identifier is generated.

metadata IReadOnlyDictionary<string, string>

Optional host-provided metadata.

schemaVersion string

Optional schema version for serialized or persisted handshake records.

Returns

LiabilityHandshakeRequest

A liability handshake request.