cribl-control-plane 0.1.0b1__py3-none-any.whl → 0.1.1rc1__py3-none-any.whl

cribl_control_plane/models/outputcriblhttp.py

@@ -101,7 +101,9 @@ class OutputCriblHTTPTLSSettingsClientSide(BaseModel):
 class OutputCriblHTTPCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the data before sending"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -119,8 +121,11 @@ class OutputCriblHTTPExtraHTTPHeader(BaseModel):
 class OutputCriblHTTPFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
+    # Payload
     PAYLOAD = "payload"
+    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
+    # None
     NONE = "none"
 
 
@@ -181,8 +186,11 @@ class OutputCriblHTTPTimeoutRetrySettings(BaseModel):
 class OutputCriblHTTPBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
@@ -204,22 +212,29 @@ class OutputCriblHTTPURL(BaseModel):
 class OutputCriblHTTPPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputCriblHTTPQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    # Block
     BLOCK = "block"
+    # Drop new data
     DROP = "drop"
 
 
 class OutputCriblHTTPMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
+    # Error
     ERROR = "error"
+    # Backpressure
     BACKPRESSURE = "backpressure"
+    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/outputcribllake.py

@@ -25,46 +25,67 @@ class OutputCriblLakeSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputCriblLakeObjectACL(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Object ACL to assign to uploaded objects"""
 
+    # Private
     PRIVATE = "private"
+    # Public Read Only
     PUBLIC_READ = "public-read"
+    # Public Read/Write
     PUBLIC_READ_WRITE = "public-read-write"
+    # Authenticated Read Only
     AUTHENTICATED_READ = "authenticated-read"
+    # AWS EC2 AMI Read Only
     AWS_EXEC_READ = "aws-exec-read"
+    # Bucket Owner Read Only
     BUCKET_OWNER_READ = "bucket-owner-read"
+    # Bucket Owner Full Control
     BUCKET_OWNER_FULL_CONTROL = "bucket-owner-full-control"
 
 
 class OutputCriblLakeStorageClass(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Storage class to select for uploaded objects"""
 
+    # Standard
     STANDARD = "STANDARD"
+    # Reduced Redundancy Storage
     REDUCED_REDUNDANCY = "REDUCED_REDUNDANCY"
+    # Standard, Infrequent Access
     STANDARD_IA = "STANDARD_IA"
+    # One Zone, Infrequent Access
     ONEZONE_IA = "ONEZONE_IA"
+    # Intelligent Tiering
     INTELLIGENT_TIERING = "INTELLIGENT_TIERING"
+    # Glacier Flexible Retrieval
     GLACIER = "GLACIER"
+    # Glacier Instant Retrieval
     GLACIER_IR = "GLACIER_IR"
+    # Glacier Deep Archive
     DEEP_ARCHIVE = "DEEP_ARCHIVE"
 
 
 class OutputCriblLakeServerSideEncryptionForUploadedObjects(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # Amazon S3 Managed Key
     AES256 = "AES256"
+    # AWS KMS Managed Key
     AWS_KMS = "aws:kms"
 
 
 class OutputCriblLakeBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
 class OutputCriblLakeDiskSpaceProtection(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 

cribl_control_plane/models/outputcribltcp.py

@@ -18,7 +18,9 @@ class OutputCriblTCPType(str, Enum):
 class OutputCriblTCPCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the data before sending"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -108,8 +110,11 @@ class OutputCriblTCPTLSSettingsClientSide(BaseModel):
 class OutputCriblTCPBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
@@ -155,22 +160,29 @@ class OutputCriblTCPHost(BaseModel):
 class OutputCriblTCPPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputCriblTCPQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    # Block
     BLOCK = "block"
+    # Drop new data
     DROP = "drop"
 
 
 class OutputCriblTCPMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
+    # Error
     ERROR = "error"
+    # Backpressure
     BACKPRESSURE = "backpressure"
+    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/outputcrowdstrikenextgensiem.py

@@ -31,8 +31,11 @@ class OutputCrowdstrikeNextGenSiemFailedRequestLoggingMode(
 ):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
+    # Payload
     PAYLOAD = "payload"
+    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
+    # None
     NONE = "none"
 
 
@@ -41,7 +44,9 @@ class OutputCrowdstrikeNextGenSiemRequestFormat(
 ):
     r"""When set to JSON, the event is automatically formatted with required fields before sending. When set to Raw, only the event's `_raw` value is sent."""
 
+    # JSON
     JSON = "JSON"
+    # Raw
     RAW = "raw"
 
 
@@ -113,15 +118,20 @@ class OutputCrowdstrikeNextGenSiemBackpressureBehavior(
 ):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
 class OutputCrowdstrikeNextGenSiemCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -130,15 +140,20 @@ class OutputCrowdstrikeNextGenSiemQueueFullBehavior(
 ):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    # Block
     BLOCK = "block"
+    # Drop new data
     DROP = "drop"
 
 
 class OutputCrowdstrikeNextGenSiemMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
+    # Error
     ERROR = "error"
+    # Backpressure
     BACKPRESSURE = "backpressure"
+    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/outputdatabricks.py

@@ -18,75 +18,47 @@ class OutputDatabricksType(str, Enum):
 class OutputDatabricksDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
+    # JSON
     JSON = "json"
+    # Raw
     RAW = "raw"
+    # Parquet
     PARQUET = "parquet"
 
 
 class OutputDatabricksBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
 class OutputDatabricksDiskSpaceProtection(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
 class OutputDatabricksAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Unity Catalog authentication method. Choose Manual to enter credentials directly, or Secret to use a stored secret."""
 
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 
-class OutputDatabricksCompression(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""Data compression format to apply to HTTP content before it is delivered"""
-
-    NONE = "none"
-    GZIP = "gzip"
-
-
-class OutputDatabricksCompressionLevel(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""Compression level to apply before moving files to final destination"""
-
-    BEST_SPEED = "best_speed"
-    NORMAL = "normal"
-    BEST_COMPRESSION = "best_compression"
-
-
-class OutputDatabricksParquetVersion(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""Determines which data types are supported and how they are represented"""
-
-    PARQUET_1_0 = "PARQUET_1_0"
-    PARQUET_2_4 = "PARQUET_2_4"
-    PARQUET_2_6 = "PARQUET_2_6"
-
-
-class OutputDatabricksDataPageVersion(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
-
-    DATA_PAGE_V1 = "DATA_PAGE_V1"
-    DATA_PAGE_V2 = "DATA_PAGE_V2"
-
-
-class OutputDatabricksKeyValueMetadatumTypedDict(TypedDict):
-    value: str
-    key: NotRequired[str]
-
-
-class OutputDatabricksKeyValueMetadatum(BaseModel):
-    value: str
-
-    key: Optional[str] = ""
-
-
 class OutputDatabricksTypedDict(TypedDict):
     type: OutputDatabricksType
+    login_url: str
+    r"""URL for Unity Catalog OAuth token endpoint (example: 'https://your-workspace.cloud.databricks.com/oauth/token')"""
+    client_id: str
+    r"""JavaScript expression to compute the OAuth client ID for Unity Catalog authentication. Can be a constant."""
     id: NotRequired[str]
     r"""Unique ID for this output"""
     pipeline: NotRequired[str]
@@ -133,14 +105,6 @@ class OutputDatabricksTypedDict(TypedDict):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
     unity_auth_method: NotRequired[OutputDatabricksAuthenticationMethod]
     r"""Unity Catalog authentication method. Choose Manual to enter credentials directly, or Secret to use a stored secret."""
-    login_url: NotRequired[str]
-    r"""URL for Unity Catalog OAuth token endpoint (example: 'https://your-workspace.cloud.databricks.com/oauth/token')"""
-    client_id: NotRequired[str]
-    r"""JavaScript expression to compute the OAuth client ID for Unity Catalog authentication. Can be a constant."""
-    client_secret: NotRequired[str]
-    r"""JavaScript expression to compute the OAuth client secret for Unity Catalog authentication. Can be a constant."""
-    client_text_secret: NotRequired[str]
-    r"""Select or create a stored secret that references your Client ID and Client Secret"""
     scope: NotRequired[str]
     r"""OAuth scope for Unity Catalog authentication"""
     token_timeout_secs: NotRequired[float]
@@ -154,41 +118,21 @@ class OutputDatabricksTypedDict(TypedDict):
     over_write_files: NotRequired[bool]
     r"""Uploaded files should be overwritten if they already exist. If disabled, upload will fail if a file already exists."""
     description: NotRequired[str]
-    compress: NotRequired[OutputDatabricksCompression]
-    r"""Data compression format to apply to HTTP content before it is delivered"""
-    compression_level: NotRequired[OutputDatabricksCompressionLevel]
-    r"""Compression level to apply before moving files to final destination"""
-    automatic_schema: NotRequired[bool]
-    r"""Automatically calculate the schema based on the events of each Parquet file generated"""
-    parquet_version: NotRequired[OutputDatabricksParquetVersion]
-    r"""Determines which data types are supported and how they are represented"""
-    parquet_data_page_version: NotRequired[OutputDatabricksDataPageVersion]
-    r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
-    parquet_row_group_length: NotRequired[float]
-    r"""The number of rows that every group will contain. The final group can contain a smaller number of rows."""
-    parquet_page_size: NotRequired[str]
-    r"""Target memory size for page segments, such as 1MB or 128MB. Generally, lower values improve reading speed, while higher values improve compression."""
-    should_log_invalid_rows: NotRequired[bool]
-    r"""Log up to 3 rows that @{product} skips due to data mismatch"""
-    key_value_metadata: NotRequired[List[OutputDatabricksKeyValueMetadatumTypedDict]]
-    r"""The metadata of files the Destination writes will include the properties you add here as key-value pairs. Useful for tagging. Examples: \"key\":\"OCSF Event Class\", \"value\":\"9001\" """
-    enable_statistics: NotRequired[bool]
-    r"""Statistics profile an entire file in terms of minimum/maximum values within data, numbers of nulls, etc. You can use Parquet tools to view statistics."""
-    enable_write_page_index: NotRequired[bool]
-    r"""One page index contains statistics for one data page. Parquet readers use statistics to enable page skipping."""
-    enable_page_checksum: NotRequired[bool]
-    r"""Parquet tools can use the checksum of a Parquet page to verify data integrity"""
-    empty_dir_cleanup_sec: NotRequired[float]
-    r"""How frequently, in seconds, to clean up empty directories"""
-    deadletter_path: NotRequired[str]
-    r"""Storage location for files that fail to reach their final destination after maximum retries are exceeded"""
-    max_retry_num: NotRequired[float]
-    r"""The maximum number of times a file will attempt to move to its final destination before being dead-lettered"""
+    client_secret: NotRequired[str]
+    r"""JavaScript expression to compute the OAuth client secret for Unity Catalog authentication. Can be a constant."""
+    client_text_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
 
 
 class OutputDatabricks(BaseModel):
     type: OutputDatabricksType
 
+    login_url: Annotated[str, pydantic.Field(alias="loginUrl")]
+    r"""URL for Unity Catalog OAuth token endpoint (example: 'https://your-workspace.cloud.databricks.com/oauth/token')"""
+
+    client_id: Annotated[str, pydantic.Field(alias="clientId")]
+    r"""JavaScript expression to compute the OAuth client ID for Unity Catalog authentication. Can be a constant."""
+
     id: Optional[str] = None
     r"""Unique ID for this output"""
 
@@ -308,20 +252,6 @@ class OutputDatabricks(BaseModel):
     ] = OutputDatabricksAuthenticationMethod.MANUAL
     r"""Unity Catalog authentication method. Choose Manual to enter credentials directly, or Secret to use a stored secret."""
 
-    login_url: Annotated[Optional[str], pydantic.Field(alias="loginUrl")] = None
-    r"""URL for Unity Catalog OAuth token endpoint (example: 'https://your-workspace.cloud.databricks.com/oauth/token')"""
-
-    client_id: Annotated[Optional[str], pydantic.Field(alias="clientId")] = None
-    r"""JavaScript expression to compute the OAuth client ID for Unity Catalog authentication. Can be a constant."""
-
-    client_secret: Annotated[Optional[str], pydantic.Field(alias="clientSecret")] = None
-    r"""JavaScript expression to compute the OAuth client secret for Unity Catalog authentication. Can be a constant."""
-
-    client_text_secret: Annotated[
-        Optional[str], pydantic.Field(alias="clientTextSecret")
-    ] = None
-    r"""Select or create a stored secret that references your Client ID and Client Secret"""
-
     scope: Optional[str] = "all-apis"
     r"""OAuth scope for Unity Catalog authentication"""
 
@@ -352,88 +282,10 @@ class OutputDatabricks(BaseModel):
 
     description: Optional[str] = None
 
-    compress: Annotated[
-        Optional[OutputDatabricksCompression], PlainValidator(validate_open_enum(False))
-    ] = OutputDatabricksCompression.GZIP
-    r"""Data compression format to apply to HTTP content before it is delivered"""
-
-    compression_level: Annotated[
-        Annotated[
-            Optional[OutputDatabricksCompressionLevel],
-            PlainValidator(validate_open_enum(False)),
-        ],
-        pydantic.Field(alias="compressionLevel"),
-    ] = OutputDatabricksCompressionLevel.BEST_SPEED
-    r"""Compression level to apply before moving files to final destination"""
-
-    automatic_schema: Annotated[
-        Optional[bool], pydantic.Field(alias="automaticSchema")
-    ] = False
-    r"""Automatically calculate the schema based on the events of each Parquet file generated"""
-
-    parquet_version: Annotated[
-        Annotated[
-            Optional[OutputDatabricksParquetVersion],
-            PlainValidator(validate_open_enum(False)),
-        ],
-        pydantic.Field(alias="parquetVersion"),
-    ] = OutputDatabricksParquetVersion.PARQUET_2_6
-    r"""Determines which data types are supported and how they are represented"""
-
-    parquet_data_page_version: Annotated[
-        Annotated[
-            Optional[OutputDatabricksDataPageVersion],
-            PlainValidator(validate_open_enum(False)),
-        ],
-        pydantic.Field(alias="parquetDataPageVersion"),
-    ] = OutputDatabricksDataPageVersion.DATA_PAGE_V2
-    r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
-
-    parquet_row_group_length: Annotated[
-        Optional[float], pydantic.Field(alias="parquetRowGroupLength")
-    ] = 10000
-    r"""The number of rows that every group will contain. The final group can contain a smaller number of rows."""
-
-    parquet_page_size: Annotated[
-        Optional[str], pydantic.Field(alias="parquetPageSize")
-    ] = "1MB"
-    r"""Target memory size for page segments, such as 1MB or 128MB. Generally, lower values improve reading speed, while higher values improve compression."""
-
-    should_log_invalid_rows: Annotated[
-        Optional[bool], pydantic.Field(alias="shouldLogInvalidRows")
-    ] = None
-    r"""Log up to 3 rows that @{product} skips due to data mismatch"""
+    client_secret: Annotated[Optional[str], pydantic.Field(alias="clientSecret")] = None
+    r"""JavaScript expression to compute the OAuth client secret for Unity Catalog authentication. Can be a constant."""
 
-    key_value_metadata: Annotated[
-        Optional[List[OutputDatabricksKeyValueMetadatum]],
-        pydantic.Field(alias="keyValueMetadata"),
+    client_text_secret: Annotated[
+        Optional[str], pydantic.Field(alias="clientTextSecret")
     ] = None
-    r"""The metadata of files the Destination writes will include the properties you add here as key-value pairs. Useful for tagging. Examples: \"key\":\"OCSF Event Class\", \"value\":\"9001\" """
-
-    enable_statistics: Annotated[
-        Optional[bool], pydantic.Field(alias="enableStatistics")
-    ] = True
-    r"""Statistics profile an entire file in terms of minimum/maximum values within data, numbers of nulls, etc. You can use Parquet tools to view statistics."""
-
-    enable_write_page_index: Annotated[
-        Optional[bool], pydantic.Field(alias="enableWritePageIndex")
-    ] = True
-    r"""One page index contains statistics for one data page. Parquet readers use statistics to enable page skipping."""
-
-    enable_page_checksum: Annotated[
-        Optional[bool], pydantic.Field(alias="enablePageChecksum")
-    ] = False
-    r"""Parquet tools can use the checksum of a Parquet page to verify data integrity"""
-
-    empty_dir_cleanup_sec: Annotated[
-        Optional[float], pydantic.Field(alias="emptyDirCleanupSec")
-    ] = 300
-    r"""How frequently, in seconds, to clean up empty directories"""
-
-    deadletter_path: Annotated[
-        Optional[str], pydantic.Field(alias="deadletterPath")
-    ] = "$CRIBL_HOME/state/outputs/dead-letter"
-    r"""Storage location for files that fail to reach their final destination after maximum retries are exceeded"""
-
-    max_retry_num: Annotated[Optional[float], pydantic.Field(alias="maxRetryNum")] = 20
-    r"""The maximum number of times a file will attempt to move to its final destination before being dead-lettered"""
+    r"""Select or create a stored text secret"""

cribl_control_plane/models/outputdatadog.py

@@ -18,32 +18,49 @@ class OutputDatadogType(str, Enum):
 class SendLogsAs(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The content type to use when sending logs"""
 
+    # text/plain
     TEXT = "text"
+    # application/json
     JSON = "json"
 
 
 class OutputDatadogSeverity(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Default value for message severity. When you send logs as JSON objects, the event's '__severity' field (if set) will override this value."""
 
+    # emergency
     EMERGENCY = "emergency"
+    # alert
     ALERT = "alert"
+    # critical
     CRITICAL = "critical"
+    # error
     ERROR = "error"
+    # warning
     WARNING = "warning"
+    # notice
     NOTICE = "notice"
+    # info
     INFO = "info"
+    # debug
     DEBUG = "debug"
 
 
 class DatadogSite(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Datadog site to which events should be sent"""
 
+    # US
     US = "us"
+    # US3
     US3 = "us3"
+    # US5
     US5 = "us5"
+    # Europe
     EU = "eu"
+    # US1-FED
     FED1 = "fed1"
+    # AP1
     AP1 = "ap1"
+    # Custom
     CUSTOM = "custom"
 
 
@@ -61,8 +78,11 @@ class OutputDatadogExtraHTTPHeader(BaseModel):
 class OutputDatadogFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
+    # Payload
     PAYLOAD = "payload"
+    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
+    # None
     NONE = "none"
 
 
@@ -123,8 +143,11 @@ class OutputDatadogTimeoutRetrySettings(BaseModel):
 class OutputDatadogBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
@@ -138,22 +161,29 @@ class OutputDatadogAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta)
 class OutputDatadogCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputDatadogQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    # Block
     BLOCK = "block"
+    # Drop new data
     DROP = "drop"
 
 
 class OutputDatadogMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
+    # Error
     ERROR = "error"
+    # Backpressure
     BACKPRESSURE = "backpressure"
+    # Always On
     ALWAYS = "always"