RetentionDescription Class
Properties to configure retention settings for the eventhub.
- Inheritance
-
azure.mgmt.eventhub._serialization.ModelRetentionDescription
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
|
Enumerates the possible values for cleanup policy. Known values are: "Delete" and "Compaction". |
retention_time_in_hours
|
Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compaction the returned value of this property is Long.MaxValue. |
tombstone_retention_time_in_hours
|
Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compaction. 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
|
Enumerates the possible values for cleanup policy. Known values are: "Delete" and "Compaction". |
retention_time_in_hours
|
Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compaction the returned value of this property is Long.MaxValue. |
tombstone_retention_time_in_hours
|
Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compaction. 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. |
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for