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

cribl_control_plane/models/inputkafka.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 InputKafkaConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputKafkaMode(str, Enum):
+class InputKafkaMode(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 InputKafkaCompression(str, Enum):
+class InputKafkaCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputKafkaPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputKafkaPqControls(BaseModel):
+    pass
+
+
 class InputKafkaPqTypedDict(TypedDict):
     mode: NotRequired[InputKafkaMode]
     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 InputKafkaPqTypedDict(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[InputKafkaCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputKafkaPqControlsTypedDict]
 
 
 class InputKafkaPq(BaseModel):
-    mode: Optional[InputKafkaMode] = InputKafkaMode.ALWAYS
+    mode: Annotated[
+        Optional[InputKafkaMode], PlainValidator(validate_open_enum(False))
+    ] = InputKafkaMode.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 InputKafkaPq(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[InputKafkaCompression] = InputKafkaCompression.NONE
+    compress: Annotated[
+        Optional[InputKafkaCompression], PlainValidator(validate_open_enum(False))
+    ] = InputKafkaCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputKafkaPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKafkaMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKafkaCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputKafkaAuthTypedDict(TypedDict):
     r"""Credentials to use when authenticating with the schema registry using basic HTTP authentication"""
@@ -102,14 +145,18 @@ class InputKafkaAuth(BaseModel):
     r"""Select or create a secret that references your credentials"""
 
 
-class InputKafkaKafkaSchemaRegistryMinimumTLSVersion(str, Enum):
+class InputKafkaKafkaSchemaRegistryMinimumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputKafkaKafkaSchemaRegistryMaximumTLSVersion(str, Enum):
+class InputKafkaKafkaSchemaRegistryMaximumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -169,15 +216,39 @@ class InputKafkaKafkaSchemaRegistryTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[InputKafkaKafkaSchemaRegistryMinimumTLSVersion],
+        Annotated[
+            Optional[InputKafkaKafkaSchemaRegistryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputKafkaKafkaSchemaRegistryMaximumTLSVersion],
+        Annotated[
+            Optional[InputKafkaKafkaSchemaRegistryMaximumTLSVersion],
+            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.InputKafkaKafkaSchemaRegistryMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKafkaKafkaSchemaRegistryMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputKafkaKafkaSchemaRegistryAuthenticationTypedDict(TypedDict):
     disabled: NotRequired[bool]
@@ -221,18 +292,76 @@ class InputKafkaKafkaSchemaRegistryAuthentication(BaseModel):
     tls: Optional[InputKafkaKafkaSchemaRegistryTLSSettingsClientSide] = None
 
 
-class InputKafkaSASLMechanism(str, Enum):
+class InputKafkaAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Enter credentials directly, or select a stored secret"""
+
+    MANUAL = "manual"
+    SECRET = "secret"
+
+
+class InputKafkaSASLMechanism(str, Enum, metaclass=utils.OpenEnumMeta):
+    # PLAIN
     PLAIN = "plain"
+    # SCRAM-SHA-256
     SCRAM_SHA_256 = "scram-sha-256"
+    # SCRAM-SHA-512
     SCRAM_SHA_512 = "scram-sha-512"
+    # GSSAPI/Kerberos
     KERBEROS = "kerberos"
 
 
+class InputKafkaOauthParamTypedDict(TypedDict):
+    name: str
+    value: str
+
+
+class InputKafkaOauthParam(BaseModel):
+    name: str
+
+    value: str
+
+
+class InputKafkaSaslExtensionTypedDict(TypedDict):
+    name: str
+    value: str
+
+
+class InputKafkaSaslExtension(BaseModel):
+    name: str
+
+    value: str
+
+
 class InputKafkaAuthenticationTypedDict(TypedDict):
     r"""Authentication parameters to use when connecting to brokers. Using TLS is highly recommended."""
 
     disabled: NotRequired[bool]
+    username: NotRequired[str]
+    password: NotRequired[str]
+    auth_type: NotRequired[InputKafkaAuthenticationMethod]
+    r"""Enter credentials directly, or select a stored secret"""
+    credentials_secret: NotRequired[str]
+    r"""Select or create a secret that references your credentials"""
     mechanism: NotRequired[InputKafkaSASLMechanism]
+    keytab_location: NotRequired[str]
+    r"""Location of keytab file for authentication principal"""
+    principal: NotRequired[str]
+    r"""Authentication principal, such as `kafka_user@example.com`"""
+    broker_service_class: NotRequired[str]
+    r"""Kerberos service class for Kafka brokers, such as `kafka`"""
+    oauth_enabled: NotRequired[bool]
+    r"""Enable OAuth authentication"""
+    token_url: NotRequired[str]
+    r"""URL of the token endpoint to use for OAuth authentication"""
+    client_id: NotRequired[str]
+    r"""Client ID to use for OAuth authentication"""
+    oauth_secret_type: NotRequired[str]
+    client_text_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
+    oauth_params: NotRequired[List[InputKafkaOauthParamTypedDict]]
+    r"""Additional fields to send to the token endpoint, such as scope or audience"""
+    sasl_extensions: NotRequired[List[InputKafkaSaslExtensionTypedDict]]
+    r"""Additional SASL extension fields, such as Confluent's logicalCluster or identityPoolId"""
 
 
 class InputKafkaAuthentication(BaseModel):
@@ -240,17 +369,98 @@ class InputKafkaAuthentication(BaseModel):
 
     disabled: Optional[bool] = True
 
-    mechanism: Optional[InputKafkaSASLMechanism] = InputKafkaSASLMechanism.PLAIN
+    username: Optional[str] = None
+
+    password: Optional[str] = None
+
+    auth_type: Annotated[
+        Annotated[
+            Optional[InputKafkaAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = InputKafkaAuthenticationMethod.MANUAL
+    r"""Enter credentials directly, or select a stored secret"""
 
+    credentials_secret: Annotated[
+        Optional[str], pydantic.Field(alias="credentialsSecret")
+    ] = None
+    r"""Select or create a secret that references your credentials"""
 
-class InputKafkaMinimumTLSVersion(str, Enum):
+    mechanism: Annotated[
+        Optional[InputKafkaSASLMechanism], PlainValidator(validate_open_enum(False))
+    ] = InputKafkaSASLMechanism.PLAIN
+
+    keytab_location: Annotated[
+        Optional[str], pydantic.Field(alias="keytabLocation")
+    ] = None
+    r"""Location of keytab file for authentication principal"""
+
+    principal: Optional[str] = None
+    r"""Authentication principal, such as `kafka_user@example.com`"""
+
+    broker_service_class: Annotated[
+        Optional[str], pydantic.Field(alias="brokerServiceClass")
+    ] = None
+    r"""Kerberos service class for Kafka brokers, such as `kafka`"""
+
+    oauth_enabled: Annotated[Optional[bool], pydantic.Field(alias="oauthEnabled")] = (
+        False
+    )
+    r"""Enable OAuth authentication"""
+
+    token_url: Annotated[Optional[str], pydantic.Field(alias="tokenUrl")] = None
+    r"""URL of the token endpoint to use for OAuth authentication"""
+
+    client_id: Annotated[Optional[str], pydantic.Field(alias="clientId")] = None
+    r"""Client ID to use for OAuth authentication"""
+
+    oauth_secret_type: Annotated[
+        Optional[str], pydantic.Field(alias="oauthSecretType")
+    ] = "secret"
+
+    client_text_secret: Annotated[
+        Optional[str], pydantic.Field(alias="clientTextSecret")
+    ] = None
+    r"""Select or create a stored text secret"""
+
+    oauth_params: Annotated[
+        Optional[List[InputKafkaOauthParam]], pydantic.Field(alias="oauthParams")
+    ] = None
+    r"""Additional fields to send to the token endpoint, such as scope or audience"""
+
+    sasl_extensions: Annotated[
+        Optional[List[InputKafkaSaslExtension]], pydantic.Field(alias="saslExtensions")
+    ] = None
+    r"""Additional SASL extension fields, such as Confluent's logicalCluster or identityPoolId"""
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKafkaAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("mechanism")
+    def serialize_mechanism(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKafkaSASLMechanism(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputKafkaMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputKafkaMaximumTLSVersion(str, Enum):
+class InputKafkaMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -310,13 +520,39 @@ class InputKafkaTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[InputKafkaMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputKafkaMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputKafkaMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputKafkaMaximumTLSVersion],
+            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.InputKafkaMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKafkaMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputKafkaMetadatumTypedDict(TypedDict):
     name: str
@@ -332,13 +568,13 @@ class InputKafkaMetadatum(BaseModel):
 
 
 class InputKafkaTypedDict(TypedDict):
+    type: InputKafkaType
     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]
     r"""Topic to subscribe to. Warning: To optimize performance, Cribl suggests subscribing each Kafka Source to a single topic only."""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputKafkaType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -380,7 +616,8 @@ class InputKafkaTypedDict(TypedDict):
     r"""Authentication parameters to use when connecting to brokers. Using TLS is highly recommended."""
     tls: NotRequired[InputKafkaTLSSettingsClientSideTypedDict]
     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.
@@ -412,6 +649,8 @@ class InputKafkaTypedDict(TypedDict):
 
 
 class InputKafka(BaseModel):
+    type: InputKafkaType
+
     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)."""
 
@@ -421,8 +660,6 @@ class InputKafka(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputKafkaType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -502,7 +739,8 @@ class InputKafka(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.