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

cribl_control_plane/models/inputgooglepubsub.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
 
@@ -23,20 +27,32 @@ class InputGooglePubsubConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputGooglePubsubMode(str, Enum):
+class InputGooglePubsubMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
-class InputGooglePubsubCompression(str, Enum):
+class InputGooglePubsubCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputGooglePubsubPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputGooglePubsubPqControls(BaseModel):
+    pass
+
+
 class InputGooglePubsubPqTypedDict(TypedDict):
     mode: NotRequired[InputGooglePubsubMode]
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
@@ -52,10 +68,13 @@ class InputGooglePubsubPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputGooglePubsubCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputGooglePubsubPqControlsTypedDict]
 
 
 class InputGooglePubsubPq(BaseModel):
-    mode: Optional[InputGooglePubsubMode] = InputGooglePubsubMode.ALWAYS
+    mode: Annotated[
+        Optional[InputGooglePubsubMode], PlainValidator(validate_open_enum(False))
+    ] = InputGooglePubsubMode.ALWAYS
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
     max_buffer_size: Annotated[
@@ -79,15 +98,45 @@ class InputGooglePubsubPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputGooglePubsubCompression] = InputGooglePubsubCompression.NONE
+    compress: Annotated[
+        Optional[InputGooglePubsubCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputGooglePubsubCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputGooglePubsubPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputGooglePubsubGoogleAuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputGooglePubsubMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputGooglePubsubCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputGooglePubsubGoogleAuthenticationMethod(
+    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"
 
 
@@ -105,13 +154,11 @@ class InputGooglePubsubMetadatum(BaseModel):
 
 
 class InputGooglePubsubTypedDict(TypedDict):
-    topic_name: str
-    r"""ID of the topic to receive events from"""
+    type: InputGooglePubsubType
     subscription_name: str
-    r"""ID of the subscription to use when receiving events"""
+    r"""ID of the subscription to use when receiving events. When Monitor subscription is enabled, the fully qualified subscription name must be entered. Example: projects/myProject/subscriptions/mySubscription"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputGooglePubsubType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -126,6 +173,10 @@ class InputGooglePubsubTypedDict(TypedDict):
     connections: NotRequired[List[InputGooglePubsubConnectionTypedDict]]
     r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
     pq: NotRequired[InputGooglePubsubPqTypedDict]
+    topic_name: NotRequired[str]
+    r"""ID of the topic to receive events from. When Monitor subscription is enabled, any value may be entered."""
+    monitor_subscription: NotRequired[bool]
+    r"""Use when the subscription is not created by this Source and topic is not known"""
     create_topic: NotRequired[bool]
     r"""Create topic if it does not exist"""
     create_subscription: NotRequired[bool]
@@ -152,17 +203,14 @@ class InputGooglePubsubTypedDict(TypedDict):
 
 
 class InputGooglePubsub(BaseModel):
-    topic_name: Annotated[str, pydantic.Field(alias="topicName")]
-    r"""ID of the topic to receive events from"""
+    type: InputGooglePubsubType
 
     subscription_name: Annotated[str, pydantic.Field(alias="subscriptionName")]
-    r"""ID of the subscription to use when receiving events"""
+    r"""ID of the subscription to use when receiving events. When Monitor subscription is enabled, the fully qualified subscription name must be entered. Example: projects/myProject/subscriptions/mySubscription"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputGooglePubsubType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -187,6 +235,14 @@ class InputGooglePubsub(BaseModel):
 
     pq: Optional[InputGooglePubsubPq] = None
 
+    topic_name: Annotated[Optional[str], pydantic.Field(alias="topicName")] = "cribl"
+    r"""ID of the topic to receive events from. When Monitor subscription is enabled, any value may be entered."""
+
+    monitor_subscription: Annotated[
+        Optional[bool], pydantic.Field(alias="monitorSubscription")
+    ] = False
+    r"""Use when the subscription is not created by this Source and topic is not known"""
+
     create_topic: Annotated[Optional[bool], pydantic.Field(alias="createTopic")] = False
     r"""Create topic if it does not exist"""
 
@@ -199,7 +255,10 @@ class InputGooglePubsub(BaseModel):
     r"""Region to retrieve messages from. 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[InputGooglePubsubGoogleAuthenticationMethod],
+        Annotated[
+            Optional[InputGooglePubsubGoogleAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="googleAuthMethod"),
     ] = InputGooglePubsubGoogleAuthenticationMethod.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."""
@@ -232,3 +291,12 @@ class InputGooglePubsub(BaseModel):
         Optional[bool], pydantic.Field(alias="orderedDelivery")
     ] = False
     r"""Receive events in the order they were added to the queue. The process sending events must have ordering enabled."""
+
+    @field_serializer("google_auth_method")
+    def serialize_google_auth_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputGooglePubsubGoogleAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value