Class CloudEventOptions
- Namespace
- Excalibur.Dispatch.Options.CloudEvents
- Assembly
- Excalibur.Dispatch.dll
Configuration options for CloudEvents support in Excalibur.Dispatch.
public sealed class CloudEventOptions
- Inheritance
-
CloudEventOptions
- Inherited Members
- Extension Methods
Remarks
Provides configuration for CloudEvents serialization modes, attribute mappings, and envelope property preservation according to DoD requirements for envelope integrity.
Properties
Compression
Gets or sets the compression configuration for CloudEvents.
public CloudEventCompressionOptions Compression { get; set; }
Property Value
- CloudEventCompressionOptions
The compression configuration options.
DefaultMode
Gets or sets the default CloudEvents Mode when not explicitly specified.
public CloudEventMode DefaultMode { get; set; }
Property Value
- CloudEventMode
The current DefaultMode value.
Remarks
Provides a fallback Mode for CloudEvent serialization. Can be overridden per operation.
DefaultSource
Gets or sets the default source URI for generated CloudEvents.
[Required]
public Uri DefaultSource { get; set; }
Property Value
- Uri
The default source URI for generated CloudEvents.
Remarks
Used when message context doesn't specify a source. Should be a valid URI identifying the event producer.
DispatchExtensionPrefix
Gets or sets the prefix for Dispatch-specific CloudEvent extension attributes.
[Required]
public string DispatchExtensionPrefix { get; set; }
Property Value
- string
The current DispatchExtensionPrefix value.
Remarks
Used to namespace Excalibur.Dispatch envelope properties as CloudEvent extensions to avoid Tests.CloudProviders.
ExcludedExtensions
Gets the set of extension attributes to exclude from CloudEvents.
public HashSet<string> ExcludedExtensions { get; }
Property Value
- HashSet<string>
The current ExcludedExtensions value.
Remarks
Extensions listed here will not be copied from message context to CloudEvent attributes.
Mode
Gets or sets the CloudEvents Mode for message serialization.
public CloudEventMode Mode { get; set; }
Property Value
- CloudEventMode
The current Mode value.
Remarks
Structured Mode uses application/cloudevents+json content type. Binary Mode maps CE attributes to transport-specific headers/attributes.
Schema
Gets or sets the schema configuration for CloudEvents.
public CloudEventSchemaOptions Schema { get; set; }
Property Value
- CloudEventSchemaOptions
The schema configuration options.
SpecVersion
Gets or sets the CloudEvents specification version to use.
public CloudEventsSpecVersion SpecVersion { get; set; }
Property Value
- CloudEventsSpecVersion
The current SpecVersion value.