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

cribl_control_plane/models/inputmodeldriventelemetry.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 InputModelDrivenTelemetryConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputModelDrivenTelemetryMode(str, Enum):
+class InputModelDrivenTelemetryMode(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 InputModelDrivenTelemetryCompression(str, Enum):
+class InputModelDrivenTelemetryCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputModelDrivenTelemetryPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputModelDrivenTelemetryPqControls(BaseModel):
+    pass
+
+
 class InputModelDrivenTelemetryPqTypedDict(TypedDict):
     mode: NotRequired[InputModelDrivenTelemetryMode]
     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,14 @@ class InputModelDrivenTelemetryPqTypedDict(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[InputModelDrivenTelemetryCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputModelDrivenTelemetryPqControlsTypedDict]
 
 
 class InputModelDrivenTelemetryPq(BaseModel):
-    mode: Optional[InputModelDrivenTelemetryMode] = InputModelDrivenTelemetryMode.ALWAYS
+    mode: Annotated[
+        Optional[InputModelDrivenTelemetryMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputModelDrivenTelemetryMode.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,20 +99,48 @@ class InputModelDrivenTelemetryPq(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[InputModelDrivenTelemetryCompression] = (
-        InputModelDrivenTelemetryCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputModelDrivenTelemetryCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputModelDrivenTelemetryCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputModelDrivenTelemetryPqControls],
+        pydantic.Field(alias="pqControls"),
+    ] = None
 
-class InputModelDrivenTelemetryMinimumTLSVersion(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputModelDrivenTelemetryMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputModelDrivenTelemetryCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputModelDrivenTelemetryMinimumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputModelDrivenTelemetryMaximumTLSVersion(str, Enum):
+class InputModelDrivenTelemetryMaximumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -101,18 +149,22 @@ class InputModelDrivenTelemetryMaximumTLSVersion(str, Enum):
 
 class InputModelDrivenTelemetryTLSSettingsServerSideTypedDict(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]
     r"""Path on server containing the private key to use. PEM format. Can reference $ENV_VARS."""
+    passphrase: NotRequired[str]
+    r"""Passphrase to use to decrypt private key"""
     cert_path: NotRequired[str]
     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[InputModelDrivenTelemetryMinimumTLSVersion]
     max_version: NotRequired[InputModelDrivenTelemetryMaximumTLSVersion]
 
@@ -120,6 +172,19 @@ class InputModelDrivenTelemetryTLSSettingsServerSideTypedDict(TypedDict):
 class InputModelDrivenTelemetryTLSSettingsServerSide(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
@@ -128,33 +193,49 @@ class InputModelDrivenTelemetryTLSSettingsServerSide(BaseModel):
     priv_key_path: Annotated[Optional[str], pydantic.Field(alias="privKeyPath")] = None
     r"""Path on server containing the private key to use. PEM format. Can reference $ENV_VARS."""
 
+    passphrase: Optional[str] = None
+    r"""Passphrase to use to decrypt private key"""
+
     cert_path: Annotated[Optional[str], pydantic.Field(alias="certPath")] = None
     r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
 
     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[InputModelDrivenTelemetryMinimumTLSVersion],
+        Annotated[
+            Optional[InputModelDrivenTelemetryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputModelDrivenTelemetryMaximumTLSVersion],
+        Annotated[
+            Optional[InputModelDrivenTelemetryMaximumTLSVersion],
+            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.InputModelDrivenTelemetryMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputModelDrivenTelemetryMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputModelDrivenTelemetryMetadatumTypedDict(TypedDict):
     name: str
@@ -170,9 +251,9 @@ class InputModelDrivenTelemetryMetadatum(BaseModel):
 
 
 class InputModelDrivenTelemetryTypedDict(TypedDict):
+    type: InputModelDrivenTelemetryType
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputModelDrivenTelemetryType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -202,11 +283,11 @@ class InputModelDrivenTelemetryTypedDict(TypedDict):
 
 
 class InputModelDrivenTelemetry(BaseModel):
+    type: InputModelDrivenTelemetryType
+
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputModelDrivenTelemetryType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/inputmsk.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 InputMskConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputMskMode(str, Enum):
+class InputMskMode(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 InputMskCompression(str, Enum):
+class InputMskCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputMskPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputMskPqControls(BaseModel):
+    pass
+
+
 class InputMskPqTypedDict(TypedDict):
     mode: NotRequired[InputMskMode]
     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 InputMskPqTypedDict(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[InputMskCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputMskPqControlsTypedDict]
 
 
 class InputMskPq(BaseModel):
-    mode: Optional[InputMskMode] = InputMskMode.ALWAYS
+    mode: Annotated[
+        Optional[InputMskMode], PlainValidator(validate_open_enum(False))
+    ] = InputMskMode.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 InputMskPq(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[InputMskCompression] = InputMskCompression.NONE
+    compress: Annotated[
+        Optional[InputMskCompression], PlainValidator(validate_open_enum(False))
+    ] = InputMskCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputMskPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputMskMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputMskCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputMskMetadatumTypedDict(TypedDict):
     name: str
@@ -115,14 +158,18 @@ class InputMskAuth(BaseModel):
     r"""Select or create a secret that references your credentials"""
 
 
-class InputMskKafkaSchemaRegistryMinimumTLSVersion(str, Enum):
+class InputMskKafkaSchemaRegistryMinimumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputMskKafkaSchemaRegistryMaximumTLSVersion(str, Enum):
+class InputMskKafkaSchemaRegistryMaximumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -182,15 +229,39 @@ class InputMskKafkaSchemaRegistryTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[InputMskKafkaSchemaRegistryMinimumTLSVersion],
+        Annotated[
+            Optional[InputMskKafkaSchemaRegistryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputMskKafkaSchemaRegistryMaximumTLSVersion],
+        Annotated[
+            Optional[InputMskKafkaSchemaRegistryMaximumTLSVersion],
+            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.InputMskKafkaSchemaRegistryMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputMskKafkaSchemaRegistryMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputMskKafkaSchemaRegistryAuthenticationTypedDict(TypedDict):
     disabled: NotRequired[bool]
@@ -234,29 +305,32 @@ class InputMskKafkaSchemaRegistryAuthentication(BaseModel):
     tls: Optional[InputMskKafkaSchemaRegistryTLSSettingsClientSide] = None
 
 
-class InputMskAuthenticationMethod(str, Enum):
+class InputMskAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 
-class InputMskSignatureVersion(str, Enum):
+class InputMskSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing MSK cluster requests"""
 
     V2 = "v2"
     V4 = "v4"
 
 
-class InputMskMinimumTLSVersion(str, Enum):
+class InputMskMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputMskMaximumTLSVersion(str, Enum):
+class InputMskMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -316,15 +390,42 @@ class InputMskTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[InputMskMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputMskMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputMskMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputMskMaximumTLSVersion],
+            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.InputMskMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputMskMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputMskTypedDict(TypedDict):
+    type: InputMskType
     brokers: List[str]
     r"""Enter each Kafka bootstrap server you want to use. Specify the hostname and port (such as mykafkabroker:9092) or just the hostname (in which case @{product} will assign port 9092)."""
     topics: List[str]
@@ -333,7 +434,6 @@ class InputMskTypedDict(TypedDict):
     r"""Region where the MSK cluster is located"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputMskType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -353,7 +453,8 @@ class InputMskTypedDict(TypedDict):
     from_beginning: NotRequired[bool]
     r"""Leave enabled if you want the Source, upon first subscribing to a topic, to read starting with the earliest available message"""
     session_timeout: NotRequired[float]
-    r"""Timeout used to detect client failures when using Kafka's group-management facilities.
+    r"""
+    Timeout used to detect client failures when using Kafka's group-management facilities.
     If the client sends no heartbeats to the broker before the timeout expires,
     the broker will remove the client from the group and initiate a rebalance.
     Value must be between the broker's configured group.min.session.timeout.ms and group.max.session.timeout.ms.
@@ -427,6 +528,8 @@ class InputMskTypedDict(TypedDict):
 
 
 class InputMsk(BaseModel):
+    type: InputMskType
+
     brokers: List[str]
     r"""Enter each Kafka bootstrap server you want to use. Specify the hostname and port (such as mykafkabroker:9092) or just the hostname (in which case @{product} will assign port 9092)."""
 
@@ -439,8 +542,6 @@ class InputMsk(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputMskType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -476,7 +577,8 @@ class InputMsk(BaseModel):
     session_timeout: Annotated[
         Optional[float], pydantic.Field(alias="sessionTimeout")
     ] = 30000
-    r"""Timeout used to detect client failures when using Kafka's group-management facilities.
+    r"""
+    Timeout used to detect client failures when using Kafka's group-management facilities.
     If the client sends no heartbeats to the broker before the timeout expires,
     the broker will remove the client from the group and initiate a rebalance.
     Value must be between the broker's configured group.min.session.timeout.ms and group.max.session.timeout.ms.
@@ -542,7 +644,10 @@ class InputMsk(BaseModel):
     r"""Specifies a time window during which @{product} can reauthenticate if needed. Creates the window measuring backward from the moment when credentials are set to expire."""
 
     aws_authentication_method: Annotated[
-        Optional[InputMskAuthenticationMethod],
+        Annotated[
+            Optional[InputMskAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = InputMskAuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -555,7 +660,11 @@ class InputMsk(BaseModel):
     r"""MSK cluster service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to MSK cluster-compatible endpoint."""
 
     signature_version: Annotated[
-        Optional[InputMskSignatureVersion], pydantic.Field(alias="signatureVersion")
+        Annotated[
+            Optional[InputMskSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="signatureVersion"),
     ] = InputMskSignatureVersion.V4
     r"""Signature version to use for signing MSK cluster requests"""
 
@@ -620,3 +729,21 @@ class InputMsk(BaseModel):
 
     aws_secret: Annotated[Optional[str], pydantic.Field(alias="awsSecret")] = None
     r"""Select or create a stored secret that references your access key and secret key"""
+
+    @field_serializer("aws_authentication_method")
+    def serialize_aws_authentication_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputMskAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputMskSignatureVersion(value)
+            except ValueError:
+                return value
+        return value