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

cribl_control_plane/models/outputazureeventhub.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,31 +16,95 @@ class OutputAzureEventhubType(str, Enum):
     AZURE_EVENTHUB = "azure_eventhub"
 
 
-class OutputAzureEventhubAcknowledgments(int, Enum):
+class OutputAzureEventhubAcknowledgments(int, Enum, metaclass=utils.OpenEnumMeta):
     r"""Control the number of required acknowledgments"""
 
+    # Leader
     ONE = 1
+    # None
     ZERO = 0
+    # All
     MINUS_1 = -1
 
 
-class OutputAzureEventhubRecordDataFormat(str, Enum):
+class OutputAzureEventhubRecordDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format to use to serialize events before writing to the Event Hubs Kafka brokers"""
 
+    # JSON
     JSON = "json"
+    # Field _raw
     RAW = "raw"
 
 
-class OutputAzureEventhubSASLMechanism(str, Enum):
+class OutputAzureEventhubAuthTypeAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""Enter password directly, or select a stored secret"""
+
+    MANUAL = "manual"
+    SECRET = "secret"
+
+
+class OutputAzureEventhubSASLMechanism(str, Enum, metaclass=utils.OpenEnumMeta):
+    # PLAIN
     PLAIN = "plain"
+    # OAUTHBEARER
     OAUTHBEARER = "oauthbearer"
 
 
+class OutputAzureEventhubClientSecretAuthTypeAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    MANUAL = "manual"
+    SECRET = "secret"
+    CERTIFICATE = "certificate"
+
+
+class OutputAzureEventhubMicrosoftEntraIDAuthenticationEndpoint(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""Endpoint used to acquire authentication tokens from Azure"""
+
+    HTTPS_LOGIN_MICROSOFTONLINE_COM = "https://login.microsoftonline.com"
+    HTTPS_LOGIN_MICROSOFTONLINE_US = "https://login.microsoftonline.us"
+    HTTPS_LOGIN_PARTNER_MICROSOFTONLINE_CN = "https://login.partner.microsoftonline.cn"
+
+
 class OutputAzureEventhubAuthenticationTypedDict(TypedDict):
     r"""Authentication parameters to use when connecting to brokers. Using TLS is highly recommended."""
 
     disabled: NotRequired[bool]
+    auth_type: NotRequired[OutputAzureEventhubAuthTypeAuthenticationMethod]
+    r"""Enter password directly, or select a stored secret"""
+    password: NotRequired[str]
+    r"""Connection-string primary key, or connection-string secondary key, from the Event Hubs workspace"""
+    text_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
     mechanism: NotRequired[OutputAzureEventhubSASLMechanism]
+    username: NotRequired[str]
+    r"""The username for authentication. For Event Hubs, this should always be $ConnectionString."""
+    client_secret_auth_type: NotRequired[
+        OutputAzureEventhubClientSecretAuthTypeAuthenticationMethod
+    ]
+    client_secret: NotRequired[str]
+    r"""client_secret to pass in the OAuth request parameter"""
+    client_text_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
+    certificate_name: NotRequired[str]
+    r"""Select or create a stored certificate"""
+    cert_path: NotRequired[str]
+    priv_key_path: NotRequired[str]
+    passphrase: NotRequired[str]
+    oauth_endpoint: NotRequired[
+        OutputAzureEventhubMicrosoftEntraIDAuthenticationEndpoint
+    ]
+    r"""Endpoint used to acquire authentication tokens from Azure"""
+    client_id: NotRequired[str]
+    r"""client_id to pass in the OAuth request parameter"""
+    tenant_id: NotRequired[str]
+    r"""Directory ID (tenant identifier) in Azure Active Directory"""
+    scope: NotRequired[str]
+    r"""Scope to pass in the OAuth request parameter"""
 
 
 class OutputAzureEventhubAuthentication(BaseModel):
@@ -44,9 +112,115 @@ class OutputAzureEventhubAuthentication(BaseModel):
 
     disabled: Optional[bool] = False
 
-    mechanism: Optional[OutputAzureEventhubSASLMechanism] = (
-        OutputAzureEventhubSASLMechanism.PLAIN
-    )
+    auth_type: Annotated[
+        Annotated[
+            Optional[OutputAzureEventhubAuthTypeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = OutputAzureEventhubAuthTypeAuthenticationMethod.MANUAL
+    r"""Enter password directly, or select a stored secret"""
+
+    password: Optional[str] = None
+    r"""Connection-string primary key, or connection-string secondary key, from the Event Hubs workspace"""
+
+    text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
+    r"""Select or create a stored text secret"""
+
+    mechanism: Annotated[
+        Optional[OutputAzureEventhubSASLMechanism],
+        PlainValidator(validate_open_enum(False)),
+    ] = OutputAzureEventhubSASLMechanism.PLAIN
+
+    username: Optional[str] = "$ConnectionString"
+    r"""The username for authentication. For Event Hubs, this should always be $ConnectionString."""
+
+    client_secret_auth_type: Annotated[
+        Annotated[
+            Optional[OutputAzureEventhubClientSecretAuthTypeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="clientSecretAuthType"),
+    ] = OutputAzureEventhubClientSecretAuthTypeAuthenticationMethod.MANUAL
+
+    client_secret: Annotated[Optional[str], pydantic.Field(alias="clientSecret")] = None
+    r"""client_secret to pass in the OAuth request parameter"""
+
+    client_text_secret: Annotated[
+        Optional[str], pydantic.Field(alias="clientTextSecret")
+    ] = None
+    r"""Select or create a stored text secret"""
+
+    certificate_name: Annotated[
+        Optional[str], pydantic.Field(alias="certificateName")
+    ] = None
+    r"""Select or create a stored certificate"""
+
+    cert_path: Annotated[Optional[str], pydantic.Field(alias="certPath")] = None
+
+    priv_key_path: Annotated[Optional[str], pydantic.Field(alias="privKeyPath")] = None
+
+    passphrase: Optional[str] = None
+
+    oauth_endpoint: Annotated[
+        Annotated[
+            Optional[OutputAzureEventhubMicrosoftEntraIDAuthenticationEndpoint],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="oauthEndpoint"),
+    ] = OutputAzureEventhubMicrosoftEntraIDAuthenticationEndpoint.HTTPS_LOGIN_MICROSOFTONLINE_COM
+    r"""Endpoint used to acquire authentication tokens from Azure"""
+
+    client_id: Annotated[Optional[str], pydantic.Field(alias="clientId")] = None
+    r"""client_id to pass in the OAuth request parameter"""
+
+    tenant_id: Annotated[Optional[str], pydantic.Field(alias="tenantId")] = None
+    r"""Directory ID (tenant identifier) in Azure Active Directory"""
+
+    scope: Optional[str] = None
+    r"""Scope to pass in the OAuth request parameter"""
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubAuthTypeAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("mechanism")
+    def serialize_mechanism(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubSASLMechanism(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("client_secret_auth_type")
+    def serialize_client_secret_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return (
+                    models.OutputAzureEventhubClientSecretAuthTypeAuthenticationMethod(
+                        value
+                    )
+                )
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("oauth_endpoint")
+    def serialize_oauth_endpoint(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubMicrosoftEntraIDAuthenticationEndpoint(
+                    value
+                )
+            except ValueError:
+                return value
+        return value
 
 
 class OutputAzureEventhubTLSSettingsClientSideTypedDict(TypedDict):
@@ -64,36 +238,46 @@ class OutputAzureEventhubTLSSettingsClientSide(BaseModel):
     r"""Reject certificates that are not authorized by a CA in the CA certificate path, or by another trusted CA (such as the system's)"""
 
 
-class OutputAzureEventhubBackpressureBehavior(str, Enum):
+class OutputAzureEventhubBackpressureBehavior(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 OutputAzureEventhubCompression(str, Enum):
+class OutputAzureEventhubMode(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 OutputAzureEventhubCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
-class OutputAzureEventhubQueueFullBehavior(str, Enum):
+class OutputAzureEventhubQueueFullBehavior(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 OutputAzureEventhubMode(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 OutputAzureEventhubPqControlsTypedDict(TypedDict):
     pass
 
@@ -103,13 +287,13 @@ class OutputAzureEventhubPqControls(BaseModel):
 
 
 class OutputAzureEventhubTypedDict(TypedDict):
+    type: OutputAzureEventhubType
     brokers: List[str]
     r"""List of Event Hubs Kafka brokers to connect to, eg. yourdomain.servicebus.windows.net:9093. The hostname can be found in the host portion of the primary or secondary connection string in Shared Access Policies."""
     topic: str
     r"""The name of the Event Hub (Kafka Topic) to publish events. Can be overwritten using field __topicOut."""
     id: NotRequired[str]
     r"""Unique ID for this output"""
-    type: NotRequired[OutputAzureEventhubType]
     pipeline: NotRequired[str]
     r"""Pipeline to process data before sending out to this output"""
     system_fields: NotRequired[List[str]]
@@ -150,6 +334,16 @@ class OutputAzureEventhubTypedDict(TypedDict):
     on_backpressure: NotRequired[OutputAzureEventhubBackpressureBehavior]
     r"""How to handle events when all receivers are exerting backpressure"""
     description: NotRequired[str]
+    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[OutputAzureEventhubMode]
+    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]
@@ -160,12 +354,12 @@ class OutputAzureEventhubTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputAzureEventhubQueueFullBehavior]
     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[OutputAzureEventhubMode]
-    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[OutputAzureEventhubPqControlsTypedDict]
 
 
 class OutputAzureEventhub(BaseModel):
+    type: OutputAzureEventhubType
+
     brokers: List[str]
     r"""List of Event Hubs Kafka brokers to connect to, eg. yourdomain.servicebus.windows.net:9093. The hostname can be found in the host portion of the primary or secondary connection string in Shared Access Policies."""
 
@@ -175,8 +369,6 @@ class OutputAzureEventhub(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this output"""
 
-    type: Optional[OutputAzureEventhubType] = None
-
     pipeline: Optional[str] = None
     r"""Pipeline to process data before sending out to this output"""
 
@@ -191,13 +383,18 @@ class OutputAzureEventhub(BaseModel):
     streamtags: Optional[List[str]] = None
     r"""Tags for filtering and grouping in @{product}"""
 
-    ack: Optional[OutputAzureEventhubAcknowledgments] = (
-        OutputAzureEventhubAcknowledgments.ONE
-    )
+    ack: Annotated[
+        Optional[OutputAzureEventhubAcknowledgments],
+        PlainValidator(validate_open_enum(True)),
+    ] = OutputAzureEventhubAcknowledgments.ONE
     r"""Control the number of required acknowledgments"""
 
     format_: Annotated[
-        Optional[OutputAzureEventhubRecordDataFormat], pydantic.Field(alias="format")
+        Annotated[
+            Optional[OutputAzureEventhubRecordDataFormat],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="format"),
     ] = OutputAzureEventhubRecordDataFormat.JSON
     r"""Format to use to serialize events before writing to the Event Hubs Kafka brokers"""
 
@@ -256,13 +453,44 @@ class OutputAzureEventhub(BaseModel):
     tls: Optional[OutputAzureEventhubTLSSettingsClientSide] = None
 
     on_backpressure: Annotated[
-        Optional[OutputAzureEventhubBackpressureBehavior],
+        Annotated[
+            Optional[OutputAzureEventhubBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputAzureEventhubBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
 
     description: Optional[str] = None
 
+    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[OutputAzureEventhubMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputAzureEventhubMode.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"
@@ -277,21 +505,77 @@ class OutputAzureEventhub(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[OutputAzureEventhubCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputAzureEventhubCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputAzureEventhubCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputAzureEventhubQueueFullBehavior],
+        Annotated[
+            Optional[OutputAzureEventhubQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputAzureEventhubQueueFullBehavior.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[OutputAzureEventhubMode], pydantic.Field(alias="pqMode")
-    ] = OutputAzureEventhubMode.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[OutputAzureEventhubPqControls], pydantic.Field(alias="pqControls")
     ] = None
+
+    @field_serializer("ack")
+    def serialize_ack(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubAcknowledgments(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("format_")
+    def serialize_format_(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubRecordDataFormat(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_mode")
+    def serialize_pq_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_compress")
+    def serialize_pq_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputAzureEventhubCompression(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.OutputAzureEventhubQueueFullBehavior(value)
+            except ValueError:
+                return value
+        return value