Skip to content
Documentation

ICompressionSettings Interface

Defines settings that control HTTP request decompression and response compression for the service.

public interface ICompressionSettings

Use TryRead(IConfigurationSection) to create an instance from an Microsoft.Extensions.Configuration.IConfigurationSection or use Defaults for a configuration where both compression and decompression are disabled.

Gets the default compression settings with both request decompression and response compression disabled.

static HAKOM.Http.Core.Net.Api.ICompressionSettings Defaults { get; }

ICompressionSettings

ICompressionSettings.EnableRequestDecompression Property

Section titled “ICompressionSettings.EnableRequestDecompression Property”

Gets a value indicating whether incoming request bodies should be automatically decompressed.

bool EnableRequestDecompression { get; }

System.Boolean

ICompressionSettings.EnableResponseCompression Property

Section titled “ICompressionSettings.EnableResponseCompression Property”

Gets a value indicating whether outgoing response bodies should be automatically compressed.

bool EnableResponseCompression { get; }

System.Boolean

The configuration key under which compression settings are expected.

static string Key { get; }

System.String

ICompressionSettings.TryRead(IConfigurationSection) Method

Section titled “ICompressionSettings.TryRead(IConfigurationSection) Method”

Attempts to read compression settings from the specified configuration section.

static HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.Http.Core.Net.Api.ICompressionSettings> TryRead(Microsoft.Extensions.Configuration.IConfigurationSection compressionSettings);

compressionSettings Microsoft.Extensions.Configuration.IConfigurationSection

The Microsoft.Extensions.Configuration.IConfigurationSection to read from.

HAKOM.ErrorHandling.Core.Net.Api.Result<ICompressionSettings>
A Result<TValue> containing the parsed ICompressionSettings.

© 2026 Volue.Version v0.6.38017 November 2026