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

cribl_control_plane/models/inputsnmp.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
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -23,20 +27,32 @@ class InputSnmpConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSnmpMode(str, Enum):
+class InputSnmpMode(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 InputSnmpCompression(str, Enum):
+class InputSnmpCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSnmpPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSnmpPqControls(BaseModel):
+    pass
+
+
 class InputSnmpPqTypedDict(TypedDict):
     mode: NotRequired[InputSnmpMode]
     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 InputSnmpPqTypedDict(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[InputSnmpCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSnmpPqControlsTypedDict]
 
 
 class InputSnmpPq(BaseModel):
-    mode: Optional[InputSnmpMode] = InputSnmpMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSnmpMode], PlainValidator(validate_open_enum(False))
+    ] = InputSnmpMode.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,39 +98,109 @@ class InputSnmpPq(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[InputSnmpCompression] = InputSnmpCompression.NONE
+    compress: Annotated[
+        Optional[InputSnmpCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSnmpCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSnmpPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class AuthenticationProtocol(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSnmpMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSnmpCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSnmpAuthenticationProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
+    # None
     NONE = "none"
+    # MD5
     MD5 = "md5"
+    # SHA1
     SHA = "sha"
+    # SHA224
     SHA224 = "sha224"
+    # SHA256
     SHA256 = "sha256"
+    # SHA384
     SHA384 = "sha384"
+    # SHA512
     SHA512 = "sha512"
 
 
-class V3UserTypedDict(TypedDict):
-    name: str
-    auth_protocol: NotRequired[AuthenticationProtocol]
-    auth_key: NotRequired[Any]
-    priv_protocol: NotRequired[str]
+class PrivacyProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
+    # None
+    NONE = "none"
+    # DES
+    DES = "des"
+    # AES128
+    AES = "aes"
+    # AES256b (Blumenthal)
+    AES256B = "aes256b"
+    # AES256r (Reeder)
+    AES256R = "aes256r"
 
 
-class V3User(BaseModel):
+class InputSnmpV3UserTypedDict(TypedDict):
     name: str
+    auth_protocol: NotRequired[InputSnmpAuthenticationProtocol]
+    auth_key: NotRequired[str]
+    priv_protocol: NotRequired[PrivacyProtocol]
+    priv_key: NotRequired[str]
 
-    auth_protocol: Annotated[
-        Optional[AuthenticationProtocol], pydantic.Field(alias="authProtocol")
-    ] = AuthenticationProtocol.NONE
 
-    auth_key: Annotated[Optional[Any], pydantic.Field(alias="authKey")] = None
+class InputSnmpV3User(BaseModel):
+    name: str
 
-    priv_protocol: Annotated[Optional[str], pydantic.Field(alias="privProtocol")] = (
-        "none"
-    )
+    auth_protocol: Annotated[
+        Annotated[
+            Optional[InputSnmpAuthenticationProtocol],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authProtocol"),
+    ] = InputSnmpAuthenticationProtocol.NONE
+
+    auth_key: Annotated[Optional[str], pydantic.Field(alias="authKey")] = None
+
+    priv_protocol: Annotated[
+        Annotated[Optional[PrivacyProtocol], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="privProtocol"),
+    ] = PrivacyProtocol.NONE
+
+    priv_key: Annotated[Optional[str], pydantic.Field(alias="privKey")] = None
+
+    @field_serializer("auth_protocol")
+    def serialize_auth_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSnmpAuthenticationProtocol(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("priv_protocol")
+    def serialize_priv_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PrivacyProtocol(value)
+            except ValueError:
+                return value
+        return value
 
 
 class SNMPv3AuthenticationTypedDict(TypedDict):
@@ -120,7 +209,7 @@ class SNMPv3AuthenticationTypedDict(TypedDict):
     v3_auth_enabled: NotRequired[bool]
     allow_unmatched_trap: NotRequired[bool]
     r"""Pass through traps that don't match any of the configured users. @{product} will not attempt to decrypt these traps."""
-    v3_users: NotRequired[List[V3UserTypedDict]]
+    v3_users: NotRequired[List[InputSnmpV3UserTypedDict]]
     r"""User credentials for receiving v3 traps"""
 
 
@@ -136,7 +225,9 @@ class SNMPv3Authentication(BaseModel):
     ] = False
     r"""Pass through traps that don't match any of the configured users. @{product} will not attempt to decrypt these traps."""
 
-    v3_users: Annotated[Optional[List[V3User]], pydantic.Field(alias="v3Users")] = None
+    v3_users: Annotated[
+        Optional[List[InputSnmpV3User]], pydantic.Field(alias="v3Users")
+    ] = None
     r"""User credentials for receiving v3 traps"""
 
 

cribl_control_plane/models/inputsplunk.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
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -23,20 +27,32 @@ class InputSplunkConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSplunkMode(str, Enum):
+class InputSplunkMode(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 InputSplunkPqCompression(str, Enum):
+class InputSplunkPqCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSplunkPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSplunkPqControls(BaseModel):
+    pass
+
+
 class InputSplunkPqTypedDict(TypedDict):
     mode: NotRequired[InputSplunkMode]
     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 InputSplunkPqTypedDict(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[InputSplunkPqCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSplunkPqControlsTypedDict]
 
 
 class InputSplunkPq(BaseModel):
-    mode: Optional[InputSplunkMode] = InputSplunkMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSplunkMode], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkMode.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 InputSplunkPq(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[InputSplunkPqCompression] = InputSplunkPqCompression.NONE
+    compress: Annotated[
+        Optional[InputSplunkPqCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkPqCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSplunkPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSplunkMinimumTLSVersion(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkPqCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSplunkMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputSplunkMaximumTLSVersion(str, Enum):
+class InputSplunkMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -99,6 +142,12 @@ class InputSplunkMaximumTLSVersion(str, Enum):
 
 class InputSplunkTLSSettingsServerSideTypedDict(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 InputSplunkTLSSettingsServerSideTypedDict(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[InputSplunkMinimumTLSVersion]
     max_version: NotRequired[InputSplunkMaximumTLSVersion]
 
@@ -120,6 +165,19 @@ class InputSplunkTLSSettingsServerSideTypedDict(TypedDict):
 class InputSplunkTLSSettingsServerSide(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 InputSplunkTLSSettingsServerSide(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[InputSplunkMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputSplunkMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputSplunkMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputSplunkMaximumTLSVersion],
+            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.InputSplunkMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSplunkMetadatumTypedDict(TypedDict):
     name: str
@@ -183,18 +256,23 @@ class InputSplunkAuthToken(BaseModel):
     description: Optional[str] = None
 
 
-class InputSplunkMaxS2SVersion(str, Enum):
+class InputSplunkMaxS2SVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The highest S2S protocol version to advertise during handshake"""
 
+    # v3
     V3 = "v3"
+    # v4
     V4 = "v4"
 
 
-class InputSplunkCompression(str, Enum):
+class InputSplunkCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Controls whether to support reading compressed data from a forwarder. Select 'Automatic' to match the forwarder's configuration, or 'Disabled' to reject compressed connections."""
 
+    # Disabled
     DISABLED = "disabled"
+    # Automatic
     AUTO = "auto"
+    # Always
     ALWAYS = "always"
 
 
@@ -341,7 +419,11 @@ class InputSplunk(BaseModel):
     r"""Shared secrets to be provided by any Splunk forwarder. If empty, unauthorized access is permitted."""
 
     max_s2_sversion: Annotated[
-        Optional[InputSplunkMaxS2SVersion], pydantic.Field(alias="maxS2Sversion")
+        Annotated[
+            Optional[InputSplunkMaxS2SVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxS2Sversion"),
     ] = InputSplunkMaxS2SVersion.V3
     r"""The highest S2S protocol version to advertise during handshake"""
 
@@ -362,5 +444,25 @@ class InputSplunk(BaseModel):
     ] = False
     r"""Extract and process Splunk-generated metrics as Cribl metrics"""
 
-    compress: Optional[InputSplunkCompression] = InputSplunkCompression.DISABLED
+    compress: Annotated[
+        Optional[InputSplunkCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkCompression.DISABLED
     r"""Controls whether to support reading compressed data from a forwarder. Select 'Automatic' to match the forwarder's configuration, or 'Disabled' to reject compressed connections."""
+
+    @field_serializer("max_s2_sversion")
+    def serialize_max_s2_sversion(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkMaxS2SVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkCompression(value)
+            except ValueError:
+                return value
+        return value