Share via


IRetentionDescription Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.RetentionDescriptionTypeConverter))]
public interface IRetentionDescription : Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.IJsonSerializable
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.RetentionDescriptionTypeConverter))>]
type IRetentionDescription = interface
    interface IJsonSerializable
Public Interface IRetentionDescription
Implements IJsonSerializable
Derived
Attributes
Implements

Properties

CleanupPolicy

Enumerates the possible values for cleanup policy

RetentionTimeInHour

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

TombstoneRetentionTimeInHour

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

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to