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

cribl_control_plane/models/outputgooglepubsub.py

@@ -1,74 +1,74 @@
 """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
 
 
-class OutputGooglePubsubTypeGooglePubsub(str, Enum):
+class OutputGooglePubsubType(str, Enum):
     GOOGLE_PUBSUB = "google_pubsub"
 
 
-class OutputGooglePubsubGoogleAuthenticationMethod(str, Enum):
+class OutputGooglePubsubGoogleAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Choose Auto to use Google Application Default Credentials (ADC), Manual to enter Google service account credentials directly, or Secret to select or create a stored secret that references Google service account credentials."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret
     SECRET = "secret"
 
 
-class OutputGooglePubsubFlushPeriodSecType(str, Enum):
-    NUMBER = "number"
-
-
-class FlushPeriodSecTypedDict(TypedDict):
-    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
-
-    type: NotRequired[OutputGooglePubsubFlushPeriodSecType]
-    default: NotRequired[float]
-
-
-class FlushPeriodSec(BaseModel):
-    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
-
-    type: Optional[OutputGooglePubsubFlushPeriodSecType] = None
-
-    default: Optional[float] = None
-
-
-class OutputGooglePubsubBackpressureBehavior(str, Enum):
+class OutputGooglePubsubBackpressureBehavior(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 OutputGooglePubsubCompression(str, Enum):
+class OutputGooglePubsubMode(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 OutputGooglePubsubCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
-class OutputGooglePubsubQueueFullBehavior(str, Enum):
+class OutputGooglePubsubQueueFullBehavior(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 OutputGooglePubsubMode(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 OutputGooglePubsubPqControlsTypedDict(TypedDict):
     pass
 
@@ -78,7 +78,7 @@ class OutputGooglePubsubPqControls(BaseModel):
 
 
 class OutputGooglePubsubTypedDict(TypedDict):
-    type: OutputGooglePubsubTypeGooglePubsub
+    type: OutputGooglePubsubType
     topic_name: str
     r"""ID of the topic to send events to."""
     id: NotRequired[str]
@@ -111,13 +111,23 @@ class OutputGooglePubsubTypedDict(TypedDict):
     r"""Maximum number of queued batches before blocking."""
     max_record_size_kb: NotRequired[float]
     r"""Maximum size (KB) of batches to send."""
-    flush_period_sec: NotRequired[FlushPeriodSecTypedDict]
-    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
+    flush_period: NotRequired[float]
+    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)"""
     max_in_progress: NotRequired[float]
     r"""The maximum number of in-progress API requests before backpressure is applied."""
     on_backpressure: NotRequired[OutputGooglePubsubBackpressureBehavior]
     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[OutputGooglePubsubMode]
+    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]
@@ -128,13 +138,11 @@ class OutputGooglePubsubTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputGooglePubsubQueueFullBehavior]
     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[OutputGooglePubsubMode]
-    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[OutputGooglePubsubPqControlsTypedDict]
 
 
 class OutputGooglePubsub(BaseModel):
-    type: OutputGooglePubsubTypeGooglePubsub
+    type: OutputGooglePubsubType
 
     topic_name: Annotated[str, pydantic.Field(alias="topicName")]
     r"""ID of the topic to send events to."""
@@ -168,7 +176,10 @@ class OutputGooglePubsub(BaseModel):
     r"""Region to publish messages to. Select 'default' to allow Google to auto-select the nearest region. When using ordered delivery, the selected region must be allowed by message storage policy."""
 
     google_auth_method: Annotated[
-        Optional[OutputGooglePubsubGoogleAuthenticationMethod],
+        Annotated[
+            Optional[OutputGooglePubsubGoogleAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="googleAuthMethod"),
     ] = OutputGooglePubsubGoogleAuthenticationMethod.MANUAL
     r"""Choose Auto to use Google Application Default Credentials (ADC), Manual to enter Google service account credentials directly, or Secret to select or create a stored secret that references Google service account credentials."""
@@ -199,10 +210,8 @@ class OutputGooglePubsub(BaseModel):
     ] = 256
     r"""Maximum size (KB) of batches to send."""
 
-    flush_period_sec: Annotated[
-        Optional[FlushPeriodSec], pydantic.Field(alias="flushPeriodSec")
-    ] = None
-    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
+    flush_period: Annotated[Optional[float], pydantic.Field(alias="flushPeriod")] = 1
+    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)"""
 
     max_in_progress: Annotated[
         Optional[float], pydantic.Field(alias="maxInProgress")
@@ -210,13 +219,44 @@ class OutputGooglePubsub(BaseModel):
     r"""The maximum number of in-progress API requests before backpressure is applied."""
 
     on_backpressure: Annotated[
-        Optional[OutputGooglePubsubBackpressureBehavior],
+        Annotated[
+            Optional[OutputGooglePubsubBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputGooglePubsubBackpressureBehavior.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[OutputGooglePubsubMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputGooglePubsubMode.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"
@@ -231,21 +271,68 @@ class OutputGooglePubsub(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[OutputGooglePubsubCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputGooglePubsubCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputGooglePubsubCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputGooglePubsubQueueFullBehavior],
+        Annotated[
+            Optional[OutputGooglePubsubQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputGooglePubsubQueueFullBehavior.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[OutputGooglePubsubMode], pydantic.Field(alias="pqMode")
-    ] = OutputGooglePubsubMode.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[OutputGooglePubsubPqControls], pydantic.Field(alias="pqControls")
     ] = None
+
+    @field_serializer("google_auth_method")
+    def serialize_google_auth_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGooglePubsubGoogleAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGooglePubsubBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_mode")
+    def serialize_pq_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGooglePubsubMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_compress")
+    def serialize_pq_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGooglePubsubCompression(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.OutputGooglePubsubQueueFullBehavior(value)
+            except ValueError:
+                return value
+        return value