CaptureDescription Class

Properties to configure capture description for eventhub.

Constructor

CaptureDescription()

Variables

Name Description
enabled

A value that indicates whether capture description is enabled.

encoding
Union[str, <xref:"EncodingCaptureDescription">]

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

interval_in_seconds
int

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.

size_limit_in_bytes
int

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.

destination
<xref:<xref:"Destination">>

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

skip_empty_archives

A value that indicates whether to Skip Empty Archives.

Attributes

destination

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

destination: Destination

enabled

A value that indicates whether capture description is enabled.

enabled: bool

encoding

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

encoding: str | EncodingCaptureDescription

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.

intervalInSeconds: int

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.

sizeLimitInBytes: int

skipEmptyArchives

A value that indicates whether to Skip Empty Archives.

skipEmptyArchives: bool