cribl-control-plane 0.2.0a1__py3-none-any.whl → 0.2.0b1__py3-none-any.whl

cribl_control_plane/models/outputdatabricks.py

@@ -0,0 +1,291 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane import utils
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
+from enum import Enum
+import pydantic
+from pydantic.functional_validators import PlainValidator
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class OutputDatabricksType(str, Enum):
+    DATABRICKS = "databricks"
+
+
+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 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]
+    r"""Pipeline to process data before sending out to this output"""
+    system_fields: NotRequired[List[str]]
+    r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
+    environment: NotRequired[str]
+    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}"""
+    dest_path: NotRequired[str]
+    r"""Optional path to prepend to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myEventsVolumePath-${C.vars.myVar}`"""
+    stage_path: NotRequired[str]
+    r"""Filesystem location in which to buffer files before compressing and moving to final destination. Use performant, stable storage."""
+    add_id_to_stage_path: NotRequired[bool]
+    r"""Add the Output ID value to staging location"""
+    remove_empty_dirs: NotRequired[bool]
+    r"""Remove empty staging directories after moving files"""
+    partition_expr: NotRequired[str]
+    r"""JavaScript expression defining how files are partitioned and organized. Default is date-based. If blank, Stream will fall back to the event's __partition field value – if present – otherwise to each location's root directory."""
+    format_: NotRequired[OutputDatabricksDataFormat]
+    r"""Format of the output data"""
+    base_file_name: NotRequired[str]
+    r"""JavaScript expression to define the output filename prefix (can be constant)"""
+    file_name_suffix: NotRequired[str]
+    r"""JavaScript expression to define the output filename suffix (can be constant).  The `__format` variable refers to the value of the `Data format` field (`json` or `raw`).  The `__compression` field refers to the kind of compression being used (`none` or `gzip`)."""
+    max_file_size_mb: NotRequired[float]
+    r"""Maximum uncompressed output file size. Files of this size will be closed and moved to final output location."""
+    max_file_open_time_sec: NotRequired[float]
+    r"""Maximum amount of time to write to a file. Files open for longer than this will be closed and moved to final output location."""
+    max_file_idle_time_sec: NotRequired[float]
+    r"""Maximum amount of time to keep inactive files open. Files open for longer than this will be closed and moved to final output location."""
+    max_open_files: NotRequired[float]
+    r"""Maximum number of files to keep open concurrently. When exceeded, @{product} will close the oldest open files and move them to the final output location."""
+    header_line: NotRequired[str]
+    r"""If set, this line will be written to the beginning of each output file"""
+    write_high_water_mark: NotRequired[float]
+    r"""Buffer size used to write to a file"""
+    on_backpressure: NotRequired[OutputDatabricksBackpressureBehavior]
+    r"""How to handle events when all receivers are exerting backpressure"""
+    deadletter_enabled: NotRequired[bool]
+    r"""If a file fails to move to its final destination after the maximum number of retries, move it to a designated directory to prevent further errors"""
+    on_disk_full_backpressure: NotRequired[OutputDatabricksDiskSpaceProtection]
+    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."""
+    scope: NotRequired[str]
+    r"""OAuth scope for Unity Catalog authentication"""
+    token_timeout_secs: NotRequired[float]
+    r"""How often the OAuth token should be refreshed"""
+    default_catalog: NotRequired[str]
+    r"""Name of the catalog to use for the output"""
+    default_schema: NotRequired[str]
+    r"""Name of the catalog schema to use for the output"""
+    events_volume_name: NotRequired[str]
+    r"""Name of the events volume in Databricks"""
+    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]
+    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"""
+
+    pipeline: Optional[str] = None
+    r"""Pipeline to process data before sending out to this output"""
+
+    system_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="systemFields")
+    ] = None
+    r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
+
+    environment: Optional[str] = None
+    r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
+
+    streamtags: Optional[List[str]] = None
+    r"""Tags for filtering and grouping in @{product}"""
+
+    dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = ""
+    r"""Optional path to prepend to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myEventsVolumePath-${C.vars.myVar}`"""
+
+    stage_path: Annotated[Optional[str], pydantic.Field(alias="stagePath")] = (
+        "$CRIBL_HOME/state/outputs/staging"
+    )
+    r"""Filesystem location in which to buffer files before compressing and moving to final destination. Use performant, stable storage."""
+
+    add_id_to_stage_path: Annotated[
+        Optional[bool], pydantic.Field(alias="addIdToStagePath")
+    ] = True
+    r"""Add the Output ID value to staging location"""
+
+    remove_empty_dirs: Annotated[
+        Optional[bool], pydantic.Field(alias="removeEmptyDirs")
+    ] = True
+    r"""Remove empty staging directories after moving files"""
+
+    partition_expr: Annotated[Optional[str], pydantic.Field(alias="partitionExpr")] = (
+        "C.Time.strftime(_time ? _time : Date.now()/1000, '%Y/%m/%d')"
+    )
+    r"""JavaScript expression defining how files are partitioned and organized. Default is date-based. If blank, Stream will fall back to the event's __partition field value – if present – otherwise to each location's root directory."""
+
+    format_: Annotated[
+        Annotated[
+            Optional[OutputDatabricksDataFormat],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="format"),
+    ] = OutputDatabricksDataFormat.JSON
+    r"""Format of the output data"""
+
+    base_file_name: Annotated[Optional[str], pydantic.Field(alias="baseFileName")] = (
+        "`CriblOut`"
+    )
+    r"""JavaScript expression to define the output filename prefix (can be constant)"""
+
+    file_name_suffix: Annotated[
+        Optional[str], pydantic.Field(alias="fileNameSuffix")
+    ] = '`.${C.env["CRIBL_WORKER_ID"]}.${__format}${__compression === "gzip" ? ".gz" : ""}`'
+    r"""JavaScript expression to define the output filename suffix (can be constant).  The `__format` variable refers to the value of the `Data format` field (`json` or `raw`).  The `__compression` field refers to the kind of compression being used (`none` or `gzip`)."""
+
+    max_file_size_mb: Annotated[
+        Optional[float], pydantic.Field(alias="maxFileSizeMB")
+    ] = 32
+    r"""Maximum uncompressed output file size. Files of this size will be closed and moved to final output location."""
+
+    max_file_open_time_sec: Annotated[
+        Optional[float], pydantic.Field(alias="maxFileOpenTimeSec")
+    ] = 300
+    r"""Maximum amount of time to write to a file. Files open for longer than this will be closed and moved to final output location."""
+
+    max_file_idle_time_sec: Annotated[
+        Optional[float], pydantic.Field(alias="maxFileIdleTimeSec")
+    ] = 30
+    r"""Maximum amount of time to keep inactive files open. Files open for longer than this will be closed and moved to final output location."""
+
+    max_open_files: Annotated[Optional[float], pydantic.Field(alias="maxOpenFiles")] = (
+        100
+    )
+    r"""Maximum number of files to keep open concurrently. When exceeded, @{product} will close the oldest open files and move them to the final output location."""
+
+    header_line: Annotated[Optional[str], pydantic.Field(alias="headerLine")] = ""
+    r"""If set, this line will be written to the beginning of each output file"""
+
+    write_high_water_mark: Annotated[
+        Optional[float], pydantic.Field(alias="writeHighWaterMark")
+    ] = 64
+    r"""Buffer size used to write to a file"""
+
+    on_backpressure: Annotated[
+        Annotated[
+            Optional[OutputDatabricksBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="onBackpressure"),
+    ] = OutputDatabricksBackpressureBehavior.BLOCK
+    r"""How to handle events when all receivers are exerting backpressure"""
+
+    deadletter_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="deadletterEnabled")
+    ] = False
+    r"""If a file fails to move to its final destination after the maximum number of retries, move it to a designated directory to prevent further errors"""
+
+    on_disk_full_backpressure: Annotated[
+        Annotated[
+            Optional[OutputDatabricksDiskSpaceProtection],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="onDiskFullBackpressure"),
+    ] = OutputDatabricksDiskSpaceProtection.BLOCK
+    r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
+
+    unity_auth_method: Annotated[
+        Annotated[
+            Optional[OutputDatabricksAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="unityAuthMethod"),
+    ] = OutputDatabricksAuthenticationMethod.MANUAL
+    r"""Unity Catalog authentication method. Choose Manual to enter credentials directly, or Secret to use a stored secret."""
+
+    scope: Optional[str] = "all-apis"
+    r"""OAuth scope for Unity Catalog authentication"""
+
+    token_timeout_secs: Annotated[
+        Optional[float], pydantic.Field(alias="tokenTimeoutSecs")
+    ] = 3600
+    r"""How often the OAuth token should be refreshed"""
+
+    default_catalog: Annotated[
+        Optional[str], pydantic.Field(alias="defaultCatalog")
+    ] = "main"
+    r"""Name of the catalog to use for the output"""
+
+    default_schema: Annotated[Optional[str], pydantic.Field(alias="defaultSchema")] = (
+        "external"
+    )
+    r"""Name of the catalog schema to use for the output"""
+
+    events_volume_name: Annotated[
+        Optional[str], pydantic.Field(alias="eventsVolumeName")
+    ] = "events"
+    r"""Name of the events volume in Databricks"""
+
+    over_write_files: Annotated[
+        Optional[bool], pydantic.Field(alias="overWriteFiles")
+    ] = False
+    r"""Uploaded files should be overwritten if they already exist. If disabled, upload will fail if a file already exists."""
+
+    description: Optional[str] = None
+
+    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 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"
 
 

cribl_control_plane/models/outputdataset.py

@@ -18,12 +18,19 @@ class OutputDatasetType(str, Enum):
 class OutputDatasetSeverity(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Default value for event severity. If the `sev` or `__severity` fields are set on an event, the first one matching will override this value."""
 
+    # 0 - finest
     FINEST = "finest"
+    # 1 - finer
     FINER = "finer"
+    # 2 - fine
     FINE = "fine"
+    # 3 - info
     INFO = "info"
+    # 4 - warning
     WARNING = "warning"
+    # 5 - error
     ERROR = "error"
+    # 6 - fatal
     FATAL = "fatal"
 
 
@@ -84,8 +91,11 @@ class OutputDatasetTimeoutRetrySettings(BaseModel):
 class DataSetSite(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""DataSet site to which events should be sent"""
 
+    # US
     US = "us"
+    # Europe
     EU = "eu"
+    # Custom
     CUSTOM = "custom"
 
 
@@ -103,16 +113,22 @@ class OutputDatasetExtraHTTPHeader(BaseModel):
 class OutputDatasetFailedRequestLoggingMode(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"
 
 
 class OutputDatasetBackpressureBehavior(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"
 
 
@@ -126,22 +142,29 @@ class OutputDatasetAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta)
 class OutputDatasetCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputDatasetQueueFullBehavior(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 OutputDatasetMode(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/outputdls3.py

@@ -18,8 +18,11 @@ class OutputDlS3Type(str, Enum):
 class OutputDlS3AuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 
@@ -33,54 +36,78 @@ class OutputDlS3SignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputDlS3ObjectACL(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 OutputDlS3StorageClass(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 OutputDlS3ServerSideEncryptionForUploadedObjects(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
+    # Amazon S3 Managed Key
     AES256 = "AES256"
+    # AWS KMS Managed Key
     AWS_KMS = "aws:kms"
 
 
 class OutputDlS3DataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
+    # JSON
     JSON = "json"
+    # Raw
     RAW = "raw"
+    # Parquet
     PARQUET = "parquet"
 
 
 class OutputDlS3BackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
 class OutputDlS3DiskSpaceProtection(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"
 
 
@@ -94,23 +121,31 @@ class OutputDlS3Compression(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputDlS3CompressionLevel(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 OutputDlS3ParquetVersion(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 OutputDlS3DataPageVersion(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/outputdynatracehttp.py

@@ -39,8 +39,11 @@ class OutputDynatraceHTTPFailedRequestLoggingMode(
 ):
     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"
 
 
@@ -101,53 +104,72 @@ class OutputDynatraceHTTPTimeoutRetrySettings(BaseModel):
 class OutputDynatraceHTTPBackpressureBehavior(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 OutputDynatraceHTTPAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Auth token
     TOKEN = "token"
+    # Token (text secret)
     TEXT_SECRET = "textSecret"
 
 
 class OutputDynatraceHTTPFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to format events before sending. Defaults to JSON. Plaintext is not currently supported."""
 
+    # JSON
     JSON_ARRAY = "json_array"
+    # Plaintext
     PLAINTEXT = "plaintext"
 
 
 class Endpoint(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Cloud
     CLOUD = "cloud"
+    # ActiveGate
     ACTIVE_GATE = "activeGate"
+    # Manual
     MANUAL = "manual"
 
 
 class TelemetryType(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Logs
     LOGS = "logs"
+    # Metrics
     METRICS = "metrics"
 
 
 class OutputDynatraceHTTPCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputDynatraceHTTPQueueFullBehavior(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 OutputDynatraceHTTPMode(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"