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

cribl_control_plane/models/outputgooglechronicle.py

@@ -16,16 +16,22 @@ class OutputGoogleChronicleType(str, Enum):
 
 
 class OutputGoogleChronicleAPIVersion(str, Enum, metaclass=utils.OpenEnumMeta):
+    # V1
     V1 = "v1"
+    # V2
     V2 = "v2"
 
 
 class OutputGoogleChronicleAuthenticationMethod(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # API key
     MANUAL = "manual"
+    # API key secret
     SECRET = "secret"
+    # Service account credentials
     SERVICE_ACCOUNT = "serviceAccount"
+    # Service account credentials secret
     SERVICE_ACCOUNT_SECRET = "serviceAccountSecret"
 
 
@@ -84,7 +90,9 @@ class OutputGoogleChronicleTimeoutRetrySettings(BaseModel):
 
 
 class SendEventsAs(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Unstructured
     UNSTRUCTURED = "unstructured"
+    # UDM
     UDM = "udm"
 
 
@@ -104,8 +112,11 @@ class OutputGoogleChronicleFailedRequestLoggingMode(
 ):
     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"
 
 
@@ -114,8 +125,11 @@ class OutputGoogleChronicleBackpressureBehavior(
 ):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
@@ -130,12 +144,12 @@ class ExtraLogType(BaseModel):
     description: Optional[str] = None
 
 
-class CustomLabelTypedDict(TypedDict):
+class OutputGoogleChronicleCustomLabelTypedDict(TypedDict):
     key: str
     value: str
 
 
-class CustomLabel(BaseModel):
+class OutputGoogleChronicleCustomLabel(BaseModel):
     key: str
 
     value: str
@@ -144,22 +158,29 @@ class CustomLabel(BaseModel):
 class OutputGoogleChronicleCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputGoogleChronicleQueueFullBehavior(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 OutputGoogleChronicleMode(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"
 
 
@@ -239,7 +260,7 @@ class OutputGoogleChronicleTypedDict(TypedDict):
     r"""A unique identifier (UUID) for your Google SecOps instance. This is provided by your Google representative and is required for API V2 authentication."""
     namespace: NotRequired[str]
     r"""User-configured environment namespace to identify the data domain the logs originated from. Use namespace as a tag to identify the appropriate data domain for indexing and enrichment functionality. Can be overwritten by event field __namespace."""
-    custom_labels: NotRequired[List[CustomLabelTypedDict]]
+    custom_labels: NotRequired[List[OutputGoogleChronicleCustomLabelTypedDict]]
     r"""Custom labels to be added to every batch"""
     api_key: NotRequired[str]
     r"""Organization's API key in Google SecOps"""
@@ -417,7 +438,8 @@ class OutputGoogleChronicle(BaseModel):
     r"""User-configured environment namespace to identify the data domain the logs originated from. Use namespace as a tag to identify the appropriate data domain for indexing and enrichment functionality. Can be overwritten by event field __namespace."""
 
     custom_labels: Annotated[
-        Optional[List[CustomLabel]], pydantic.Field(alias="customLabels")
+        Optional[List[OutputGoogleChronicleCustomLabel]],
+        pydantic.Field(alias="customLabels"),
     ] = None
     r"""Custom labels to be added to every batch"""
 

cribl_control_plane/models/outputgooglecloudlogging.py

@@ -16,16 +16,22 @@ class OutputGoogleCloudLoggingType(str, Enum):
 
 
 class LogLocationType(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Project
     PROJECT = "project"
+    # Organization
     ORGANIZATION = "organization"
+    # Billing Account
     BILLING_ACCOUNT = "billingAccount"
+    # Folder
     FOLDER = "folder"
 
 
 class PayloadFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format to use when sending payload. Defaults to Text."""
 
+    # Text
     TEXT = "text"
+    # JSON
     JSON = "json"
 
 
@@ -64,8 +70,11 @@ class OutputGoogleCloudLoggingGoogleAuthenticationMethod(
 ):
     r"""Choose Auto to use Google Application Default Credentials (ADC), Manual to enter Google service account credentials directly, or Secret to select or create a stored secret that references Google service account credentials."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret
     SECRET = "secret"
 
 
@@ -74,15 +83,20 @@ class OutputGoogleCloudLoggingBackpressureBehavior(
 ):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
 class OutputGoogleCloudLoggingCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -91,15 +105,20 @@ class OutputGoogleCloudLoggingQueueFullBehavior(
 ):
     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 OutputGoogleCloudLoggingMode(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"
 
 
@@ -115,9 +134,9 @@ class OutputGoogleCloudLoggingTypedDict(TypedDict):
     type: OutputGoogleCloudLoggingType
     log_location_type: LogLocationType
     log_name_expression: str
-    r"""JavaScript expression to compute the value of the log name."""
+    r"""JavaScript expression to compute the value of the log name. If Validate and correct log name is enabled, invalid characters (characters other than alphanumerics, forward-slashes, underscores, hyphens, and periods) will be replaced with an underscore."""
     log_location_expression: str
-    r"""JavaScript expression to compute the value of the folder ID with which log entries should be associated."""
+    r"""JavaScript expression to compute the value of the folder ID with which log entries should be associated. If Validate and correct log name is enabled, invalid characters (characters other than alphanumerics, forward-slashes, underscores, hyphens, and periods) will be replaced with an underscore."""
     id: NotRequired[str]
     r"""Unique ID for this output"""
     pipeline: NotRequired[str]
@@ -128,6 +147,7 @@ class OutputGoogleCloudLoggingTypedDict(TypedDict):
     r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
     streamtags: NotRequired[List[str]]
     r"""Tags for filtering and grouping in @{product}"""
+    sanitize_log_names: NotRequired[bool]
     payload_format: NotRequired[PayloadFormat]
     r"""Format to use when sending payload. Defaults to Text."""
     log_labels: NotRequired[List[LogLabelTypedDict]]
@@ -247,12 +267,12 @@ class OutputGoogleCloudLogging(BaseModel):
     ]
 
     log_name_expression: Annotated[str, pydantic.Field(alias="logNameExpression")]
-    r"""JavaScript expression to compute the value of the log name."""
+    r"""JavaScript expression to compute the value of the log name. If Validate and correct log name is enabled, invalid characters (characters other than alphanumerics, forward-slashes, underscores, hyphens, and periods) will be replaced with an underscore."""
 
     log_location_expression: Annotated[
         str, pydantic.Field(alias="logLocationExpression")
     ]
-    r"""JavaScript expression to compute the value of the folder ID with which log entries should be associated."""
+    r"""JavaScript expression to compute the value of the folder ID with which log entries should be associated. If Validate and correct log name is enabled, invalid characters (characters other than alphanumerics, forward-slashes, underscores, hyphens, and periods) will be replaced with an underscore."""
 
     id: Optional[str] = None
     r"""Unique ID for this output"""
@@ -271,6 +291,10 @@ class OutputGoogleCloudLogging(BaseModel):
     streamtags: Optional[List[str]] = None
     r"""Tags for filtering and grouping in @{product}"""
 
+    sanitize_log_names: Annotated[
+        Optional[bool], pydantic.Field(alias="sanitizeLogNames")
+    ] = False
+
     payload_format: Annotated[
         Annotated[Optional[PayloadFormat], PlainValidator(validate_open_enum(False))],
         pydantic.Field(alias="payloadFormat"),

cribl_control_plane/models/outputgooglecloudstorage.py

@@ -25,36 +25,52 @@ class OutputGoogleCloudStorageSignatureVersion(str, Enum, metaclass=utils.OpenEn
 class OutputGoogleCloudStorageAuthenticationMethod(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # auto
     AUTO = "auto"
+    # manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 
 class OutputGoogleCloudStorageObjectACL(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Object ACL to assign to uploaded objects"""
 
+    # private
     PRIVATE = "private"
+    # bucket-owner-read
     BUCKET_OWNER_READ = "bucket-owner-read"
+    # bucket-owner-full-control
     BUCKET_OWNER_FULL_CONTROL = "bucket-owner-full-control"
+    # project-private
     PROJECT_PRIVATE = "project-private"
+    # authenticated-read
     AUTHENTICATED_READ = "authenticated-read"
+    # public-read
     PUBLIC_READ = "public-read"
 
 
 class OutputGoogleCloudStorageStorageClass(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Storage class to select for uploaded objects"""
 
+    # Standard Storage
     STANDARD = "STANDARD"
+    # Nearline Storage
     NEARLINE = "NEARLINE"
+    # Coldline Storage
     COLDLINE = "COLDLINE"
+    # Archive Storage
     ARCHIVE = "ARCHIVE"
 
 
 class OutputGoogleCloudStorageDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
+    # JSON
     JSON = "json"
+    # Raw
     RAW = "raw"
+    # Parquet
     PARQUET = "parquet"
 
 
@@ -63,7 +79,9 @@ class OutputGoogleCloudStorageBackpressureBehavior(
 ):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
@@ -72,7 +90,9 @@ class OutputGoogleCloudStorageDiskSpaceProtection(
 ):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
@@ -86,23 +106,31 @@ class OutputGoogleCloudStorageCompression(str, Enum, metaclass=utils.OpenEnumMet
 class OutputGoogleCloudStorageCompressionLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Compression level to apply before moving files to final destination"""
 
+    # Best Speed
     BEST_SPEED = "best_speed"
+    # Normal
     NORMAL = "normal"
+    # Best Compression
     BEST_COMPRESSION = "best_compression"
 
 
 class OutputGoogleCloudStorageParquetVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Determines which data types are supported and how they are represented"""
 
+    # 1.0
     PARQUET_1_0 = "PARQUET_1_0"
+    # 2.4
     PARQUET_2_4 = "PARQUET_2_4"
+    # 2.6
     PARQUET_2_6 = "PARQUET_2_6"
 
 
 class OutputGoogleCloudStorageDataPageVersion(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."""
 
+    # V1
     DATA_PAGE_V1 = "DATA_PAGE_V1"
+    # V2
     DATA_PAGE_V2 = "DATA_PAGE_V2"
 
 

cribl_control_plane/models/outputgooglepubsub.py

@@ -20,38 +20,51 @@ class OutputGooglePubsubGoogleAuthenticationMethod(
 ):
     r"""Choose Auto to use Google Application Default Credentials (ADC), Manual to enter Google service account credentials directly, or Secret to select or create a stored secret that references Google service account credentials."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret
     SECRET = "secret"
 
 
 class OutputGooglePubsubBackpressureBehavior(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"
 
 
 class OutputGooglePubsubCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputGooglePubsubQueueFullBehavior(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 OutputGooglePubsubMode(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/outputgrafanacloud.py

@@ -18,7 +18,9 @@ class OutputGrafanaCloudType2(str, Enum):
 class OutputGrafanaCloudMessageFormat2(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
 
+    # Protobuf
     PROTOBUF = "protobuf"
+    # JSON
     JSON = "json"
 
 
@@ -36,10 +38,15 @@ class OutputGrafanaCloudLabel2(BaseModel):
 class OutputGrafanaCloudPrometheusAuthAuthenticationType2(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # None
     NONE = "none"
+    # Auth token
     TOKEN = "token"
+    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
+    # Basic
     BASIC = "basic"
+    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -87,10 +94,15 @@ class OutputGrafanaCloudPrometheusAuth2(BaseModel):
 class OutputGrafanaCloudLokiAuthAuthenticationType2(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # None
     NONE = "none"
+    # Auth token
     TOKEN = "token"
+    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
+    # Basic
     BASIC = "basic"
+    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -151,8 +163,11 @@ class OutputGrafanaCloudFailedRequestLoggingMode2(
 ):
     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"
 
 
@@ -213,30 +228,40 @@ class OutputGrafanaCloudTimeoutRetrySettings2(BaseModel):
 class OutputGrafanaCloudBackpressureBehavior2(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"
 
 
 class OutputGrafanaCloudCompression2(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputGrafanaCloudQueueFullBehavior2(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 OutputGrafanaCloudMode2(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"
 
 
@@ -518,7 +543,9 @@ class OutputGrafanaCloudType1(str, Enum):
 class OutputGrafanaCloudMessageFormat1(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
 
+    # Protobuf
     PROTOBUF = "protobuf"
+    # JSON
     JSON = "json"
 
 
@@ -536,10 +563,15 @@ class OutputGrafanaCloudLabel1(BaseModel):
 class OutputGrafanaCloudPrometheusAuthAuthenticationType1(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # None
     NONE = "none"
+    # Auth token
     TOKEN = "token"
+    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
+    # Basic
     BASIC = "basic"
+    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -587,10 +619,15 @@ class OutputGrafanaCloudPrometheusAuth1(BaseModel):
 class OutputGrafanaCloudLokiAuthAuthenticationType1(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # None
     NONE = "none"
+    # Auth token
     TOKEN = "token"
+    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
+    # Basic
     BASIC = "basic"
+    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -651,8 +688,11 @@ class OutputGrafanaCloudFailedRequestLoggingMode1(
 ):
     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"
 
 
@@ -713,30 +753,40 @@ class OutputGrafanaCloudTimeoutRetrySettings1(BaseModel):
 class OutputGrafanaCloudBackpressureBehavior1(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"
 
 
 class OutputGrafanaCloudCompression1(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputGrafanaCloudQueueFullBehavior1(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 OutputGrafanaCloudMode1(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/outputgraphite.py

@@ -18,37 +18,49 @@ class OutputGraphiteType(str, Enum):
 class OutputGraphiteDestinationProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Protocol to use when communicating with the destination."""
 
+    # UDP
     UDP = "udp"
+    # TCP
     TCP = "tcp"
 
 
 class OutputGraphiteBackpressureBehavior(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"
 
 
 class OutputGraphiteCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputGraphiteQueueFullBehavior(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 OutputGraphiteMode(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/outputhoneycomb.py

@@ -29,8 +29,11 @@ class OutputHoneycombExtraHTTPHeader(BaseModel):
 class OutputHoneycombFailedRequestLoggingMode(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"
 
 
@@ -91,8 +94,11 @@ class OutputHoneycombTimeoutRetrySettings(BaseModel):
 class OutputHoneycombBackpressureBehavior(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"
 
 
@@ -106,22 +112,29 @@ class OutputHoneycombAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMet
 class OutputHoneycombCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputHoneycombQueueFullBehavior(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 OutputHoneycombMode(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"