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

cribl_control_plane/models/inputconfluentcloud.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 InputConfluentCloudConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputConfluentCloudMode(str, Enum):
+class InputConfluentCloudMode(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 InputConfluentCloudCompression(str, Enum):
+class InputConfluentCloudCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputConfluentCloudPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputConfluentCloudPqControls(BaseModel):
+    pass
+
+
 class InputConfluentCloudPqTypedDict(TypedDict):
     mode: NotRequired[InputConfluentCloudMode]
     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 InputConfluentCloudPqTypedDict(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[InputConfluentCloudCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputConfluentCloudPqControlsTypedDict]
 
 
 class InputConfluentCloudPq(BaseModel):
-    mode: Optional[InputConfluentCloudMode] = InputConfluentCloudMode.ALWAYS
+    mode: Annotated[
+        Optional[InputConfluentCloudMode], PlainValidator(validate_open_enum(False))
+    ] = InputConfluentCloudMode.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 +98,43 @@ class InputConfluentCloudPq(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[InputConfluentCloudCompression] = (
-        InputConfluentCloudCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputConfluentCloudCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputConfluentCloudCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputConfluentCloudPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputConfluentCloudMinimumTLSVersion(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputConfluentCloudMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputConfluentCloudCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputConfluentCloudMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputConfluentCloudMaximumTLSVersion(str, Enum):
+class InputConfluentCloudMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -152,15 +194,39 @@ class InputConfluentCloudTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[InputConfluentCloudMinimumTLSVersion],
+        Annotated[
+            Optional[InputConfluentCloudMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputConfluentCloudMaximumTLSVersion],
+        Annotated[
+            Optional[InputConfluentCloudMaximumTLSVersion],
+            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.InputConfluentCloudMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputConfluentCloudMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputConfluentCloudAuthTypedDict(TypedDict):
     r"""Credentials to use when authenticating with the schema registry using basic HTTP authentication"""
@@ -181,14 +247,18 @@ class InputConfluentCloudAuth(BaseModel):
     r"""Select or create a secret that references your credentials"""
 
 
-class InputConfluentCloudKafkaSchemaRegistryMinimumTLSVersion(str, Enum):
+class InputConfluentCloudKafkaSchemaRegistryMinimumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputConfluentCloudKafkaSchemaRegistryMaximumTLSVersion(str, Enum):
+class InputConfluentCloudKafkaSchemaRegistryMaximumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -248,15 +318,43 @@ class InputConfluentCloudKafkaSchemaRegistryTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[InputConfluentCloudKafkaSchemaRegistryMinimumTLSVersion],
+        Annotated[
+            Optional[InputConfluentCloudKafkaSchemaRegistryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputConfluentCloudKafkaSchemaRegistryMaximumTLSVersion],
+        Annotated[
+            Optional[InputConfluentCloudKafkaSchemaRegistryMaximumTLSVersion],
+            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.InputConfluentCloudKafkaSchemaRegistryMinimumTLSVersion(
+                    value
+                )
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputConfluentCloudKafkaSchemaRegistryMaximumTLSVersion(
+                    value
+                )
+            except ValueError:
+                return value
+        return value
+
 
 class InputConfluentCloudKafkaSchemaRegistryAuthenticationTypedDict(TypedDict):
     disabled: NotRequired[bool]
@@ -302,18 +400,76 @@ class InputConfluentCloudKafkaSchemaRegistryAuthentication(BaseModel):
     tls: Optional[InputConfluentCloudKafkaSchemaRegistryTLSSettingsClientSide] = None
 
 
-class InputConfluentCloudSASLMechanism(str, Enum):
+class InputConfluentCloudAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Enter credentials directly, or select a stored secret"""
+
+    MANUAL = "manual"
+    SECRET = "secret"
+
+
+class InputConfluentCloudSASLMechanism(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 InputConfluentCloudOauthParamTypedDict(TypedDict):
+    name: str
+    value: str
+
+
+class InputConfluentCloudOauthParam(BaseModel):
+    name: str
+
+    value: str
+
+
+class InputConfluentCloudSaslExtensionTypedDict(TypedDict):
+    name: str
+    value: str
+
+
+class InputConfluentCloudSaslExtension(BaseModel):
+    name: str
+
+    value: str
+
+
 class InputConfluentCloudAuthenticationTypedDict(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[InputConfluentCloudAuthenticationMethod]
+    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[InputConfluentCloudSASLMechanism]
+    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[InputConfluentCloudOauthParamTypedDict]]
+    r"""Additional fields to send to the token endpoint, such as scope or audience"""
+    sasl_extensions: NotRequired[List[InputConfluentCloudSaslExtensionTypedDict]]
+    r"""Additional SASL extension fields, such as Confluent's logicalCluster or identityPoolId"""
 
 
 class InputConfluentCloudAuthentication(BaseModel):
@@ -321,9 +477,91 @@ class InputConfluentCloudAuthentication(BaseModel):
 
     disabled: Optional[bool] = True
 
-    mechanism: Optional[InputConfluentCloudSASLMechanism] = (
-        InputConfluentCloudSASLMechanism.PLAIN
+    username: Optional[str] = None
+
+    password: Optional[str] = None
+
+    auth_type: Annotated[
+        Annotated[
+            Optional[InputConfluentCloudAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = InputConfluentCloudAuthenticationMethod.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"""
+
+    mechanism: Annotated[
+        Optional[InputConfluentCloudSASLMechanism],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputConfluentCloudSASLMechanism.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[InputConfluentCloudOauthParam]],
+        pydantic.Field(alias="oauthParams"),
+    ] = None
+    r"""Additional fields to send to the token endpoint, such as scope or audience"""
+
+    sasl_extensions: Annotated[
+        Optional[List[InputConfluentCloudSaslExtension]],
+        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.InputConfluentCloudAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("mechanism")
+    def serialize_mechanism(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputConfluentCloudSASLMechanism(value)
+            except ValueError:
+                return value
+        return value
 
 
 class InputConfluentCloudMetadatumTypedDict(TypedDict):
@@ -340,13 +578,13 @@ class InputConfluentCloudMetadatum(BaseModel):
 
 
 class InputConfluentCloudTypedDict(TypedDict):
+    type: InputConfluentCloudType
     brokers: List[str]
     r"""List of Confluent Cloud bootstrap servers to use, such as yourAccount.confluent.cloud: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[InputConfluentCloudType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -388,7 +626,8 @@ class InputConfluentCloudTypedDict(TypedDict):
     sasl: NotRequired[InputConfluentCloudAuthenticationTypedDict]
     r"""Authentication parameters to use when connecting to brokers. Using TLS is highly recommended."""
     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.
@@ -420,6 +659,8 @@ class InputConfluentCloudTypedDict(TypedDict):
 
 
 class InputConfluentCloud(BaseModel):
+    type: InputConfluentCloudType
+
     brokers: List[str]
     r"""List of Confluent Cloud bootstrap servers to use, such as yourAccount.confluent.cloud:9092"""
 
@@ -429,8 +670,6 @@ class InputConfluentCloud(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputConfluentCloudType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -510,7 +749,8 @@ class InputConfluentCloud(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.

cribl_control_plane/models/inputcribl.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 InputCriblConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputCriblMode(str, Enum):
+class InputCriblMode(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 InputCriblCompression(str, Enum):
+class InputCriblCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputCriblPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputCriblPqControls(BaseModel):
+    pass
+
+
 class InputCriblPqTypedDict(TypedDict):
     mode: NotRequired[InputCriblMode]
     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 InputCriblPqTypedDict(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[InputCriblCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputCriblPqControlsTypedDict]
 
 
 class InputCriblPq(BaseModel):
-    mode: Optional[InputCriblMode] = InputCriblMode.ALWAYS
+    mode: Annotated[
+        Optional[InputCriblMode], PlainValidator(validate_open_enum(False))
+    ] = InputCriblMode.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 InputCriblPq(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[InputCriblCompression] = InputCriblCompression.NONE
+    compress: Annotated[
+        Optional[InputCriblCompression], PlainValidator(validate_open_enum(False))
+    ] = InputCriblCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputCriblPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputCriblMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputCriblCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputCriblMetadatumTypedDict(TypedDict):
     name: str
@@ -97,9 +140,9 @@ class InputCriblMetadatum(BaseModel):
 
 
 class InputCriblTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this input"""
     type: InputCriblType
+    id: NotRequired[str]
+    r"""Unique ID for this input"""
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -121,11 +164,11 @@ class InputCriblTypedDict(TypedDict):
 
 
 class InputCribl(BaseModel):
-    id: str
-    r"""Unique ID for this input"""
-
     type: InputCriblType
 
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None