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

cribl_control_plane/models/inputappscope.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 InputAppscopeConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputAppscopeMode(str, Enum):
+class InputAppscopeMode(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 InputAppscopeCompression(str, Enum):
+class InputAppscopeCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputAppscopePqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputAppscopePqControls(BaseModel):
+    pass
+
+
 class InputAppscopePqTypedDict(TypedDict):
     mode: NotRequired[InputAppscopeMode]
     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 InputAppscopePqTypedDict(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[InputAppscopeCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputAppscopePqControlsTypedDict]
 
 
 class InputAppscopePq(BaseModel):
-    mode: Optional[InputAppscopeMode] = InputAppscopeMode.ALWAYS
+    mode: Annotated[
+        Optional[InputAppscopeMode], PlainValidator(validate_open_enum(False))
+    ] = InputAppscopeMode.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,9 +98,33 @@ class InputAppscopePq(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[InputAppscopeCompression] = InputAppscopeCompression.NONE
+    compress: Annotated[
+        Optional[InputAppscopeCompression], PlainValidator(validate_open_enum(False))
+    ] = InputAppscopeCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputAppscopePqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputAppscopeMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputAppscopeCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputAppscopeMetadatumTypedDict(TypedDict):
     name: str
@@ -131,7 +174,7 @@ class InputAppscopeFilter(BaseModel):
     r"""To override the UNIX domain socket or address/port specified in General Settings (while leaving Authentication settings as is), enter a URL."""
 
 
-class InputAppscopeDataCompressionFormat(str, Enum):
+class InputAppscopeDataCompressionFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     NONE = "none"
     GZIP = "gzip"
 
@@ -163,31 +206,41 @@ class InputAppscopePersistence(BaseModel):
     max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
     r"""Maximum amount of time to retain data (examples: 2h, 4d). When limit is reached, older data will be deleted."""
 
-    compress: Optional[InputAppscopeDataCompressionFormat] = (
-        InputAppscopeDataCompressionFormat.GZIP
-    )
+    compress: Annotated[
+        Optional[InputAppscopeDataCompressionFormat],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputAppscopeDataCompressionFormat.GZIP
 
     dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = (
         "$CRIBL_HOME/state/appscope"
     )
     r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/appscope"""
 
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputAppscopeDataCompressionFormat(value)
+            except ValueError:
+                return value
+        return value
 
-class InputAppscopeAuthenticationMethod(str, Enum):
+
+class InputAppscopeAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
     SECRET = "secret"
 
 
-class InputAppscopeMinimumTLSVersion(str, Enum):
+class InputAppscopeMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputAppscopeMaximumTLSVersion(str, Enum):
+class InputAppscopeMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -196,6 +249,12 @@ class InputAppscopeMaximumTLSVersion(str, Enum):
 
 class InputAppscopeTLSSettingsServerSideTypedDict(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]
@@ -206,10 +265,6 @@ class InputAppscopeTLSSettingsServerSideTypedDict(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[InputAppscopeMinimumTLSVersion]
     max_version: NotRequired[InputAppscopeMaximumTLSVersion]
 
@@ -217,6 +272,19 @@ class InputAppscopeTLSSettingsServerSideTypedDict(TypedDict):
 class InputAppscopeTLSSettingsServerSide(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
@@ -234,25 +302,40 @@ class InputAppscopeTLSSettingsServerSide(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[InputAppscopeMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputAppscopeMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputAppscopeMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputAppscopeMaximumTLSVersion],
+            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.InputAppscopeMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputAppscopeMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputAppscopeTypedDict(TypedDict):
     type: InputAppscopeType
@@ -397,7 +480,11 @@ class InputAppscope(BaseModel):
     persistence: Optional[InputAppscopePersistence] = None
 
     auth_type: Annotated[
-        Optional[InputAppscopeAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputAppscopeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputAppscopeAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
@@ -426,3 +513,12 @@ class InputAppscope(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.InputAppscopeAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputazureblob.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 List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -23,20 +27,32 @@ class InputAzureBlobConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputAzureBlobMode(str, Enum):
+class InputAzureBlobMode(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 InputAzureBlobCompression(str, Enum):
+class InputAzureBlobCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputAzureBlobPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputAzureBlobPqControls(BaseModel):
+    pass
+
+
 class InputAzureBlobPqTypedDict(TypedDict):
     mode: NotRequired[InputAzureBlobMode]
     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 InputAzureBlobPqTypedDict(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[InputAzureBlobCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputAzureBlobPqControlsTypedDict]
 
 
 class InputAzureBlobPq(BaseModel):
-    mode: Optional[InputAzureBlobMode] = InputAzureBlobMode.ALWAYS
+    mode: Annotated[
+        Optional[InputAzureBlobMode], PlainValidator(validate_open_enum(False))
+    ] = InputAzureBlobMode.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,9 +98,33 @@ class InputAzureBlobPq(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[InputAzureBlobCompression] = InputAzureBlobCompression.NONE
+    compress: Annotated[
+        Optional[InputAzureBlobCompression], PlainValidator(validate_open_enum(False))
+    ] = InputAzureBlobCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputAzureBlobPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputAzureBlobMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputAzureBlobCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputAzureBlobMetadatumTypedDict(TypedDict):
     name: str
@@ -96,7 +139,7 @@ class InputAzureBlobMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputAzureBlobAuthenticationMethod(str, Enum):
+class InputAzureBlobAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     MANUAL = "manual"
     SECRET = "secret"
     CLIENT_SECRET = "clientSecret"
@@ -257,7 +300,11 @@ class InputAzureBlob(BaseModel):
     r"""The maximum time allowed for downloading a Parquet chunk. Processing will stop if a chunk cannot be downloaded within the time specified."""
 
     auth_type: Annotated[
-        Optional[InputAzureBlobAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputAzureBlobAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputAzureBlobAuthenticationMethod.MANUAL
 
     description: Optional[str] = None
@@ -295,3 +342,12 @@ class InputAzureBlob(BaseModel):
     r"""Select or create a stored text secret"""
 
     certificate: Optional[InputAzureBlobCertificate] = None
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputAzureBlobAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value