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

cribl_control_plane/models/outputminio.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,11 +18,8 @@ class OutputMinioType(str, Enum):
 class OutputMinioAuthenticationMethod(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"
 
 
@@ -37,64 +33,47 @@ class OutputMinioSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputMinioObjectACL(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Object ACL to assign to uploaded objects"""
 
-    # Private
     PRIVATE = "private"
-    # Public Read Only
     PUBLIC_READ = "public-read"
-    # Public Read/Write
     PUBLIC_READ_WRITE = "public-read-write"
-    # Authenticated Read Only
     AUTHENTICATED_READ = "authenticated-read"
-    # AWS EC2 AMI Read Only
     AWS_EXEC_READ = "aws-exec-read"
-    # Bucket Owner Read Only
     BUCKET_OWNER_READ = "bucket-owner-read"
-    # Bucket Owner Full Control
     BUCKET_OWNER_FULL_CONTROL = "bucket-owner-full-control"
 
 
 class OutputMinioStorageClass(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Storage class to select for uploaded objects"""
 
-    # Standard
     STANDARD = "STANDARD"
-    # Reduced Redundancy Storage
     REDUCED_REDUNDANCY = "REDUCED_REDUNDANCY"
 
 
 class ServerSideEncryption(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Server-side encryption for uploaded objects"""
 
-    # Amazon S3 Managed Key
     AES256 = "AES256"
 
 
 class OutputMinioDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
-    # JSON
     JSON = "json"
-    # Raw
     RAW = "raw"
-    # Parquet
     PARQUET = "parquet"
 
 
 class OutputMinioBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
 
 
 class OutputMinioDiskSpaceProtection(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
 
 
@@ -108,31 +87,23 @@ class OutputMinioCompression(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputMinioCompressionLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Compression level to apply before moving files to final destination"""
 
-    # Best Speed
     BEST_SPEED = "best_speed"
-    # Normal
     NORMAL = "normal"
-    # Best Compression
     BEST_COMPRESSION = "best_compression"
 
 
 class OutputMinioParquetVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Determines which data types are supported and how they are represented"""
 
-    # 1.0
     PARQUET_1_0 = "PARQUET_1_0"
-    # 2.4
     PARQUET_2_4 = "PARQUET_2_4"
-    # 2.6
     PARQUET_2_6 = "PARQUET_2_6"
 
 
 class OutputMinioDataPageVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
 
-    # V1
     DATA_PAGE_V1 = "DATA_PAGE_V1"
-    # V2
     DATA_PAGE_V2 = "DATA_PAGE_V2"
 
 
@@ -230,8 +201,6 @@ class OutputMinioTypedDict(TypedDict):
     r"""Compression level to apply before moving files to final destination"""
     automatic_schema: NotRequired[bool]
     r"""Automatically calculate the schema based on the events of each Parquet file generated"""
-    parquet_schema: NotRequired[str]
-    r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
     parquet_version: NotRequired[OutputMinioParquetVersion]
     r"""Determines which data types are supported and how they are represented"""
     parquet_data_page_version: NotRequired[OutputMinioDataPageVersion]
@@ -473,11 +442,6 @@ class OutputMinio(BaseModel):
     ] = False
     r"""Automatically calculate the schema based on the events of each Parquet file generated"""
 
-    parquet_schema: Annotated[Optional[str], pydantic.Field(alias="parquetSchema")] = (
-        None
-    )
-    r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
-
     parquet_version: Annotated[
         Annotated[
             Optional[OutputMinioParquetVersion],
@@ -544,111 +508,3 @@ class OutputMinio(BaseModel):
 
     max_retry_num: Annotated[Optional[float], pydantic.Field(alias="maxRetryNum")] = 20
     r"""The maximum number of times a file will attempt to move to its final destination before being dead-lettered"""
-
-    @field_serializer("aws_authentication_method")
-    def serialize_aws_authentication_method(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioAuthenticationMethod(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("signature_version")
-    def serialize_signature_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioSignatureVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("object_acl")
-    def serialize_object_acl(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioObjectACL(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("storage_class")
-    def serialize_storage_class(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioStorageClass(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("server_side_encryption")
-    def serialize_server_side_encryption(self, value):
-        if isinstance(value, str):
-            try:
-                return models.ServerSideEncryption(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("format_")
-    def serialize_format_(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioDataFormat(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_backpressure")
-    def serialize_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioBackpressureBehavior(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_disk_full_backpressure")
-    def serialize_on_disk_full_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioDiskSpaceProtection(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("compress")
-    def serialize_compress(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioCompression(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("compression_level")
-    def serialize_compression_level(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioCompressionLevel(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("parquet_version")
-    def serialize_parquet_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioParquetVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("parquet_data_page_version")
-    def serialize_parquet_data_page_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMinioDataPageVersion(value)
-            except ValueError:
-                return value
-        return value

cribl_control_plane/models/outputmsk.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 OutputMskType(str, Enum):
 class OutputMskAcknowledgments(int, Enum, metaclass=utils.OpenEnumMeta):
     r"""Control the number of required acknowledgments."""
 
-    # Leader
     ONE = 1
-    # None
     ZERO = 0
-    # All
     MINUS_1 = -1
 
 
 class OutputMskRecordDataFormat(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 OutputMskCompression(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 OutputMskSchemaType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The schema format used to encode and decode event data"""
+
+    AVRO = "avro"
+    JSON = "json"
+
+
 class OutputMskAuthTypedDict(TypedDict):
     r"""Credentials to use when authenticating with the schema registry using basic HTTP authentication"""
 
@@ -156,29 +152,13 @@ class OutputMskKafkaSchemaRegistryTLSSettingsClientSide(BaseModel):
         pydantic.Field(alias="maxVersion"),
     ] = None
 
-    @field_serializer("min_version")
-    def serialize_min_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskKafkaSchemaRegistryMinimumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("max_version")
-    def serialize_max_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskKafkaSchemaRegistryMaximumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputMskKafkaSchemaRegistryAuthenticationTypedDict(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[OutputMskSchemaType]
+    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 OutputMskKafkaSchemaRegistryAuthentication(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[OutputMskSchemaType], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="schemaType"),
+    ] = OutputMskSchemaType.AVRO
+    r"""The schema format used to encode and decode event data"""
+
     connection_timeout: Annotated[
         Optional[float], pydantic.Field(alias="connectionTimeout")
     ] = 30000
@@ -234,11 +222,8 @@ class OutputMskKafkaSchemaRegistryAuthentication(BaseModel):
 class OutputMskAuthenticationMethod(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"
 
 
@@ -331,65 +316,37 @@ class OutputMskTLSSettingsClientSide(BaseModel):
         pydantic.Field(alias="maxVersion"),
     ] = None
 
-    @field_serializer("min_version")
-    def serialize_min_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskMinimumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("max_version")
-    def serialize_max_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskMaximumTLSVersion(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputMskBackpressureBehavior(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 OutputMskMode(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 OutputMskPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputMskQueueFullBehavior(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 OutputMskMode(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 OutputMskPqControlsTypedDict(TypedDict):
     pass
 
@@ -475,18 +432,6 @@ class OutputMskTypedDict(TypedDict):
     r"""Select or create a stored secret that references your access key and secret key"""
     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[OutputMskMode]
-    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]
@@ -497,6 +442,8 @@ class OutputMskTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputMskQueueFullBehavior]
     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[OutputMskMode]
+    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[OutputMskPqControlsTypedDict]
 
 
@@ -680,37 +627,6 @@ class OutputMsk(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[OutputMskMode], PlainValidator(validate_open_enum(False))],
-        pydantic.Field(alias="pqMode"),
-    ] = OutputMskMode.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"
@@ -742,87 +658,12 @@ class OutputMsk(BaseModel):
     ] = OutputMskQueueFullBehavior.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[OutputMskMode], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputMskMode.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[OutputMskPqControls], pydantic.Field(alias="pqControls")
     ] = None
-
-    @field_serializer("ack")
-    def serialize_ack(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskAcknowledgments(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("format_")
-    def serialize_format_(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskRecordDataFormat(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("compression")
-    def serialize_compression(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskCompression(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("aws_authentication_method")
-    def serialize_aws_authentication_method(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskAuthenticationMethod(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("signature_version")
-    def serialize_signature_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskSignatureVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_backpressure")
-    def serialize_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskBackpressureBehavior(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_mode")
-    def serialize_pq_mode(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskMode(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_compress")
-    def serialize_pq_compress(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputMskPqCompressCompression(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.OutputMskQueueFullBehavior(value)
-            except ValueError:
-                return value
-        return value