IRetentionDescription Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.RetentionDescriptionTypeConverter))]
public interface IRetentionDescription : Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.IJsonSerializable[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.RetentionDescriptionTypeConverter))>]
type IRetentionDescription = interface
interface IJsonSerializablePublic Interface IRetentionDescription
Implements IJsonSerializable- Derived
- Attributes
- Implements
Properties
| CleanupPolicy |
Enumerates the possible values for cleanup policy |
| MinCompactionLagInMin |
The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. |
| RetentionTimeInHour |
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. |
| TombstoneRetentionTimeInHour |
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 |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |