cribl-control-plane 0.3.0b3__py3-none-any.whl → 0.3.0b12__py3-none-any.whl

cribl_control_plane/models/inputtcpjson.py

@@ -1,13 +1,14 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from cribl_control_plane import utils
+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 import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -106,6 +107,24 @@ class InputTcpjsonPq(BaseModel):
         Optional[InputTcpjsonPqControls], pydantic.Field(alias="pqControls")
     ] = None
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputTcpjsonMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputTcpjsonCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputTcpjsonMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
@@ -123,6 +142,12 @@ class InputTcpjsonMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
 
 class InputTcpjsonTLSSettingsServerSideTypedDict(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]
@@ -133,10 +158,6 @@ class InputTcpjsonTLSSettingsServerSideTypedDict(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[InputTcpjsonMinimumTLSVersion]
     max_version: NotRequired[InputTcpjsonMaximumTLSVersion]
 
@@ -144,6 +165,19 @@ class InputTcpjsonTLSSettingsServerSideTypedDict(TypedDict):
 class InputTcpjsonTLSSettingsServerSide(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
@@ -161,17 +195,6 @@ class InputTcpjsonTLSSettingsServerSide(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[
         Annotated[
             Optional[InputTcpjsonMinimumTLSVersion],
@@ -188,6 +211,24 @@ class InputTcpjsonTLSSettingsServerSide(BaseModel):
         pydantic.Field(alias="maxVersion"),
     ] = None
 
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputTcpjsonMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputTcpjsonMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputTcpjsonMetadatumTypedDict(TypedDict):
     name: str
@@ -349,3 +390,12 @@ class InputTcpjson(BaseModel):
 
     text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
     r"""Select or create a stored text secret"""
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputTcpjsonAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputwef.py

@@ -1,11 +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 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
@@ -106,6 +107,24 @@ class InputWefPq(BaseModel):
         Optional[InputWefPqControls], pydantic.Field(alias="pqControls")
     ] = None
 
+    @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"""
@@ -221,6 +240,24 @@ 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."""
 
+    @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"""
@@ -321,6 +358,24 @@ class Subscription(BaseModel):
     metadata: Optional[List[SubscriptionMetadatum]] = None
     r"""Fields to add to events ingested under this subscription"""
 
+    @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
@@ -515,3 +570,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

cribl_control_plane/models/inputwindowsmetrics.py

@@ -1,11 +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 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 List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
@@ -107,6 +108,24 @@ class InputWindowsMetricsPq(BaseModel):
         Optional[InputWindowsMetricsPqControls], pydantic.Field(alias="pqControls")
     ] = None
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsPqMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsHostMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select level of detail for host metrics"""
@@ -151,6 +170,15 @@ class InputWindowsMetricsSystem(BaseModel):
     detail: Optional[bool] = False
     r"""Generate metrics for all system information"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsSystemMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsCPUMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for CPU metrics"""
@@ -191,6 +219,15 @@ class InputWindowsMetricsCPU(BaseModel):
     time: Optional[bool] = False
     r"""Generate raw, monotonic CPU time counters"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsCPUMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsMemoryMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for memory metrics"""
@@ -222,6 +259,15 @@ class InputWindowsMetricsMemory(BaseModel):
     detail: Optional[bool] = False
     r"""Generate metrics for all memory states"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsMemoryMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for network metrics"""
@@ -239,12 +285,14 @@ class InputWindowsMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
 class InputWindowsMetricsNetworkTypedDict(TypedDict):
     mode: NotRequired[InputWindowsMetricsNetworkMode]
     r"""Select the level of details for network metrics"""
+    detail: NotRequired[bool]
+    r"""Generate full network metrics"""
+    protocols: NotRequired[bool]
+    r"""Generate protocol metrics for ICMP, ICMPMsg, IP, TCP, UDP and UDPLite"""
     devices: NotRequired[List[str]]
     r"""Network interfaces to include/exclude. All interfaces are included if this list is empty."""
     per_interface: NotRequired[bool]
     r"""Generate separate metrics for each interface"""
-    detail: NotRequired[bool]
-    r"""Generate full network metrics"""
 
 
 class InputWindowsMetricsNetwork(BaseModel):
@@ -254,6 +302,12 @@ class InputWindowsMetricsNetwork(BaseModel):
     ] = InputWindowsMetricsNetworkMode.BASIC
     r"""Select the level of details for network metrics"""
 
+    detail: Optional[bool] = False
+    r"""Generate full network metrics"""
+
+    protocols: Optional[bool] = False
+    r"""Generate protocol metrics for ICMP, ICMPMsg, IP, TCP, UDP and UDPLite"""
+
     devices: Optional[List[str]] = None
     r"""Network interfaces to include/exclude. All interfaces are included if this list is empty."""
 
@@ -262,8 +316,14 @@ class InputWindowsMetricsNetwork(BaseModel):
     )
     r"""Generate separate metrics for each interface"""
 
-    detail: Optional[bool] = False
-    r"""Generate full network metrics"""
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsNetworkMode(value)
+            except ValueError:
+                return value
+        return value
 
 
 class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
@@ -282,10 +342,12 @@ class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
 class InputWindowsMetricsDiskTypedDict(TypedDict):
     mode: NotRequired[InputWindowsMetricsDiskMode]
     r"""Select the level of details for disk metrics"""
-    volumes: NotRequired[List[str]]
-    r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
     per_volume: NotRequired[bool]
     r"""Generate separate metrics for each volume"""
+    detail: NotRequired[bool]
+    r"""Generate full disk metrics"""
+    volumes: NotRequired[List[str]]
+    r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
 
 
 class InputWindowsMetricsDisk(BaseModel):
@@ -294,11 +356,23 @@ class InputWindowsMetricsDisk(BaseModel):
     ] = InputWindowsMetricsDiskMode.BASIC
     r"""Select the level of details for disk metrics"""
 
+    per_volume: Annotated[Optional[bool], pydantic.Field(alias="perVolume")] = False
+    r"""Generate separate metrics for each volume"""
+
+    detail: Optional[bool] = False
+    r"""Generate full disk metrics"""
+
     volumes: Optional[List[str]] = None
     r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
 
-    per_volume: Annotated[Optional[bool], pydantic.Field(alias="perVolume")] = False
-    r"""Generate separate metrics for each volume"""
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsDiskMode(value)
+            except ValueError:
+                return value
+        return value
 
 
 class InputWindowsMetricsCustomTypedDict(TypedDict):
@@ -335,6 +409,15 @@ class InputWindowsMetricsHost(BaseModel):
 
     custom: Optional[InputWindowsMetricsCustom] = None
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsHostMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsSetTypedDict(TypedDict):
     name: str
@@ -417,6 +500,15 @@ class InputWindowsMetricsPersistence(BaseModel):
     )
     r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/windows_metrics"""
 
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsDataCompressionFormat(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsTypedDict(TypedDict):
     type: InputWindowsMetricsType

cribl_control_plane/models/inputwineventlogs.py

@@ -1,11 +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 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 List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
@@ -107,6 +108,24 @@ class InputWinEventLogsPq(BaseModel):
         Optional[InputWinEventLogsPqControls], pydantic.Field(alias="pqControls")
     ] = None
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWinEventLogsMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWinEventLogsCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class ReadMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Read all stored and future event logs, or only future events"""
@@ -174,6 +193,10 @@ class InputWinEventLogsTypedDict(TypedDict):
     max_event_bytes: NotRequired[float]
     r"""The maximum number of bytes in an event before it is flushed to the pipelines"""
     description: NotRequired[str]
+    disable_json_rendering: NotRequired[bool]
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
+    disable_xml_rendering: NotRequired[bool]
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
 
 
 class InputWinEventLogs(BaseModel):
@@ -241,3 +264,31 @@ class InputWinEventLogs(BaseModel):
     r"""The maximum number of bytes in an event before it is flushed to the pipelines"""
 
     description: Optional[str] = None
+
+    disable_json_rendering: Annotated[
+        Optional[bool], pydantic.Field(alias="disableJsonRendering")
+    ] = False
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
+
+    disable_xml_rendering: Annotated[
+        Optional[bool], pydantic.Field(alias="disableXmlRendering")
+    ] = True
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
+
+    @field_serializer("read_mode")
+    def serialize_read_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ReadMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("event_format")
+    def serialize_event_format(self, value):
+        if isinstance(value, str):
+            try:
+                return models.EventFormat(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputwiz.py

@@ -1,11 +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 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 List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
@@ -106,6 +107,24 @@ class InputWizPq(BaseModel):
         Optional[InputWizPqControls], pydantic.Field(alias="pqControls")
     ] = None
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWizMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWizCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWizContentConfigTypedDict(TypedDict):
     content_type: str
@@ -201,6 +220,15 @@ class InputWizRetryRules(BaseModel):
     ] = False
     r"""Retry request when a connection reset (ECONNRESET) error occurs"""
 
+    @field_serializer("type")
+    def serialize_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWizRetryType(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWizAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Enter client secret directly, or select a stored secret"""
@@ -352,3 +380,12 @@ class InputWiz(BaseModel):
 
     text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
     r"""Select or create a stored text secret"""
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWizAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value