Share via

CaptureDescription Class

  • Reference

Properties to configure capture description for eventhub.

Inheritance
azure.mgmt.eventhub._serialization.Model
CaptureDescription

Constructor

CaptureDescription(*, enabled: bool | None = None, encoding: str | _models.EncodingCaptureDescription | None = None, interval_in_seconds: int | None = None, size_limit_in_bytes: int | None = None, destination: _models.Destination | None = None, skip_empty_archives: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
enabled
bool

A value that indicates whether capture description is enabled.
encoding
str or 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
Destination

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

A value that indicates whether to Skip Empty Archives.

Variables

Name Description
enabled
bool

A value that indicates whether capture description is enabled.
encoding
str or 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
Destination

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

A value that indicates whether to Skip Empty Archives.