Share via


CaptureDescription Class

Definition

Properties to configure capture description for eventhub.

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

Constructors

CaptureDescription()

Initializes a new instance of CaptureDescription.

Properties

Destination

Properties of Destination where capture will be stored. (Storage Account, Blob Names).

Enabled

A value that indicates whether capture description is enabled.

Encoding

Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version.

IntervalInSeconds

The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds.

SizeLimitInBytes

The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.

SkipEmptyArchives

A value that indicates whether to Skip Empty Archives.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CaptureDescription>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CaptureDescription>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CaptureDescription>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CaptureDescription>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CaptureDescription>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to