RetentionDescription Class

Properties to configure retention settings for the eventhub.

Constructor

RetentionDescription(*args: Any, **kwargs: Any)

Variables

Name Description
cleanup_policy
str or CleanupPolicyRetentionDescription

Enumerates the possible values for cleanup policy. Known values are: "Delete", "Compact", and "DeleteOrCompact".
retention_time_in_hours
int

Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type.
min_compaction_lag_time_in_minutes
int

The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.
tombstone_retention_time_in_hours
int

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub.

Attributes

cleanup_policy

"Delete", "Compact", and "DeleteOrCompact".

cleanup_policy: str | _models.CleanupPolicyRetentionDescription | None

min_compaction_lag_time_in_minutes

The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact.

min_compaction_lag_time_in_minutes: int | None

retention_time_in_hours

Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type.

retention_time_in_hours: int | None

tombstone_retention_time_in_hours

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub.

tombstone_retention_time_in_hours: int | None