RetentionDescription Class

Definition

Properties to configure retention settings for the eventhub.

public class RetentionDescription : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.EventHubs.Models.RetentionDescription>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.EventHubs.Models.RetentionDescription>
type RetentionDescription = class
    interface IJsonModel<RetentionDescription>
    interface IPersistableModel<RetentionDescription>
Public Class RetentionDescription
Implements IJsonModel(Of RetentionDescription), IPersistableModel(Of RetentionDescription)
Inheritance
RetentionDescription
Implements

Constructors

RetentionDescription()

Initializes a new instance of RetentionDescription.

Properties

CleanupPolicy

Enumerates the possible values for cleanup policy.

RetentionTimeInHours

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.

TombstoneRetentionTimeInHours

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.

Explicit Interface Implementations

IJsonModel<RetentionDescription>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<RetentionDescription>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<RetentionDescription>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RetentionDescription>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<RetentionDescription>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to