cribl-control-plane 0.0.49__py3-none-any.whl → 0.0.50rc1__py3-none-any.whl

cribl_control_plane/models/outputopentelemetry.py

@@ -1,9 +1,12 @@
 """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
 
@@ -12,21 +15,21 @@ class OutputOpenTelemetryType(str, Enum):
     OPEN_TELEMETRY = "open_telemetry"
 
 
-class OutputOpenTelemetryProtocol(str, Enum):
+class OutputOpenTelemetryProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select a transport option for OpenTelemetry"""
 
     GRPC = "grpc"
     HTTP = "http"
 
 
-class OutputOpenTelemetryOTLPVersion(str, Enum):
+class OutputOpenTelemetryOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The version of OTLP Protobuf definitions to use when structuring data to send"""
 
     ZERO_DOT_10_DOT_0 = "0.10.0"
     ONE_DOT_3_DOT_1 = "1.3.1"
 
 
-class OutputOpenTelemetryCompressCompression(str, Enum):
+class OutputOpenTelemetryCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
 
     NONE = "none"
@@ -34,14 +37,16 @@ class OutputOpenTelemetryCompressCompression(str, Enum):
     GZIP = "gzip"
 
 
-class OutputOpenTelemetryHTTPCompressCompression(str, Enum):
+class OutputOpenTelemetryHTTPCompressCompression(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
 
     NONE = "none"
     GZIP = "gzip"
 
 
-class OutputOpenTelemetryAuthenticationType(str, Enum):
+class OutputOpenTelemetryAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""OpenTelemetry authentication type"""
 
     NONE = "none"
@@ -63,7 +68,9 @@ class OutputOpenTelemetryMetadatum(BaseModel):
     key: Optional[str] = ""
 
 
-class OutputOpenTelemetryFailedRequestLoggingMode(str, Enum):
+class OutputOpenTelemetryFailedRequestLoggingMode(
+    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"
@@ -71,7 +78,7 @@ class OutputOpenTelemetryFailedRequestLoggingMode(str, Enum):
     NONE = "none"
 
 
-class OutputOpenTelemetryBackpressureBehavior(str, Enum):
+class OutputOpenTelemetryBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
     BLOCK = "block"
@@ -174,14 +181,14 @@ class OutputOpenTelemetryTimeoutRetrySettings(BaseModel):
     r"""The maximum backoff interval, in milliseconds, Cribl Stream should apply. Default (and minimum) is 10,000 ms (10 seconds); maximum is 180,000 ms (180 seconds)."""
 
 
-class OutputOpenTelemetryMinimumTLSVersion(str, Enum):
+class OutputOpenTelemetryMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class OutputOpenTelemetryMaximumTLSVersion(str, Enum):
+class OutputOpenTelemetryMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -236,31 +243,37 @@ class OutputOpenTelemetryTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[OutputOpenTelemetryMinimumTLSVersion],
+        Annotated[
+            Optional[OutputOpenTelemetryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[OutputOpenTelemetryMaximumTLSVersion],
+        Annotated[
+            Optional[OutputOpenTelemetryMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="maxVersion"),
     ] = None
 
 
-class OutputOpenTelemetryPqCompressCompression(str, Enum):
+class OutputOpenTelemetryPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
     NONE = "none"
     GZIP = "gzip"
 
 
-class OutputOpenTelemetryQueueFullBehavior(str, Enum):
+class OutputOpenTelemetryQueueFullBehavior(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"
     DROP = "drop"
 
 
-class OutputOpenTelemetryMode(str, Enum):
+class OutputOpenTelemetryMode(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"
@@ -412,27 +425,40 @@ class OutputOpenTelemetry(BaseModel):
     streamtags: Optional[List[str]] = None
     r"""Tags for filtering and grouping in @{product}"""
 
-    protocol: Optional[OutputOpenTelemetryProtocol] = OutputOpenTelemetryProtocol.GRPC
+    protocol: Annotated[
+        Optional[OutputOpenTelemetryProtocol], PlainValidator(validate_open_enum(False))
+    ] = OutputOpenTelemetryProtocol.GRPC
     r"""Select a transport option for OpenTelemetry"""
 
     otlp_version: Annotated[
-        Optional[OutputOpenTelemetryOTLPVersion], pydantic.Field(alias="otlpVersion")
+        Annotated[
+            Optional[OutputOpenTelemetryOTLPVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="otlpVersion"),
     ] = OutputOpenTelemetryOTLPVersion.ZERO_DOT_10_DOT_0
     r"""The version of OTLP Protobuf definitions to use when structuring data to send"""
 
-    compress: Optional[OutputOpenTelemetryCompressCompression] = (
-        OutputOpenTelemetryCompressCompression.GZIP
-    )
+    compress: Annotated[
+        Optional[OutputOpenTelemetryCompressCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = OutputOpenTelemetryCompressCompression.GZIP
     r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
 
     http_compress: Annotated[
-        Optional[OutputOpenTelemetryHTTPCompressCompression],
+        Annotated[
+            Optional[OutputOpenTelemetryHTTPCompressCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="httpCompress"),
     ] = OutputOpenTelemetryHTTPCompressCompression.GZIP
     r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
 
     auth_type: Annotated[
-        Optional[OutputOpenTelemetryAuthenticationType],
+        Annotated[
+            Optional[OutputOpenTelemetryAuthenticationType],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="authType"),
     ] = OutputOpenTelemetryAuthenticationType.NONE
     r"""OpenTelemetry authentication type"""
@@ -472,7 +498,10 @@ class OutputOpenTelemetry(BaseModel):
     r"""Maximum time between requests. Small values could cause the payload size to be smaller than the configured Body size limit."""
 
     failed_request_logging_mode: Annotated[
-        Optional[OutputOpenTelemetryFailedRequestLoggingMode],
+        Annotated[
+            Optional[OutputOpenTelemetryFailedRequestLoggingMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="failedRequestLoggingMode"),
     ] = OutputOpenTelemetryFailedRequestLoggingMode.NONE
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
@@ -491,7 +520,10 @@ class OutputOpenTelemetry(BaseModel):
     r"""Disable to close the connection immediately after sending the outgoing request"""
 
     on_backpressure: Annotated[
-        Optional[OutputOpenTelemetryBackpressureBehavior],
+        Annotated[
+            Optional[OutputOpenTelemetryBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputOpenTelemetryBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
@@ -607,19 +639,28 @@ class OutputOpenTelemetry(BaseModel):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
 
     pq_compress: Annotated[
-        Optional[OutputOpenTelemetryPqCompressCompression],
+        Annotated[
+            Optional[OutputOpenTelemetryPqCompressCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqCompress"),
     ] = OutputOpenTelemetryPqCompressCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputOpenTelemetryQueueFullBehavior],
+        Annotated[
+            Optional[OutputOpenTelemetryQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputOpenTelemetryQueueFullBehavior.BLOCK
     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."""
 
     pq_mode: Annotated[
-        Optional[OutputOpenTelemetryMode], pydantic.Field(alias="pqMode")
+        Annotated[
+            Optional[OutputOpenTelemetryMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
     ] = OutputOpenTelemetryMode.ERROR
     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."""
 

cribl_control_plane/models/outputprometheus.py

@@ -1,9 +1,12 @@
 """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
 
@@ -23,7 +26,7 @@ class OutputPrometheusExtraHTTPHeader(BaseModel):
     name: Optional[str] = None
 
 
-class OutputPrometheusFailedRequestLoggingMode(str, Enum):
+class OutputPrometheusFailedRequestLoggingMode(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"
@@ -85,7 +88,7 @@ class OutputPrometheusTimeoutRetrySettings(BaseModel):
     r"""The maximum backoff interval, in milliseconds, Cribl Stream should apply. Default (and minimum) is 10,000 ms (10 seconds); maximum is 180,000 ms (180 seconds)."""
 
 
-class OutputPrometheusBackpressureBehavior(str, Enum):
+class OutputPrometheusBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
     BLOCK = "block"
@@ -93,7 +96,7 @@ class OutputPrometheusBackpressureBehavior(str, Enum):
     QUEUE = "queue"
 
 
-class OutputPrometheusAuthenticationType(str, Enum):
+class OutputPrometheusAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Remote Write authentication type"""
 
     NONE = "none"
@@ -104,21 +107,21 @@ class OutputPrometheusAuthenticationType(str, Enum):
     OAUTH = "oauth"
 
 
-class OutputPrometheusCompression(str, Enum):
+class OutputPrometheusCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
     NONE = "none"
     GZIP = "gzip"
 
 
-class OutputPrometheusQueueFullBehavior(str, Enum):
+class OutputPrometheusQueueFullBehavior(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"
     DROP = "drop"
 
 
-class OutputPrometheusMode(str, Enum):
+class OutputPrometheusMode(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"
@@ -332,7 +335,10 @@ class OutputPrometheus(BaseModel):
     r"""Enable round-robin DNS lookup. When a DNS server returns multiple addresses, @{product} will cycle through them in the order returned. For optimal performance, consider enabling this setting for non-load balanced destinations."""
 
     failed_request_logging_mode: Annotated[
-        Optional[OutputPrometheusFailedRequestLoggingMode],
+        Annotated[
+            Optional[OutputPrometheusFailedRequestLoggingMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="failedRequestLoggingMode"),
     ] = OutputPrometheusFailedRequestLoggingMode.NONE
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
@@ -359,13 +365,20 @@ class OutputPrometheus(BaseModel):
     r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
 
     on_backpressure: Annotated[
-        Optional[OutputPrometheusBackpressureBehavior],
+        Annotated[
+            Optional[OutputPrometheusBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputPrometheusBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
 
     auth_type: Annotated[
-        Optional[OutputPrometheusAuthenticationType], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[OutputPrometheusAuthenticationType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = OutputPrometheusAuthenticationType.NONE
     r"""Remote Write authentication type"""
 
@@ -390,18 +403,28 @@ class OutputPrometheus(BaseModel):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
 
     pq_compress: Annotated[
-        Optional[OutputPrometheusCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputPrometheusCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputPrometheusCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputPrometheusQueueFullBehavior],
+        Annotated[
+            Optional[OutputPrometheusQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputPrometheusQueueFullBehavior.BLOCK
     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."""
 
     pq_mode: Annotated[
-        Optional[OutputPrometheusMode], pydantic.Field(alias="pqMode")
+        Annotated[
+            Optional[OutputPrometheusMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
     ] = OutputPrometheusMode.ERROR
     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."""
 

cribl_control_plane/models/outputring.py

@@ -1,9 +1,12 @@
 """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
 
@@ -12,19 +15,19 @@ class OutputRingType(str, Enum):
     RING = "ring"
 
 
-class OutputRingDataFormat(str, Enum):
+class OutputRingDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data."""
 
     JSON = "json"
     RAW = "raw"
 
 
-class OutputRingDataCompressionFormat(str, Enum):
+class OutputRingDataCompressionFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     NONE = "none"
     GZIP = "gzip"
 
 
-class OutputRingBackpressureBehavior(str, Enum):
+class OutputRingBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
     BLOCK = "block"
@@ -80,7 +83,10 @@ class OutputRing(BaseModel):
     r"""Tags for filtering and grouping in @{product}"""
 
     format_: Annotated[
-        Optional[OutputRingDataFormat], pydantic.Field(alias="format")
+        Annotated[
+            Optional[OutputRingDataFormat], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="format"),
     ] = OutputRingDataFormat.JSON
     r"""Format of the output data."""
 
@@ -95,15 +101,20 @@ class OutputRing(BaseModel):
     max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
     r"""Maximum amount of time to retain data (examples: 2h, 4d). When limit is reached, older data will be deleted."""
 
-    compress: Optional[OutputRingDataCompressionFormat] = (
-        OutputRingDataCompressionFormat.GZIP
-    )
+    compress: Annotated[
+        Optional[OutputRingDataCompressionFormat],
+        PlainValidator(validate_open_enum(False)),
+    ] = OutputRingDataCompressionFormat.GZIP
 
     dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = None
     r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/<id>"""
 
     on_backpressure: Annotated[
-        Optional[OutputRingBackpressureBehavior], pydantic.Field(alias="onBackpressure")
+        Annotated[
+            Optional[OutputRingBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="onBackpressure"),
     ] = OutputRingBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""