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

cribl_control_plane/models/inputwef.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 InputWefConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputWefMode(str, Enum):
+class InputWefMode(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 InputWefCompression(str, Enum):
+class InputWefCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputWefPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputWefPqControls(BaseModel):
+    pass
+
+
 class InputWefPqTypedDict(TypedDict):
     mode: NotRequired[InputWefMode]
     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 InputWefPqTypedDict(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[InputWefCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputWefPqControlsTypedDict]
 
 
 class InputWefPq(BaseModel):
-    mode: Optional[InputWefMode] = InputWefMode.ALWAYS
+    mode: Annotated[
+        Optional[InputWefMode], PlainValidator(validate_open_enum(False))
+    ] = InputWefMode.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,25 +98,51 @@ class InputWefPq(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[InputWefCompression] = InputWefCompression.NONE
+    compress: Annotated[
+        Optional[InputWefCompression], PlainValidator(validate_open_enum(False))
+    ] = InputWefCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputWefPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputWefAuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWefMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWefCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputWefAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to authenticate incoming client connections"""
 
+    # Client certificate
     CLIENT_CERT = "clientCert"
+    # Kerberos
     KERBEROS = "kerberos"
 
 
-class InputWefMinimumTLSVersion(str, Enum):
+class InputWefMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputWefMaximumTLSVersion(str, Enum):
+class InputWefMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -168,11 +213,19 @@ class MTLSSettings(BaseModel):
     r"""Regex matching allowable common names in peer certificates' subject attribute"""
 
     min_version: Annotated[
-        Optional[InputWefMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputWefMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputWefMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputWefMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
     ocsp_check: Annotated[Optional[bool], pydantic.Field(alias="ocspCheck")] = False
@@ -187,32 +240,65 @@ class MTLSSettings(BaseModel):
     ] = False
     r"""If enabled, checks will fail on any OCSP error. Otherwise, checks will fail only when a certificate is revoked, ignoring other errors."""
 
-
-class InputWefFormat(str, Enum):
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWefMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWefMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputWefFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Content format in which the endpoint should deliver events"""
 
     RAW = "Raw"
     RENDERED_TEXT = "RenderedText"
 
 
-class QueryBuilderMode(str, Enum):
+class QueryBuilderMode(str, Enum, metaclass=utils.OpenEnumMeta):
     SIMPLE = "simple"
     XML = "xml"
 
 
-class InputWefSubscriptionMetadatumTypedDict(TypedDict):
+class SubscriptionMetadatumTypedDict(TypedDict):
     name: str
     value: str
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputWefSubscriptionMetadatum(BaseModel):
+class SubscriptionMetadatum(BaseModel):
     name: str
 
     value: str
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
+class QueryTypedDict(TypedDict):
+    path: str
+    r"""The Path attribute from the relevant XML Select element"""
+    query_expression: str
+    r"""The XPath query inside the relevant XML Select element"""
+
+
+class Query(BaseModel):
+    path: str
+    r"""The Path attribute from the relevant XML Select element"""
+
+    query_expression: Annotated[str, pydantic.Field(alias="queryExpression")]
+    r"""The XPath query inside the relevant XML Select element"""
+
+
 class SubscriptionTypedDict(TypedDict):
     subscription_name: str
     targets: List[str]
@@ -234,8 +320,11 @@ class SubscriptionTypedDict(TypedDict):
     locale: NotRequired[str]
     r"""The RFC-3066 locale the Windows clients should use when sending events. Defaults to \"en-US\"."""
     query_selector: NotRequired[QueryBuilderMode]
-    metadata: NotRequired[List[InputWefSubscriptionMetadatumTypedDict]]
+    metadata: NotRequired[List[SubscriptionMetadatumTypedDict]]
     r"""Fields to add to events ingested under this subscription"""
+    queries: NotRequired[List[QueryTypedDict]]
+    xml_query: NotRequired[str]
+    r"""The XPath query to use for selecting events"""
 
 
 class Subscription(BaseModel):
@@ -248,7 +337,8 @@ class Subscription(BaseModel):
     r"""Version UUID for this subscription. If any subscription parameters are modified, this value will change."""
 
     content_format: Annotated[
-        Optional[InputWefFormat], pydantic.Field(alias="contentFormat")
+        Annotated[Optional[InputWefFormat], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="contentFormat"),
     ] = InputWefFormat.RAW
     r"""Content format in which the endpoint should deliver events"""
 
@@ -277,12 +367,38 @@ class Subscription(BaseModel):
     r"""The RFC-3066 locale the Windows clients should use when sending events. Defaults to \"en-US\"."""
 
     query_selector: Annotated[
-        Optional[QueryBuilderMode], pydantic.Field(alias="querySelector")
+        Annotated[
+            Optional[QueryBuilderMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="querySelector"),
     ] = QueryBuilderMode.SIMPLE
 
-    metadata: Optional[List[InputWefSubscriptionMetadatum]] = None
+    metadata: Optional[List[SubscriptionMetadatum]] = None
     r"""Fields to add to events ingested under this subscription"""
 
+    queries: Optional[List[Query]] = None
+
+    xml_query: Annotated[Optional[str], pydantic.Field(alias="xmlQuery")] = None
+    r"""The XPath query to use for selecting events"""
+
+    @field_serializer("content_format")
+    def serialize_content_format(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWefFormat(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("query_selector")
+    def serialize_query_selector(self, value):
+        if isinstance(value, str):
+            try:
+                return models.QueryBuilderMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWefMetadatumTypedDict(TypedDict):
     name: str
@@ -298,11 +414,11 @@ class InputWefMetadatum(BaseModel):
 
 
 class InputWefTypedDict(TypedDict):
+    type: InputWefType
     subscriptions: List[SubscriptionTypedDict]
     r"""Subscriptions to events on forwarding endpoints"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputWefType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -358,14 +474,14 @@ class InputWefTypedDict(TypedDict):
 
 
 class InputWef(BaseModel):
+    type: InputWefType
+
     subscriptions: List[Subscription]
     r"""Subscriptions to events on forwarding endpoints"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputWefType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -397,7 +513,11 @@ class InputWef(BaseModel):
     r"""Port to listen on"""
 
     auth_method: Annotated[
-        Optional[InputWefAuthenticationMethod], pydantic.Field(alias="authMethod")
+        Annotated[
+            Optional[InputWefAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authMethod"),
     ] = InputWefAuthenticationMethod.CLIENT_CERT
     r"""How to authenticate incoming client connections"""
 
@@ -473,3 +593,12 @@ class InputWef(BaseModel):
         Optional[bool], pydantic.Field(alias="logFingerprintMismatch")
     ] = False
     r"""Log a warning if the client certificate authority (CA) fingerprint does not match the expected value. A mismatch prevents Cribl from receiving events from the Windows Event Forwarder."""
+
+    @field_serializer("auth_method")
+    def serialize_auth_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWefAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value