Share via

RetentionDescription Class

  • Reference

Properties to configure retention settings for the eventhub.

Inheritance
azure.mgmt.eventhub._serialization.Model
RetentionDescription

Constructor

RetentionDescription(*, cleanup_policy: str | _models.CleanupPolicyRetentionDescription | None = None, retention_time_in_hours: int | None = None, tombstone_retention_time_in_hours: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
cleanup_policy
str or CleanupPolicyRetentionDescription

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

Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue.
tombstone_retention_time_in_hours
int

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. 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.

Variables

Name Description
cleanup_policy
str or CleanupPolicyRetentionDescription

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

Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue.
tombstone_retention_time_in_hours
int

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. 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.