Class CloudEventVersion
- Namespace
- Excalibur.Dispatch.CloudEvents
- Assembly
- Excalibur.Dispatch.dll
Provides versioning support for CloudEvents to handle schema evolution.
public static class CloudEventVersion
- Inheritance
-
CloudEventVersion
- Inherited Members
Fields
SchemaCompatibilityAttribute
Extension attribute name for schema compatibility mode.
public const string SchemaCompatibilityAttribute = "schemacompatibility"
Field Value
SchemaVersionAttribute
Extension attribute name for schema version.
public const string SchemaVersionAttribute = "schemaversion"
Field Value
SpecVersion
The current CloudEvents specification version supported.
public const string SpecVersion = "1.0"
Field Value
Methods
CreateVersioned(string, string, object, string, SchemaCompatibilityMode)
Creates a version-aware CloudEvent.
public static CloudEvent CreateVersioned(string source, string type, object data, string schemaVersion, SchemaCompatibilityMode compatibility = SchemaCompatibilityMode.None)
Parameters
sourcestringtypestringdataobjectschemaVersionstringcompatibilitySchemaCompatibilityMode
Returns
GetSchemaCompatibility(CloudEvent)
Gets the schema compatibility mode from a CloudEvent.
public static SchemaCompatibilityMode GetSchemaCompatibility(this CloudEvent cloudEvent)
Parameters
cloudEventCloudEvent
Returns
GetSchemaVersion(CloudEvent)
Gets the schema version from a CloudEvent.
public static string? GetSchemaVersion(this CloudEvent cloudEvent)
Parameters
cloudEventCloudEvent
Returns
IsCompatibleWith(CloudEvent, string, ISchemaRegistry?)
Checks if a CloudEvent is compatible with a specific schema version.
public static bool IsCompatibleWith(this CloudEvent cloudEvent, string targetVersion, ISchemaRegistry? registry = null)
Parameters
cloudEventCloudEventtargetVersionstringregistryISchemaRegistry
Returns
SetSchemaCompatibility(CloudEvent, SchemaCompatibilityMode)
Sets the schema compatibility mode on a CloudEvent.
public static void SetSchemaCompatibility(this CloudEvent cloudEvent, SchemaCompatibilityMode mode)
Parameters
cloudEventCloudEventmodeSchemaCompatibilityMode
SetSchemaVersion(CloudEvent, string)
Sets the schema version on a CloudEvent.
public static void SetSchemaVersion(this CloudEvent cloudEvent, string version)
Parameters
cloudEventCloudEventversionstring