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

cribl_control_plane/models/outputdataset.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,22 @@ class OutputDatasetType(str, Enum):
     DATASET = "dataset"
 
 
-class OutputDatasetSeverity(str, Enum):
+class OutputDatasetSeverity(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Default value for event severity. If the `sev` or `__severity` fields are set on an event, the first one matching will override this value."""
 
+    # 0 - finest
     FINEST = "finest"
+    # 1 - finer
     FINER = "finer"
+    # 2 - fine
     FINE = "fine"
+    # 3 - info
     INFO = "info"
+    # 4 - warning
     WARNING = "warning"
+    # 5 - error
     ERROR = "error"
+    # 6 - fatal
     FATAL = "fatal"
 
 
@@ -78,11 +89,14 @@ class OutputDatasetTimeoutRetrySettings(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 DataSetSite(str, Enum):
+class DataSetSite(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""DataSet site to which events should be sent"""
 
+    # US
     US = "us"
+    # Europe
     EU = "eu"
+    # Custom
     CUSTOM = "custom"
 
 
@@ -97,51 +111,64 @@ class OutputDatasetExtraHTTPHeader(BaseModel):
     name: Optional[str] = None
 
 
-class OutputDatasetFailedRequestLoggingMode(str, Enum):
+class OutputDatasetFailedRequestLoggingMode(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 OutputDatasetBackpressureBehavior(str, Enum):
+class OutputDatasetBackpressureBehavior(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 OutputDatasetAuthenticationMethod(str, Enum):
+class OutputDatasetAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Enter API key directly, or select a stored secret"""
 
     MANUAL = "manual"
     SECRET = "secret"
 
 
-class OutputDatasetCompression(str, Enum):
+class OutputDatasetMode(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 OutputDatasetCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
-class OutputDatasetQueueFullBehavior(str, Enum):
+class OutputDatasetQueueFullBehavior(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 OutputDatasetMode(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 OutputDatasetPqControlsTypedDict(TypedDict):
     pass
 
@@ -151,9 +178,9 @@ class OutputDatasetPqControls(BaseModel):
 
 
 class OutputDatasetTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this output"""
     type: OutputDatasetType
+    id: NotRequired[str]
+    r"""Unique ID for this output"""
     pipeline: NotRequired[str]
     r"""Pipeline to process data before sending out to this output"""
     system_fields: NotRequired[List[str]]
@@ -214,6 +241,16 @@ class OutputDatasetTypedDict(TypedDict):
     r"""Maximum total size of the batches waiting to be sent. If left blank, defaults to 5 times the max body size (if set). If 0, no limit is enforced."""
     description: NotRequired[str]
     custom_url: 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[OutputDatasetMode]
+    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]
@@ -224,8 +261,6 @@ class OutputDatasetTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputDatasetQueueFullBehavior]
     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[OutputDatasetMode]
-    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[OutputDatasetPqControlsTypedDict]
     api_key: NotRequired[str]
     r"""A 'Log Write Access' API key for the DataSet account"""
@@ -234,11 +269,11 @@ class OutputDatasetTypedDict(TypedDict):
 
 
 class OutputDataset(BaseModel):
-    id: str
-    r"""Unique ID for this output"""
-
     type: OutputDatasetType
 
+    id: Optional[str] = None
+    r"""Unique ID for this output"""
+
     pipeline: Optional[str] = None
     r"""Pipeline to process data before sending out to this output"""
 
@@ -272,7 +307,10 @@ class OutputDataset(BaseModel):
     r"""Name of the event field that contains the timestamp. If not specified, defaults to `ts`, `_time`, or `Date.now()`, in that order."""
 
     default_severity: Annotated[
-        Optional[OutputDatasetSeverity], pydantic.Field(alias="defaultSeverity")
+        Annotated[
+            Optional[OutputDatasetSeverity], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="defaultSeverity"),
     ] = OutputDatasetSeverity.INFO
     r"""Default value for event severity. If the `sev` or `__severity` fields are set on an event, the first one matching will override this value."""
 
@@ -292,7 +330,9 @@ class OutputDataset(BaseModel):
     ] = False
     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."""
 
-    site: Optional[DataSetSite] = DataSetSite.US
+    site: Annotated[
+        Optional[DataSetSite], PlainValidator(validate_open_enum(False))
+    ] = DataSetSite.US
     r"""DataSet site to which events should be sent"""
 
     concurrency: Optional[float] = 5
@@ -339,7 +379,10 @@ class OutputDataset(BaseModel):
     r"""Enable round-robin DNS lookup. When a DNS server returns multiple addresses, @{product} will cycle through them in the order returned. For optimal performance, consider enabling this setting for non-load balanced destinations."""
 
     failed_request_logging_mode: Annotated[
-        Optional[OutputDatasetFailedRequestLoggingMode],
+        Annotated[
+            Optional[OutputDatasetFailedRequestLoggingMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="failedRequestLoggingMode"),
     ] = OutputDatasetFailedRequestLoggingMode.NONE
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
@@ -350,13 +393,20 @@ class OutputDataset(BaseModel):
     r"""List of headers that are safe to log in plain text"""
 
     on_backpressure: Annotated[
-        Optional[OutputDatasetBackpressureBehavior],
+        Annotated[
+            Optional[OutputDatasetBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputDatasetBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
 
     auth_type: Annotated[
-        Optional[OutputDatasetAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[OutputDatasetAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = OutputDatasetAuthenticationMethod.MANUAL
     r"""Enter API key directly, or select a stored secret"""
 
@@ -369,6 +419,34 @@ class OutputDataset(BaseModel):
 
     custom_url: Annotated[Optional[str], pydantic.Field(alias="customUrl")] = 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[OutputDatasetMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputDatasetMode.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"
@@ -383,21 +461,23 @@ class OutputDataset(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[OutputDatasetCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputDatasetCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputDatasetCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputDatasetQueueFullBehavior],
+        Annotated[
+            Optional[OutputDatasetQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputDatasetQueueFullBehavior.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[OutputDatasetMode], pydantic.Field(alias="pqMode")] = (
-        OutputDatasetMode.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[OutputDatasetPqControls], pydantic.Field(alias="pqControls")
     ] = None
@@ -407,3 +487,75 @@ class OutputDataset(BaseModel):
 
     text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
     r"""Select or create a stored text secret"""
+
+    @field_serializer("default_severity")
+    def serialize_default_severity(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputDatasetSeverity(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("site")
+    def serialize_site(self, value):
+        if isinstance(value, str):
+            try:
+                return models.DataSetSite(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.OutputDatasetFailedRequestLoggingMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputDatasetBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputDatasetAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_mode")
+    def serialize_pq_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputDatasetMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_compress")
+    def serialize_pq_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputDatasetCompression(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.OutputDatasetQueueFullBehavior(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/outputdevnull.py

@@ -13,9 +13,9 @@ class OutputDevnullType(str, Enum):
 
 
 class OutputDevnullTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this output"""
     type: OutputDevnullType
+    id: NotRequired[str]
+    r"""Unique ID for this output"""
     pipeline: NotRequired[str]
     r"""Pipeline to process data before sending out to this output"""
     system_fields: NotRequired[List[str]]
@@ -27,11 +27,11 @@ class OutputDevnullTypedDict(TypedDict):
 
 
 class OutputDevnull(BaseModel):
-    id: str
-    r"""Unique ID for this output"""
-
     type: OutputDevnullType
 
+    id: Optional[str] = None
+    r"""Unique ID for this output"""
+
     pipeline: Optional[str] = None
     r"""Pipeline to process data before sending out to this output"""
 

cribl_control_plane/models/outputdiskspool.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,7 +16,7 @@ class OutputDiskSpoolType(str, Enum):
     DISK_SPOOL = "disk_spool"
 
 
-class OutputDiskSpoolCompression(str, Enum):
+class OutputDiskSpoolCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data compression format. Default is gzip."""
 
     NONE = "none"
@@ -20,9 +24,9 @@ class OutputDiskSpoolCompression(str, Enum):
 
 
 class OutputDiskSpoolTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this output"""
     type: OutputDiskSpoolType
+    id: NotRequired[str]
+    r"""Unique ID for this output"""
     pipeline: NotRequired[str]
     r"""Pipeline to process data before sending out to this output"""
     system_fields: NotRequired[List[str]]
@@ -45,11 +49,11 @@ class OutputDiskSpoolTypedDict(TypedDict):
 
 
 class OutputDiskSpool(BaseModel):
-    id: str
-    r"""Unique ID for this output"""
-
     type: OutputDiskSpoolType
 
+    id: Optional[str] = None
+    r"""Unique ID for this output"""
+
     pipeline: Optional[str] = None
     r"""Pipeline to process data before sending out to this output"""
 
@@ -73,7 +77,9 @@ class OutputDiskSpool(BaseModel):
     max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
     r"""Maximum amount of time to retain data before older buckets are deleted. Examples: 2h, 4d. Default is 24h."""
 
-    compress: Optional[OutputDiskSpoolCompression] = OutputDiskSpoolCompression.GZIP
+    compress: Annotated[
+        Optional[OutputDiskSpoolCompression], PlainValidator(validate_open_enum(False))
+    ] = OutputDiskSpoolCompression.GZIP
     r"""Data compression format. Default is gzip."""
 
     partition_expr: Annotated[Optional[str], pydantic.Field(alias="partitionExpr")] = (
@@ -82,3 +88,12 @@ class OutputDiskSpool(BaseModel):
     r"""JavaScript expression defining how files are partitioned and organized within the time-buckets. If blank, the event's __partition property is used and otherwise, events go directly into the time-bucket directory."""
 
     description: Optional[str] = None
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputDiskSpoolCompression(value)
+            except ValueError:
+                return value
+        return value