Version: 8.10 (unreleased)

Key Types

Technical Preview

The C# SDK is a technical preview available from Camunda 8.9. It will become fully supported in Camunda 8.10. Its API surface may change in future releases without following semver.

Strongly-typed domain key types provide compile-time safety for entity identifiers. Each key wraps a string value and ensures type-safe API calls.

Overview

Key Type	Description
`AgentInstanceKey`	System-generated key for an agent instance.
`AuditLogEntityKey`	System-generated entity key for an audit log entry.
`AuditLogKey`	System-generated key for an audit log entry.
`AuthorizationKey`	System-generated key for an authorization.
`BatchOperationKey`	System-generated key for an batch operation.
`ConditionalEvaluationKey`	System-generated key for a conditional evaluation.
`DecisionDefinitionKey`	System-generated key for a decision definition.
`DecisionEvaluationInstanceKey`	System-generated identifier for a decision evaluation instance. It is composed of the

Common Methods

All key types share these methods:

Method	Description
`AssumeExists(string)`	Creates a key from a known-valid string value.
`IsValid(string)`	Validates whether a string is a valid key value.
`Value`	Gets the underlying string value.
`ToString()`	Returns the string representation.

Details

AgentInstanceKey

System-generated key for an agent instance.

public readonly record struct AgentInstanceKey : ICamundaKey, IEquatable<AgentInstanceKey>

AuditLogEntityKey

System-generated entity key for an audit log entry.

public readonly record struct AuditLogEntityKey : ICamundaKey, IEquatable<AuditLogEntityKey>

AuditLogKey

System-generated key for an audit log entry.

public readonly record struct AuditLogKey : ICamundaKey, IEquatable<AuditLogKey>

AuthorizationKey

System-generated key for an authorization.

public readonly record struct AuthorizationKey : ICamundaKey, IEquatable<AuthorizationKey>

BatchOperationKey

System-generated key for an batch operation.

public readonly record struct BatchOperationKey : ICamundaKey, IEquatable<BatchOperationKey>

ConditionalEvaluationKey

System-generated key for a conditional evaluation.

public readonly record struct ConditionalEvaluationKey : ICamundaKey, IEquatable<ConditionalEvaluationKey>

DecisionDefinitionKey

System-generated key for a decision definition.

public readonly record struct DecisionDefinitionKey : ICamundaKey, IEquatable<DecisionDefinitionKey>

DecisionEvaluationInstanceKey

System-generated identifier for a decision evaluation instance. It is composed of the parent decision evaluation key and the 1-based index of the evaluated decision within that evaluation, joined by a hyphen (format: -).

public readonly record struct DecisionEvaluationInstanceKey : ICamundaKey, IEquatable<DecisionEvaluationInstanceKey>

DecisionEvaluationKey

System-generated key for a decision evaluation.

public readonly record struct DecisionEvaluationKey : ICamundaKey, IEquatable<DecisionEvaluationKey>

DecisionInstanceKey

System-generated key for a deployed decision instance.

public readonly record struct DecisionInstanceKey : ICamundaKey, IEquatable<DecisionInstanceKey>

DecisionRequirementsKey

System-generated key for a deployed decision requirements definition.

public readonly record struct DecisionRequirementsKey : ICamundaKey, IEquatable<DecisionRequirementsKey>

DeploymentKey

Key for a deployment.

public readonly record struct DeploymentKey : ICamundaKey, IEquatable<DeploymentKey>

ElementInstanceKey

System-generated key for a element instance.

public readonly record struct ElementInstanceKey : ICamundaKey, IEquatable<ElementInstanceKey>

FormKey

System-generated key for a deployed form.

public readonly record struct FormKey : ICamundaKey, IEquatable<FormKey>

IncidentKey

System-generated key for a incident.

public readonly record struct IncidentKey : ICamundaKey, IEquatable<IncidentKey>

JobKey

System-generated key for a job.

public readonly record struct JobKey : ICamundaKey, IEquatable<JobKey>

LongKey

Zeebe Engine resource key (Java long serialized as string)

public readonly record struct LongKey : ICamundaKey, IEquatable<LongKey>

MessageKey

System-generated key for an message.

public readonly record struct MessageKey : ICamundaKey, IEquatable<MessageKey>

MessageSubscriptionKey

System-generated key for a message subscription.

public readonly record struct MessageSubscriptionKey : ICamundaKey, IEquatable<MessageSubscriptionKey>

ProcessDefinitionKey

System-generated key for a deployed process definition.

public readonly record struct ProcessDefinitionKey : ICamundaKey, IEquatable<ProcessDefinitionKey>

ProcessInstanceKey

System-generated key for a process instance.

public readonly record struct ProcessInstanceKey : ICamundaKey, IEquatable<ProcessInstanceKey>

ResourceKey

The system-assigned key for this resource.

public readonly record struct ResourceKey : ICamundaKey, IEquatable<ResourceKey>

ScopeKey

System-generated key for a scope. A scope can hold variables and represents either an element instance in a BPMN process or the process instance itself.

public readonly record struct ScopeKey : ICamundaKey, IEquatable<ScopeKey>

SignalKey

System-generated key for an signal.

public readonly record struct SignalKey : ICamundaKey, IEquatable<SignalKey>

UserTaskKey

System-generated key for a user task.

public readonly record struct UserTaskKey : ICamundaKey, IEquatable<UserTaskKey>

VariableKey

System-generated key for a variable.

public readonly record struct VariableKey : ICamundaKey, IEquatable<VariableKey>

Overview​

Common Methods​

Details​

AgentInstanceKey​

AuditLogEntityKey​

AuditLogKey​

AuthorizationKey​

BatchOperationKey​

ConditionalEvaluationKey​

DecisionDefinitionKey​

DecisionEvaluationInstanceKey​

DecisionEvaluationKey​

DecisionInstanceKey​

DecisionRequirementsKey​

DeploymentKey​

ElementInstanceKey​

FormKey​

IncidentKey​

JobKey​

LongKey​

MessageKey​

MessageSubscriptionKey​

ProcessDefinitionKey​

ProcessInstanceKey​

ResourceKey​

ScopeKey​

SignalKey​

UserTaskKey​

VariableKey​