cribl-control-plane 0.0.39__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/outputmsk.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
 
@@ -12,36 +16,41 @@ class OutputMskType(str, Enum):
     MSK = "msk"
 
 
-class OutputMskAcknowledgments(int, 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):
+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):
+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):
-    r"""The schema format used to encode and decode event data"""
-
-    AVRO = "avro"
-    JSON = "json"
+    # ZSTD
+    ZSTD = "zstd"
 
 
 class OutputMskAuthTypedDict(TypedDict):
@@ -63,14 +72,18 @@ class OutputMskAuth(BaseModel):
     r"""Select or create a secret that references your credentials"""
 
 
-class OutputMskKafkaSchemaRegistryMinimumTLSVersion(str, Enum):
+class OutputMskKafkaSchemaRegistryMinimumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class OutputMskKafkaSchemaRegistryMaximumTLSVersion(str, Enum):
+class OutputMskKafkaSchemaRegistryMaximumTLSVersion(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -130,22 +143,44 @@ class OutputMskKafkaSchemaRegistryTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[OutputMskKafkaSchemaRegistryMinimumTLSVersion],
+        Annotated[
+            Optional[OutputMskKafkaSchemaRegistryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[OutputMskKafkaSchemaRegistryMaximumTLSVersion],
+        Annotated[
+            Optional[OutputMskKafkaSchemaRegistryMaximumTLSVersion],
+            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.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]
@@ -169,11 +204,6 @@ 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[
-        Optional[OutputMskSchemaType], 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
@@ -203,29 +233,32 @@ class OutputMskKafkaSchemaRegistryAuthentication(BaseModel):
     r"""Used when __valueSchemaIdOut is not present, to transform _raw, leave blank if value transformation is not required by default."""
 
 
-class OutputMskAuthenticationMethod(str, Enum):
+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"
 
 
-class OutputMskSignatureVersion(str, Enum):
+class OutputMskSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing MSK cluster requests"""
 
     V2 = "v2"
     V4 = "v4"
 
 
-class OutputMskMinimumTLSVersion(str, Enum):
+class OutputMskMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class OutputMskMaximumTLSVersion(str, Enum):
+class OutputMskMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -285,44 +318,80 @@ class OutputMskTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[OutputMskMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[OutputMskMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[OutputMskMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[OutputMskMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
-
-class OutputMskBackpressureBehavior(str, Enum):
+    @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 OutputMskPqCompressCompression(str, Enum):
+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):
+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):
-    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
 
@@ -408,6 +477,18 @@ 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]
@@ -418,8 +499,6 @@ 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]
 
 
@@ -452,15 +531,23 @@ class OutputMsk(BaseModel):
     streamtags: Optional[List[str]] = None
     r"""Tags for filtering and grouping in @{product}"""
 
-    ack: Optional[OutputMskAcknowledgments] = OutputMskAcknowledgments.ONE
+    ack: Annotated[
+        Optional[OutputMskAcknowledgments], PlainValidator(validate_open_enum(True))
+    ] = OutputMskAcknowledgments.ONE
     r"""Control the number of required acknowledgments."""
 
     format_: Annotated[
-        Optional[OutputMskRecordDataFormat], pydantic.Field(alias="format")
+        Annotated[
+            Optional[OutputMskRecordDataFormat],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="format"),
     ] = OutputMskRecordDataFormat.JSON
     r"""Format to use to serialize events before writing to Kafka."""
 
-    compression: Optional[OutputMskCompression] = OutputMskCompression.GZIP
+    compression: Annotated[
+        Optional[OutputMskCompression], PlainValidator(validate_open_enum(False))
+    ] = OutputMskCompression.GZIP
     r"""Codec to use to compress the data before sending to Kafka"""
 
     max_record_size_kb: Annotated[
@@ -518,7 +605,10 @@ class OutputMsk(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[OutputMskAuthenticationMethod],
+        Annotated[
+            Optional[OutputMskAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = OutputMskAuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -531,7 +621,11 @@ class OutputMsk(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[OutputMskSignatureVersion], pydantic.Field(alias="signatureVersion")
+        Annotated[
+            Optional[OutputMskSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="signatureVersion"),
     ] = OutputMskSignatureVersion.V4
     r"""Signature version to use for signing MSK cluster requests"""
 
@@ -568,7 +662,11 @@ class OutputMsk(BaseModel):
     tls: Optional[OutputMskTLSSettingsClientSide] = None
 
     on_backpressure: Annotated[
-        Optional[OutputMskBackpressureBehavior], pydantic.Field(alias="onBackpressure")
+        Annotated[
+            Optional[OutputMskBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="onBackpressure"),
     ] = OutputMskBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
 
@@ -584,6 +682,37 @@ 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"
@@ -598,20 +727,104 @@ class OutputMsk(BaseModel):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
 
     pq_compress: Annotated[
-        Optional[OutputMskPqCompressCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputMskPqCompressCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputMskPqCompressCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputMskQueueFullBehavior], pydantic.Field(alias="pqOnBackpressure")
+        Annotated[
+            Optional[OutputMskQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqOnBackpressure"),
     ] = 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[Optional[OutputMskMode], 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

cribl_control_plane/models/outputnetflow.py

@@ -30,7 +30,7 @@ class OutputNetflowHost(BaseModel):
 class OutputNetflowTypedDict(TypedDict):
     type: OutputNetflowType
     hosts: List[OutputNetflowHostTypedDict]
-    r"""One or more NetFlow destinations to forward events to"""
+    r"""One or more NetFlow Destinations to forward events to"""
     id: NotRequired[str]
     r"""Unique ID for this output"""
     pipeline: NotRequired[str]
@@ -43,14 +43,18 @@ class OutputNetflowTypedDict(TypedDict):
     r"""Tags for filtering and grouping in @{product}"""
     dns_resolve_period_sec: NotRequired[float]
     r"""How often to resolve the destination hostname to an IP address. Ignored if all destinations are IP addresses. A value of 0 means every datagram sent will incur a DNS lookup."""
+    enable_ip_spoofing: NotRequired[bool]
+    r"""Send NetFlow traffic using the original event's Source IP and port. To enable this, you must install the external `udp-sender` helper binary at `/usr/bin/udp-sender` on all Worker Nodes and grant it the `CAP_NET_RAW` capability."""
     description: NotRequired[str]
+    max_record_size: NotRequired[float]
+    r"""MTU in bytes. The actual maximum NetFlow payload size will be MTU minus IP and UDP headers (28 bytes for IPv4, 48 bytes for IPv6). For example, with the default MTU of 1500, the max payload is 1472 bytes for IPv4. Payloads exceeding this limit will be dropped."""
 
 
 class OutputNetflow(BaseModel):
     type: OutputNetflowType
 
     hosts: List[OutputNetflowHost]
-    r"""One or more NetFlow destinations to forward events to"""
+    r"""One or more NetFlow Destinations to forward events to"""
 
     id: Optional[str] = None
     r"""Unique ID for this output"""
@@ -74,4 +78,14 @@ class OutputNetflow(BaseModel):
     ] = 0
     r"""How often to resolve the destination hostname to an IP address. Ignored if all destinations are IP addresses. A value of 0 means every datagram sent will incur a DNS lookup."""
 
+    enable_ip_spoofing: Annotated[
+        Optional[bool], pydantic.Field(alias="enableIpSpoofing")
+    ] = False
+    r"""Send NetFlow traffic using the original event's Source IP and port. To enable this, you must install the external `udp-sender` helper binary at `/usr/bin/udp-sender` on all Worker Nodes and grant it the `CAP_NET_RAW` capability."""
+
     description: Optional[str] = None
+
+    max_record_size: Annotated[
+        Optional[float], pydantic.Field(alias="maxRecordSize")
+    ] = 1500
+    r"""MTU in bytes. The actual maximum NetFlow payload size will be MTU minus IP and UDP headers (28 bytes for IPv4, 48 bytes for IPv6). For example, with the default MTU of 1500, the max payload is 1472 bytes for IPv4. Payloads exceeding this limit will be dropped."""