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

cribl_control_plane/models/outputgooglechronicle.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,15 +16,23 @@ class OutputGoogleChronicleType(str, Enum):
     GOOGLE_CHRONICLE = "google_chronicle"
 
 
-class OutputGoogleChronicleAPIVersion(str, Enum):
+class OutputGoogleChronicleAPIVersion(str, Enum, metaclass=utils.OpenEnumMeta):
+    # V1
     V1 = "v1"
+    # V2
     V2 = "v2"
 
 
-class OutputGoogleChronicleAuthenticationMethod(str, Enum):
+class OutputGoogleChronicleAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    # API key
     MANUAL = "manual"
+    # API key secret
     SECRET = "secret"
+    # Service account credentials
     SERVICE_ACCOUNT = "serviceAccount"
+    # Service account credentials secret
     SERVICE_ACCOUNT_SECRET = "serviceAccountSecret"
 
 
@@ -78,8 +90,10 @@ class OutputGoogleChronicleTimeoutRetrySettings(BaseModel):
     r"""The maximum backoff interval, in milliseconds, Cribl Stream should apply. Default (and minimum) is 10,000 ms (10 seconds); maximum is 180,000 ms (180 seconds)."""
 
 
-class SendEventsAs(str, Enum):
+class SendEventsAs(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Unstructured
     UNSTRUCTURED = "unstructured"
+    # UDM
     UDM = "udm"
 
 
@@ -94,19 +108,29 @@ class OutputGoogleChronicleExtraHTTPHeader(BaseModel):
     name: Optional[str] = None
 
 
-class OutputGoogleChronicleFailedRequestLoggingMode(str, Enum):
+class OutputGoogleChronicleFailedRequestLoggingMode(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
+    # Payload
     PAYLOAD = "payload"
+    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
+    # None
     NONE = "none"
 
 
-class OutputGoogleChronicleBackpressureBehavior(str, Enum):
+class OutputGoogleChronicleBackpressureBehavior(
+    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"
 
 
@@ -121,39 +145,53 @@ class ExtraLogType(BaseModel):
     description: Optional[str] = None
 
 
-class CustomLabelTypedDict(TypedDict):
+class OutputGoogleChronicleCustomLabelTypedDict(TypedDict):
     key: str
     value: str
 
 
-class CustomLabel(BaseModel):
+class OutputGoogleChronicleCustomLabel(BaseModel):
     key: str
 
     value: str
 
 
-class OutputGoogleChronicleCompression(str, Enum):
+class UDMType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Defines the specific format for UDM events sent to Google SecOps. This must match the type of UDM data being sent."""
+
+    ENTITIES = "entities"
+    LOGS = "logs"
+
+
+class OutputGoogleChronicleMode(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 OutputGoogleChronicleCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
-class OutputGoogleChronicleQueueFullBehavior(str, Enum):
+class OutputGoogleChronicleQueueFullBehavior(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 OutputGoogleChronicleMode(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 OutputGoogleChroniclePqControlsTypedDict(TypedDict):
     pass
 
@@ -227,11 +265,13 @@ class OutputGoogleChronicleTypedDict(TypedDict):
     log_text_field: NotRequired[str]
     r"""Name of the event field that contains the log text to send. If not specified, Stream sends a JSON representation of the whole event."""
     customer_id: NotRequired[str]
-    r"""Unique identifier (UUID) corresponding to a particular SecOps instance. Provided by your SecOps representative."""
+    r"""A unique identifier (UUID) for your Google SecOps instance. This is provided by your Google representative and is required for API V2 authentication."""
     namespace: NotRequired[str]
     r"""User-configured environment namespace to identify the data domain the logs originated from. Use namespace as a tag to identify the appropriate data domain for indexing and enrichment functionality. Can be overwritten by event field __namespace."""
-    custom_labels: NotRequired[List[CustomLabelTypedDict]]
+    custom_labels: NotRequired[List[OutputGoogleChronicleCustomLabelTypedDict]]
     r"""Custom labels to be added to every batch"""
+    udm_type: NotRequired[UDMType]
+    r"""Defines the specific format for UDM events sent to Google SecOps. This must match the type of UDM data being sent."""
     api_key: NotRequired[str]
     r"""Organization's API key in Google SecOps"""
     api_key_secret: NotRequired[str]
@@ -240,6 +280,16 @@ class OutputGoogleChronicleTypedDict(TypedDict):
     r"""Contents of service account credentials (JSON keys) file downloaded from Google Cloud. To upload a file, click the upload button at this field's upper right."""
     service_account_credentials_secret: NotRequired[str]
     r"""Select or create a stored text secret"""
+    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[OutputGoogleChronicleMode]
+    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]
@@ -250,8 +300,6 @@ class OutputGoogleChronicleTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputGoogleChronicleQueueFullBehavior]
     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[OutputGoogleChronicleMode]
-    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[OutputGoogleChroniclePqControlsTypedDict]
 
 
@@ -276,11 +324,18 @@ class OutputGoogleChronicle(BaseModel):
     r"""Tags for filtering and grouping in @{product}"""
 
     api_version: Annotated[
-        Optional[OutputGoogleChronicleAPIVersion], pydantic.Field(alias="apiVersion")
+        Annotated[
+            Optional[OutputGoogleChronicleAPIVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="apiVersion"),
     ] = OutputGoogleChronicleAPIVersion.V1
 
     authentication_method: Annotated[
-        Optional[OutputGoogleChronicleAuthenticationMethod],
+        Annotated[
+            Optional[OutputGoogleChronicleAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="authenticationMethod"),
     ] = OutputGoogleChronicleAuthenticationMethod.SERVICE_ACCOUNT
 
@@ -301,7 +356,8 @@ class OutputGoogleChronicle(BaseModel):
     r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
 
     log_format_type: Annotated[
-        Optional[SendEventsAs], pydantic.Field(alias="logFormatType")
+        Annotated[Optional[SendEventsAs], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="logFormatType"),
     ] = SendEventsAs.UNSTRUCTURED
 
     region: Optional[str] = None
@@ -346,7 +402,10 @@ class OutputGoogleChronicle(BaseModel):
     r"""Headers to add to all events"""
 
     failed_request_logging_mode: Annotated[
-        Optional[OutputGoogleChronicleFailedRequestLoggingMode],
+        Annotated[
+            Optional[OutputGoogleChronicleFailedRequestLoggingMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="failedRequestLoggingMode"),
     ] = OutputGoogleChronicleFailedRequestLoggingMode.NONE
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
@@ -362,7 +421,10 @@ class OutputGoogleChronicle(BaseModel):
     r"""Enable round-robin DNS lookup. When a DNS server returns multiple addresses, @{product} will cycle through them in the order returned."""
 
     on_backpressure: Annotated[
-        Optional[OutputGoogleChronicleBackpressureBehavior],
+        Annotated[
+            Optional[OutputGoogleChronicleBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputGoogleChronicleBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
@@ -388,16 +450,23 @@ class OutputGoogleChronicle(BaseModel):
     r"""Name of the event field that contains the log text to send. If not specified, Stream sends a JSON representation of the whole event."""
 
     customer_id: Annotated[Optional[str], pydantic.Field(alias="customerId")] = None
-    r"""Unique identifier (UUID) corresponding to a particular SecOps instance. Provided by your SecOps representative."""
+    r"""A unique identifier (UUID) for your Google SecOps instance. This is provided by your Google representative and is required for API V2 authentication."""
 
     namespace: Optional[str] = None
     r"""User-configured environment namespace to identify the data domain the logs originated from. Use namespace as a tag to identify the appropriate data domain for indexing and enrichment functionality. Can be overwritten by event field __namespace."""
 
     custom_labels: Annotated[
-        Optional[List[CustomLabel]], pydantic.Field(alias="customLabels")
+        Optional[List[OutputGoogleChronicleCustomLabel]],
+        pydantic.Field(alias="customLabels"),
     ] = None
     r"""Custom labels to be added to every batch"""
 
+    udm_type: Annotated[
+        Annotated[Optional[UDMType], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="udmType"),
+    ] = UDMType.LOGS
+    r"""Defines the specific format for UDM events sent to Google SecOps. This must match the type of UDM data being sent."""
+
     api_key: Annotated[Optional[str], pydantic.Field(alias="apiKey")] = None
     r"""Organization's API key in Google SecOps"""
 
@@ -416,6 +485,35 @@ class OutputGoogleChronicle(BaseModel):
     ] = None
     r"""Select or create a stored text secret"""
 
+    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[OutputGoogleChronicleMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputGoogleChronicleMode.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"
@@ -430,21 +528,104 @@ class OutputGoogleChronicle(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[OutputGoogleChronicleCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputGoogleChronicleCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputGoogleChronicleCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputGoogleChronicleQueueFullBehavior],
+        Annotated[
+            Optional[OutputGoogleChronicleQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputGoogleChronicleQueueFullBehavior.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[OutputGoogleChronicleMode], pydantic.Field(alias="pqMode")
-    ] = OutputGoogleChronicleMode.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[OutputGoogleChroniclePqControls], pydantic.Field(alias="pqControls")
     ] = None
+
+    @field_serializer("api_version")
+    def serialize_api_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleChronicleAPIVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("authentication_method")
+    def serialize_authentication_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleChronicleAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("log_format_type")
+    def serialize_log_format_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.SendEventsAs(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("failed_request_logging_mode")
+    def serialize_failed_request_logging_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleChronicleFailedRequestLoggingMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleChronicleBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("udm_type")
+    def serialize_udm_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.UDMType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_mode")
+    def serialize_pq_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleChronicleMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_compress")
+    def serialize_pq_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleChronicleCompression(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.OutputGoogleChronicleQueueFullBehavior(value)
+            except ValueError:
+                return value
+        return value