cribl-control-plane 0.0.39__py3-none-any.whl → 0.4.0b23__py3-none-any.whl

cribl_control_plane/models/inputopentelemetry.py

@@ -1,9 +1,13 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from cribl_control_plane import models, 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 import field_serializer
+from pydantic.functional_validators import PlainValidator
 from typing import Any, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -23,20 +27,32 @@ class InputOpenTelemetryConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputOpenTelemetryMode(str, Enum):
+class InputOpenTelemetryMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
-class InputOpenTelemetryCompression(str, Enum):
+class InputOpenTelemetryCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputOpenTelemetryPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputOpenTelemetryPqControls(BaseModel):
+    pass
+
+
 class InputOpenTelemetryPqTypedDict(TypedDict):
     mode: NotRequired[InputOpenTelemetryMode]
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
@@ -52,10 +68,13 @@ class InputOpenTelemetryPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputOpenTelemetryCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputOpenTelemetryPqControlsTypedDict]
 
 
 class InputOpenTelemetryPq(BaseModel):
-    mode: Optional[InputOpenTelemetryMode] = InputOpenTelemetryMode.ALWAYS
+    mode: Annotated[
+        Optional[InputOpenTelemetryMode], PlainValidator(validate_open_enum(False))
+    ] = InputOpenTelemetryMode.ALWAYS
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
     max_buffer_size: Annotated[
@@ -79,20 +98,43 @@ class InputOpenTelemetryPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputOpenTelemetryCompression] = (
-        InputOpenTelemetryCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputOpenTelemetryCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOpenTelemetryCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputOpenTelemetryPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputOpenTelemetryMinimumTLSVersion(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputOpenTelemetryMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputOpenTelemetryMaximumTLSVersion(str, Enum):
+class InputOpenTelemetryMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -101,6 +143,12 @@ class InputOpenTelemetryMaximumTLSVersion(str, Enum):
 
 class InputOpenTelemetryTLSSettingsServerSideTypedDict(TypedDict):
     disabled: NotRequired[bool]
+    request_cert: NotRequired[bool]
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+    reject_unauthorized: NotRequired[bool]
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+    common_name_regex: NotRequired[str]
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
     certificate_name: NotRequired[str]
     r"""The name of the predefined certificate"""
     priv_key_path: NotRequired[str]
@@ -111,10 +159,6 @@ class InputOpenTelemetryTLSSettingsServerSideTypedDict(TypedDict):
     r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
     ca_path: NotRequired[str]
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
-    request_cert: NotRequired[bool]
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-    reject_unauthorized: NotRequired[Any]
-    common_name_regex: NotRequired[Any]
     min_version: NotRequired[InputOpenTelemetryMinimumTLSVersion]
     max_version: NotRequired[InputOpenTelemetryMaximumTLSVersion]
 
@@ -122,6 +166,19 @@ class InputOpenTelemetryTLSSettingsServerSideTypedDict(TypedDict):
 class InputOpenTelemetryTLSSettingsServerSide(BaseModel):
     disabled: Optional[bool] = True
 
+    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+
+    reject_unauthorized: Annotated[
+        Optional[bool], pydantic.Field(alias="rejectUnauthorized")
+    ] = True
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+
+    common_name_regex: Annotated[
+        Optional[str], pydantic.Field(alias="commonNameRegex")
+    ] = "/.*/"
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
+
     certificate_name: Annotated[
         Optional[str], pydantic.Field(alias="certificateName")
     ] = None
@@ -139,43 +196,60 @@ class InputOpenTelemetryTLSSettingsServerSide(BaseModel):
     ca_path: Annotated[Optional[str], pydantic.Field(alias="caPath")] = None
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
 
-    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-
-    reject_unauthorized: Annotated[
-        Optional[Any], pydantic.Field(alias="rejectUnauthorized")
-    ] = None
-
-    common_name_regex: Annotated[
-        Optional[Any], pydantic.Field(alias="commonNameRegex")
-    ] = None
-
     min_version: Annotated[
-        Optional[InputOpenTelemetryMinimumTLSVersion],
+        Annotated[
+            Optional[InputOpenTelemetryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputOpenTelemetryMaximumTLSVersion],
+        Annotated[
+            Optional[InputOpenTelemetryMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="maxVersion"),
     ] = None
 
-
-class InputOpenTelemetryProtocol(str, Enum):
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputOpenTelemetryProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select whether to leverage gRPC or HTTP for OpenTelemetry"""
 
+    # gRPC
     GRPC = "grpc"
+    # HTTP
     HTTP = "http"
 
 
-class InputOpenTelemetryOTLPVersion(str, Enum):
+class InputOpenTelemetryOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The version of OTLP Protobuf definitions to use when interpreting received data"""
 
+    # 0.10.0
     ZERO_DOT_10_DOT_0 = "0.10.0"
+    # 1.3.1
     ONE_DOT_3_DOT_1 = "1.3.1"
 
 
-class InputOpenTelemetryAuthenticationType(str, Enum):
+class InputOpenTelemetryAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""OpenTelemetry authentication type"""
 
     NONE = "none"
@@ -404,7 +478,9 @@ class InputOpenTelemetry(BaseModel):
     ] = "/^$/"
     r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
 
-    protocol: Optional[InputOpenTelemetryProtocol] = InputOpenTelemetryProtocol.GRPC
+    protocol: Annotated[
+        Optional[InputOpenTelemetryProtocol], PlainValidator(validate_open_enum(False))
+    ] = InputOpenTelemetryProtocol.GRPC
     r"""Select whether to leverage gRPC or HTTP for OpenTelemetry"""
 
     extract_spans: Annotated[Optional[bool], pydantic.Field(alias="extractSpans")] = (
@@ -418,12 +494,20 @@ class InputOpenTelemetry(BaseModel):
     r"""Enable to extract each incoming Gauge or IntGauge metric to multiple events, one per data point"""
 
     otlp_version: Annotated[
-        Optional[InputOpenTelemetryOTLPVersion], pydantic.Field(alias="otlpVersion")
+        Annotated[
+            Optional[InputOpenTelemetryOTLPVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="otlpVersion"),
     ] = InputOpenTelemetryOTLPVersion.ZERO_DOT_10_DOT_0
     r"""The version of OTLP Protobuf definitions to use when interpreting received data"""
 
     auth_type: Annotated[
-        Optional[InputOpenTelemetryAuthenticationType], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputOpenTelemetryAuthenticationType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputOpenTelemetryAuthenticationType.NONE
     r"""OpenTelemetry authentication type"""
 
@@ -492,3 +576,30 @@ class InputOpenTelemetry(BaseModel):
 
     extract_logs: Annotated[Optional[bool], pydantic.Field(alias="extractLogs")] = False
     r"""Enable to extract each incoming log record to a separate event"""
+
+    @field_serializer("protocol")
+    def serialize_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryProtocol(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("otlp_version")
+    def serialize_otlp_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryOTLPVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryAuthenticationType(value)
+            except ValueError:
+                return value
+        return value