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

cribl_control_plane/models/{inputsyslog_union.py → inputsyslog.py}

@@ -1,10 +1,14 @@
 """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 typing import Any, List, Optional, Union
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -23,20 +27,32 @@ class InputSyslogConnection2(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSyslogMode2(str, Enum):
+class InputSyslogMode2(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 InputSyslogCompression2(str, Enum):
+class InputSyslogCompression2(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSyslogPqControls2TypedDict(TypedDict):
+    pass
+
+
+class InputSyslogPqControls2(BaseModel):
+    pass
+
+
 class InputSyslogPq2TypedDict(TypedDict):
     mode: NotRequired[InputSyslogMode2]
     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 InputSyslogPq2TypedDict(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[InputSyslogCompression2]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSyslogPqControls2TypedDict]
 
 
 class InputSyslogPq2(BaseModel):
-    mode: Optional[InputSyslogMode2] = InputSyslogMode2.ALWAYS
+    mode: Annotated[
+        Optional[InputSyslogMode2], PlainValidator(validate_open_enum(False))
+    ] = InputSyslogMode2.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,18 +98,42 @@ class InputSyslogPq2(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[InputSyslogCompression2] = InputSyslogCompression2.NONE
+    compress: Annotated[
+        Optional[InputSyslogCompression2], PlainValidator(validate_open_enum(False))
+    ] = InputSyslogCompression2.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSyslogPqControls2], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSyslogMinimumTLSVersion2(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogMode2(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogCompression2(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSyslogMinimumTLSVersion2(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputSyslogMaximumTLSVersion2(str, Enum):
+class InputSyslogMaximumTLSVersion2(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -99,6 +142,12 @@ class InputSyslogMaximumTLSVersion2(str, Enum):
 
 class InputSyslogTLSSettingsServerSide2TypedDict(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]
@@ -109,10 +158,6 @@ class InputSyslogTLSSettingsServerSide2TypedDict(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[InputSyslogMinimumTLSVersion2]
     max_version: NotRequired[InputSyslogMaximumTLSVersion2]
 
@@ -120,6 +165,19 @@ class InputSyslogTLSSettingsServerSide2TypedDict(TypedDict):
 class InputSyslogTLSSettingsServerSide2(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
@@ -137,25 +195,40 @@ class InputSyslogTLSSettingsServerSide2(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[InputSyslogMinimumTLSVersion2], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputSyslogMinimumTLSVersion2],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputSyslogMaximumTLSVersion2], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputSyslogMaximumTLSVersion2],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogMinimumTLSVersion2(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogMaximumTLSVersion2(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSyslogMetadatum2TypedDict(TypedDict):
     name: str
@@ -381,20 +454,32 @@ class InputSyslogConnection1(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSyslogMode1(str, Enum):
+class InputSyslogMode1(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 InputSyslogCompression1(str, Enum):
+class InputSyslogCompression1(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSyslogPqControls1TypedDict(TypedDict):
+    pass
+
+
+class InputSyslogPqControls1(BaseModel):
+    pass
+
+
 class InputSyslogPq1TypedDict(TypedDict):
     mode: NotRequired[InputSyslogMode1]
     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."""
@@ -410,10 +495,13 @@ class InputSyslogPq1TypedDict(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[InputSyslogCompression1]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSyslogPqControls1TypedDict]
 
 
 class InputSyslogPq1(BaseModel):
-    mode: Optional[InputSyslogMode1] = InputSyslogMode1.ALWAYS
+    mode: Annotated[
+        Optional[InputSyslogMode1], PlainValidator(validate_open_enum(False))
+    ] = InputSyslogMode1.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[
@@ -437,18 +525,42 @@ class InputSyslogPq1(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[InputSyslogCompression1] = InputSyslogCompression1.NONE
+    compress: Annotated[
+        Optional[InputSyslogCompression1], PlainValidator(validate_open_enum(False))
+    ] = InputSyslogCompression1.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSyslogPqControls1], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSyslogMinimumTLSVersion1(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogMode1(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogCompression1(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSyslogMinimumTLSVersion1(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputSyslogMaximumTLSVersion1(str, Enum):
+class InputSyslogMaximumTLSVersion1(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -457,6 +569,12 @@ class InputSyslogMaximumTLSVersion1(str, Enum):
 
 class InputSyslogTLSSettingsServerSide1TypedDict(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]
@@ -467,10 +585,6 @@ class InputSyslogTLSSettingsServerSide1TypedDict(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[InputSyslogMinimumTLSVersion1]
     max_version: NotRequired[InputSyslogMaximumTLSVersion1]
 
@@ -478,6 +592,19 @@ class InputSyslogTLSSettingsServerSide1TypedDict(TypedDict):
 class InputSyslogTLSSettingsServerSide1(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
@@ -495,25 +622,40 @@ class InputSyslogTLSSettingsServerSide1(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[InputSyslogMinimumTLSVersion1], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputSyslogMinimumTLSVersion1],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputSyslogMaximumTLSVersion1], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputSyslogMaximumTLSVersion1],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogMinimumTLSVersion1(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSyslogMaximumTLSVersion1(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSyslogMetadatum1TypedDict(TypedDict):
     name: str
@@ -724,12 +866,12 @@ class InputSyslogSyslog1(BaseModel):
     r"""When enabled, parses PROXY protocol headers during the TLS handshake. Disable if compatibility issues arise."""
 
 
-InputSyslogUnionTypedDict = TypeAliasType(
-    "InputSyslogUnionTypedDict",
+InputSyslogTypedDict = TypeAliasType(
+    "InputSyslogTypedDict",
     Union[InputSyslogSyslog1TypedDict, InputSyslogSyslog2TypedDict],
 )
 
 
-InputSyslogUnion = TypeAliasType(
-    "InputSyslogUnion", Union[InputSyslogSyslog1, InputSyslogSyslog2]
+InputSyslog = TypeAliasType(
+    "InputSyslog", Union[InputSyslogSyslog1, InputSyslogSyslog2]
 )