cribl-control-plane 0.2.1rc7__py3-none-any.whl → 0.3.0a1__py3-none-any.whl

cribl_control_plane/models/outputkafka.py

@@ -1,12 +1,11 @@
 """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 import 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
@@ -19,38 +18,35 @@ class OutputKafkaType(str, Enum):
 class OutputKafkaAcknowledgments(int, Enum, metaclass=utils.OpenEnumMeta):
     r"""Control the number of required acknowledgments."""
 
-    # Leader
     ONE = 1
-    # None
     ZERO = 0
-    # All
     MINUS_1 = -1
 
 
 class OutputKafkaRecordDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format to use to serialize events before writing to Kafka."""
 
-    # JSON
     JSON = "json"
-    # Field _raw
     RAW = "raw"
-    # Protobuf
     PROTOBUF = "protobuf"
 
 
 class OutputKafkaCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the data before sending to Kafka"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
-    # Snappy
     SNAPPY = "snappy"
-    # LZ4
     LZ4 = "lz4"
 
 
+class OutputKafkaSchemaType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The schema format used to encode and decode event data"""
+
+    AVRO = "avro"
+    JSON = "json"
+
+
 class OutputKafkaAuthTypedDict(TypedDict):
     r"""Credentials to use when authenticating with the schema registry using basic HTTP authentication"""
 
@@ -156,29 +152,13 @@ class OutputKafkaKafkaSchemaRegistryTLSSettingsClientSide(BaseModel):
         pydantic.Field(alias="maxVersion"),
     ] = None
 
-    @field_serializer("min_version")
-    def serialize_min_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaKafkaSchemaRegistryMinimumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("max_version")
-    def serialize_max_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaKafkaSchemaRegistryMaximumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputKafkaKafkaSchemaRegistryAuthenticationTypedDict(TypedDict):
     disabled: NotRequired[bool]
     schema_registry_url: NotRequired[str]
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
+    schema_type: NotRequired[OutputKafkaSchemaType]
+    r"""The schema format used to encode and decode event data"""
     connection_timeout: NotRequired[float]
     r"""Maximum time to wait for a Schema Registry connection to complete successfully"""
     request_timeout: NotRequired[float]
@@ -202,6 +182,14 @@ class OutputKafkaKafkaSchemaRegistryAuthentication(BaseModel):
     ] = "http://localhost:8081"
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
 
+    schema_type: Annotated[
+        Annotated[
+            Optional[OutputKafkaSchemaType], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="schemaType"),
+    ] = OutputKafkaSchemaType.AVRO
+    r"""The schema format used to encode and decode event data"""
+
     connection_timeout: Annotated[
         Optional[float], pydantic.Field(alias="connectionTimeout")
     ] = 30000
@@ -231,76 +219,20 @@ class OutputKafkaKafkaSchemaRegistryAuthentication(BaseModel):
     r"""Used when __valueSchemaIdOut is not present, to transform _raw, leave blank if value transformation is not required by default."""
 
 
-class OutputKafkaAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""Enter credentials directly, or select a stored secret"""
-
-    MANUAL = "manual"
-    SECRET = "secret"
-
-
 class OutputKafkaSASLMechanism(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 OutputKafkaOauthParamTypedDict(TypedDict):
-    name: str
-    value: str
-
-
-class OutputKafkaOauthParam(BaseModel):
-    name: str
-
-    value: str
-
-
-class OutputKafkaSaslExtensionTypedDict(TypedDict):
-    name: str
-    value: str
-
-
-class OutputKafkaSaslExtension(BaseModel):
-    name: str
-
-    value: str
-
-
 class OutputKafkaAuthenticationTypedDict(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[OutputKafkaAuthenticationMethod]
-    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[OutputKafkaSASLMechanism]
-    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[OutputKafkaOauthParamTypedDict]]
-    r"""Additional fields to send to the token endpoint, such as scope or audience"""
-    sasl_extensions: NotRequired[List[OutputKafkaSaslExtensionTypedDict]]
-    r"""Additional SASL extension fields, such as Confluent's logicalCluster or identityPoolId"""
 
 
 class OutputKafkaAuthentication(BaseModel):
@@ -308,89 +240,15 @@ class OutputKafkaAuthentication(BaseModel):
 
     disabled: Optional[bool] = True
 
-    username: Optional[str] = None
-
-    password: Optional[str] = None
-
-    auth_type: Annotated[
-        Annotated[
-            Optional[OutputKafkaAuthenticationMethod],
-            PlainValidator(validate_open_enum(False)),
-        ],
-        pydantic.Field(alias="authType"),
-    ] = OutputKafkaAuthenticationMethod.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[OutputKafkaSASLMechanism], PlainValidator(validate_open_enum(False))
     ] = OutputKafkaSASLMechanism.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[OutputKafkaOauthParam]], pydantic.Field(alias="oauthParams")
-    ] = None
-    r"""Additional fields to send to the token endpoint, such as scope or audience"""
-
-    sasl_extensions: Annotated[
-        Optional[List[OutputKafkaSaslExtension]], 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.OutputKafkaAuthenticationMethod(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("mechanism")
-    def serialize_mechanism(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaSASLMechanism(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputKafkaMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
@@ -474,65 +332,37 @@ class OutputKafkaTLSSettingsClientSide(BaseModel):
         pydantic.Field(alias="maxVersion"),
     ] = None
 
-    @field_serializer("min_version")
-    def serialize_min_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaMinimumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("max_version")
-    def serialize_max_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaMaximumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputKafkaBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
-    # Persistent Queue
     QUEUE = "queue"
 
 
-class OutputKafkaMode(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
-
-    # Error
-    ERROR = "error"
-    # Backpressure
-    ALWAYS = "always"
-    # Always On
-    BACKPRESSURE = "backpressure"
-
-
 class OutputKafkaPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputKafkaQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
-    # Block
     BLOCK = "block"
-    # Drop new data
     DROP = "drop"
 
 
+class OutputKafkaMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
+
+    ERROR = "error"
+    BACKPRESSURE = "backpressure"
+    ALWAYS = "always"
+
+
 class OutputKafkaPqControlsTypedDict(TypedDict):
     pass
 
@@ -596,18 +426,6 @@ class OutputKafkaTypedDict(TypedDict):
     description: NotRequired[str]
     protobuf_library_id: NotRequired[str]
     r"""Select a set of Protobuf definitions for the events you want to send"""
-    protobuf_encoding_id: NotRequired[str]
-    r"""Select the type of object you want the Protobuf definitions to use for event encoding"""
-    pq_strict_ordering: NotRequired[bool]
-    r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
-    pq_rate_per_sec: NotRequired[float]
-    r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
-    pq_mode: NotRequired[OutputKafkaMode]
-    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
-    pq_max_buffer_size: NotRequired[float]
-    r"""The maximum number of events to hold in memory before writing the events to disk"""
-    pq_max_backpressure_sec: NotRequired[float]
-    r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
     pq_max_file_size: NotRequired[str]
     r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
     pq_max_size: NotRequired[str]
@@ -618,6 +436,8 @@ class OutputKafkaTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputKafkaQueueFullBehavior]
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
+    pq_mode: NotRequired[OutputKafkaMode]
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
     pq_controls: NotRequired[OutputKafkaPqControlsTypedDict]
 
 
@@ -741,37 +561,6 @@ class OutputKafka(BaseModel):
     ] = None
     r"""Select a set of Protobuf definitions for the events you want to send"""
 
-    protobuf_encoding_id: Annotated[
-        Optional[str], pydantic.Field(alias="protobufEncodingId")
-    ] = None
-    r"""Select the type of object you want the Protobuf definitions to use for event encoding"""
-
-    pq_strict_ordering: Annotated[
-        Optional[bool], pydantic.Field(alias="pqStrictOrdering")
-    ] = True
-    r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
-
-    pq_rate_per_sec: Annotated[
-        Optional[float], pydantic.Field(alias="pqRatePerSec")
-    ] = 0
-    r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
-
-    pq_mode: Annotated[
-        Annotated[Optional[OutputKafkaMode], PlainValidator(validate_open_enum(False))],
-        pydantic.Field(alias="pqMode"),
-    ] = OutputKafkaMode.ERROR
-    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
-
-    pq_max_buffer_size: Annotated[
-        Optional[float], pydantic.Field(alias="pqMaxBufferSize")
-    ] = 42
-    r"""The maximum number of events to hold in memory before writing the events to disk"""
-
-    pq_max_backpressure_sec: Annotated[
-        Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
-    ] = 30
-    r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
-
     pq_max_file_size: Annotated[
         Optional[str], pydantic.Field(alias="pqMaxFileSize")
     ] = "1 MB"
@@ -803,69 +592,12 @@ class OutputKafka(BaseModel):
     ] = OutputKafkaQueueFullBehavior.BLOCK
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    pq_mode: Annotated[
+        Annotated[Optional[OutputKafkaMode], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputKafkaMode.ERROR
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
+
     pq_controls: Annotated[
         Optional[OutputKafkaPqControls], pydantic.Field(alias="pqControls")
     ] = None
-
-    @field_serializer("ack")
-    def serialize_ack(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaAcknowledgments(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("format_")
-    def serialize_format_(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaRecordDataFormat(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("compression")
-    def serialize_compression(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaCompression(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_backpressure")
-    def serialize_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaBackpressureBehavior(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_mode")
-    def serialize_pq_mode(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaMode(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_compress")
-    def serialize_pq_compress(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaPqCompressCompression(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_on_backpressure")
-    def serialize_pq_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputKafkaQueueFullBehavior(value)
-            except ValueError:
-                return value
-        return value