cribl-control-plane 0.0.39__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/outputxsiam.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 Any, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -23,15 +27,18 @@ class OutputXsiamExtraHTTPHeader(BaseModel):
     name: Optional[str] = None
 
 
-class OutputXsiamFailedRequestLoggingMode(str, Enum):
+class OutputXsiamFailedRequestLoggingMode(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 OutputXsiamAuthenticationMethod(str, Enum):
+class OutputXsiamAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Enter a token directly, or provide a secret referencing a token"""
 
     TOKEN = "token"
@@ -92,11 +99,14 @@ class OutputXsiamTimeoutRetrySettings(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 OutputXsiamBackpressureBehavior(str, Enum):
+class OutputXsiamBackpressureBehavior(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"
 
 
@@ -113,28 +123,35 @@ class OutputXsiamURL(BaseModel):
     r"""Assign a weight (>0) to each endpoint to indicate its traffic-handling capability"""
 
 
-class OutputXsiamCompression(str, Enum):
+class OutputXsiamMode(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 OutputXsiamCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
-class OutputXsiamQueueFullBehavior(str, Enum):
+class OutputXsiamQueueFullBehavior(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 OutputXsiamMode(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 OutputXsiamPqControlsTypedDict(TypedDict):
     pass
 
@@ -207,6 +224,16 @@ class OutputXsiamTypedDict(TypedDict):
     r"""XSIAM authentication token"""
     text_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[OutputXsiamMode]
+    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]
@@ -217,8 +244,6 @@ class OutputXsiamTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputXsiamQueueFullBehavior]
     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[OutputXsiamMode]
-    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[OutputXsiamPqControlsTypedDict]
 
 
@@ -283,7 +308,10 @@ class OutputXsiam(BaseModel):
     r"""Headers to add to all events"""
 
     failed_request_logging_mode: Annotated[
-        Optional[OutputXsiamFailedRequestLoggingMode],
+        Annotated[
+            Optional[OutputXsiamFailedRequestLoggingMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="failedRequestLoggingMode"),
     ] = OutputXsiamFailedRequestLoggingMode.NONE
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
@@ -294,7 +322,11 @@ class OutputXsiam(BaseModel):
     r"""List of headers that are safe to log in plain text"""
 
     auth_type: Annotated[
-        Optional[OutputXsiamAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[OutputXsiamAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = OutputXsiamAuthenticationMethod.TOKEN
     r"""Enter a token directly, or provide a secret referencing a token"""
 
@@ -311,7 +343,7 @@ class OutputXsiam(BaseModel):
 
     response_honor_retry_after_header: Annotated[
         Optional[bool], pydantic.Field(alias="responseHonorRetryAfterHeader")
-    ] = False
+    ] = True
     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."""
 
     throttle_rate_req_per_sec: Annotated[
@@ -320,7 +352,10 @@ class OutputXsiam(BaseModel):
     r"""Maximum number of requests to limit to per second"""
 
     on_backpressure: Annotated[
-        Optional[OutputXsiamBackpressureBehavior],
+        Annotated[
+            Optional[OutputXsiamBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputXsiamBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
@@ -361,6 +396,32 @@ class OutputXsiam(BaseModel):
     text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = 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[OutputXsiamMode], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputXsiamMode.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"
@@ -375,20 +436,76 @@ class OutputXsiam(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[OutputXsiamCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputXsiamCompression], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputXsiamCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputXsiamQueueFullBehavior], pydantic.Field(alias="pqOnBackpressure")
+        Annotated[
+            Optional[OutputXsiamQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputXsiamQueueFullBehavior.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[OutputXsiamMode], pydantic.Field(alias="pqMode")] = (
-        OutputXsiamMode.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[OutputXsiamPqControls], pydantic.Field(alias="pqControls")
     ] = None
+
+    @field_serializer("failed_request_logging_mode")
+    def serialize_failed_request_logging_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputXsiamFailedRequestLoggingMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputXsiamAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputXsiamBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_mode")
+    def serialize_pq_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputXsiamMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_compress")
+    def serialize_pq_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputXsiamCompression(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.OutputXsiamQueueFullBehavior(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/packinfo.py

@@ -8,26 +8,27 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class PackInfoTagsTypedDict(TypedDict):
-    data_type: List[str]
-    technology: List[str]
+    data_type: NotRequired[List[str]]
     domain: NotRequired[List[str]]
     streamtags: NotRequired[List[str]]
+    technology: NotRequired[List[str]]
 
 
 class PackInfoTags(BaseModel):
-    data_type: Annotated[List[str], pydantic.Field(alias="dataType")]
-
-    technology: List[str]
+    data_type: Annotated[Optional[List[str]], pydantic.Field(alias="dataType")] = None
 
     domain: Optional[List[str]] = None
 
     streamtags: Optional[List[str]] = None
 
+    technology: Optional[List[str]] = None
+
 
 class PackInfoTypedDict(TypedDict):
     id: str
     source: str
     author: NotRequired[str]
+    dependencies: NotRequired[Dict[str, str]]
     description: NotRequired[str]
     display_name: NotRequired[str]
     exports: NotRequired[List[str]]
@@ -48,6 +49,8 @@ class PackInfo(BaseModel):
 
     author: Optional[str] = None
 
+    dependencies: Optional[Dict[str, str]] = None
+
     description: Optional[str] = None
 
     display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None

cribl_control_plane/models/packinstallinfo.py

@@ -8,27 +8,27 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class PackInstallInfoTagsTypedDict(TypedDict):
-    data_type: List[str]
-    technology: List[str]
+    data_type: NotRequired[List[str]]
     domain: NotRequired[List[str]]
     streamtags: NotRequired[List[str]]
+    technology: NotRequired[List[str]]
 
 
 class PackInstallInfoTags(BaseModel):
-    data_type: Annotated[List[str], pydantic.Field(alias="dataType")]
-
-    technology: List[str]
+    data_type: Annotated[Optional[List[str]], pydantic.Field(alias="dataType")] = None
 
     domain: Optional[List[str]] = None
 
     streamtags: Optional[List[str]] = None
 
+    technology: Optional[List[str]] = None
+
 
 class PackInstallInfoTypedDict(TypedDict):
     id: str
     source: str
-    warnings: Any
     author: NotRequired[str]
+    dependencies: NotRequired[Dict[str, str]]
     description: NotRequired[str]
     display_name: NotRequired[str]
     exports: NotRequired[List[str]]
@@ -40,6 +40,7 @@ class PackInstallInfoTypedDict(TypedDict):
     spec: NotRequired[str]
     tags: NotRequired[PackInstallInfoTagsTypedDict]
     version: NotRequired[str]
+    warnings: NotRequired[List[str]]
 
 
 class PackInstallInfo(BaseModel):
@@ -47,10 +48,10 @@ class PackInstallInfo(BaseModel):
 
     source: str
 
-    warnings: Any
-
     author: Optional[str] = None
 
+    dependencies: Optional[Dict[str, str]] = None
+
     description: Optional[str] = None
 
     display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None
@@ -74,3 +75,5 @@ class PackInstallInfo(BaseModel):
     tags: Optional[PackInstallInfoTags] = None
 
     version: Optional[str] = None
+
+    warnings: Optional[List[str]] = None

cribl_control_plane/models/piisettings_union.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+class PiiSettings2TypedDict(TypedDict):
+    pass
+
+
+class PiiSettings2(BaseModel):
+    pass
+
+
+class PiiSettings1TypedDict(TypedDict):
+    enable_pii_detection: bool
+
+
+class PiiSettings1(BaseModel):
+    enable_pii_detection: Annotated[bool, pydantic.Field(alias="enablePiiDetection")]
+
+
+PiiSettingsUnionTypedDict = TypeAliasType(
+    "PiiSettingsUnionTypedDict", Union[PiiSettings2TypedDict, PiiSettings1TypedDict]
+)
+
+
+PiiSettingsUnion = TypeAliasType("PiiSettingsUnion", Union[PiiSettings2, PiiSettings1])

cribl_control_plane/models/pipeline.py

@@ -2,6 +2,10 @@
 
 from __future__ import annotations
 from .pipelinefunctionconf import PipelineFunctionConf, PipelineFunctionConfTypedDict
+from .pipelinefunctionconf_input import (
+    PipelineFunctionConfInput,
+    PipelineFunctionConfInputTypedDict,
+)
 from cribl_control_plane.types import BaseModel
 import pydantic
 from typing import Dict, List, Optional
@@ -26,7 +30,7 @@ class PipelineGroups(BaseModel):
     r"""Whether this group is disabled"""
 
 
-class ConfTypedDict(TypedDict):
+class PipelineConfTypedDict(TypedDict):
     async_func_timeout: NotRequired[int]
     r"""Time (in ms) to wait for an async function to complete processing of a data item"""
     output: NotRequired[str]
@@ -39,7 +43,7 @@ class ConfTypedDict(TypedDict):
     groups: NotRequired[Dict[str, PipelineGroupsTypedDict]]
 
 
-class Conf(BaseModel):
+class PipelineConf(BaseModel):
     async_func_timeout: Annotated[
         Optional[int], pydantic.Field(alias="asyncFuncTimeout")
     ] = None
@@ -61,10 +65,54 @@ class Conf(BaseModel):
 
 class PipelineTypedDict(TypedDict):
     id: str
-    conf: ConfTypedDict
+    conf: PipelineConfTypedDict
 
 
 class Pipeline(BaseModel):
     id: str
 
-    conf: Conf
+    conf: PipelineConf
+
+
+class ConfInputTypedDict(TypedDict):
+    async_func_timeout: NotRequired[int]
+    r"""Time (in ms) to wait for an async function to complete processing of a data item"""
+    output: NotRequired[str]
+    r"""The output destination for events processed by this Pipeline"""
+    description: NotRequired[str]
+    streamtags: NotRequired[List[str]]
+    r"""Tags for filtering and grouping in @{product}"""
+    functions: NotRequired[List[PipelineFunctionConfInputTypedDict]]
+    r"""List of Functions to pass data through"""
+    groups: NotRequired[Dict[str, PipelineGroupsTypedDict]]
+
+
+class ConfInput(BaseModel):
+    async_func_timeout: Annotated[
+        Optional[int], pydantic.Field(alias="asyncFuncTimeout")
+    ] = None
+    r"""Time (in ms) to wait for an async function to complete processing of a data item"""
+
+    output: Optional[str] = "default"
+    r"""The output destination for events processed by this Pipeline"""
+
+    description: Optional[str] = None
+
+    streamtags: Optional[List[str]] = None
+    r"""Tags for filtering and grouping in @{product}"""
+
+    functions: Optional[List[PipelineFunctionConfInput]] = None
+    r"""List of Functions to pass data through"""
+
+    groups: Optional[Dict[str, PipelineGroups]] = None
+
+
+class PipelineInputTypedDict(TypedDict):
+    id: str
+    conf: ConfInputTypedDict
+
+
+class PipelineInput(BaseModel):
+    id: str
+
+    conf: ConfInput