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

cribl_control_plane/models/functionsort.py

@@ -0,0 +1,97 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionSortID(str, Enum):
+    SORT = "sort"
+
+
+class SortConfigurationTypedDict(TypedDict):
+    comparison_expression: str
+    r"""The expression can access the events via the 'left' and 'right' properties."""
+    sort_id: NotRequired[str]
+    r"""Has to be unique if there are multiple sorts on the pipeline."""
+    top_n: NotRequired[float]
+    r"""Limits the output to N (highest/lowest) events"""
+    max_events: NotRequired[float]
+    r"""Specifies the number of events that can flow into this function"""
+    suppress_previews: NotRequired[bool]
+    r"""Toggle this on to suppress generating previews of intermediate results"""
+
+
+class SortConfiguration(BaseModel):
+    comparison_expression: Annotated[str, pydantic.Field(alias="comparisonExpression")]
+    r"""The expression can access the events via the 'left' and 'right' properties."""
+
+    sort_id: Annotated[Optional[str], pydantic.Field(alias="sortId")] = None
+    r"""Has to be unique if there are multiple sorts on the pipeline."""
+
+    top_n: Annotated[Optional[float], pydantic.Field(alias="topN")] = None
+    r"""Limits the output to N (highest/lowest) events"""
+
+    max_events: Annotated[Optional[float], pydantic.Field(alias="maxEvents")] = None
+    r"""Specifies the number of events that can flow into this function"""
+
+    suppress_previews: Annotated[
+        Optional[bool], pydantic.Field(alias="suppressPreviews")
+    ] = None
+    r"""Toggle this on to suppress generating previews of intermediate results"""
+
+
+class FunctionSortTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionSortID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[SortConfigurationTypedDict]
+
+
+class FunctionSort(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionSortID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[Optional[SortConfiguration], pydantic.Field(alias="schema")] = (
+        None
+    )

cribl_control_plane/models/functionstore.py

@@ -0,0 +1,132 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionStoreID(str, Enum):
+    STORE = "store"
+
+
+class MappingOfFieldNamesTypedDict(TypedDict):
+    r"""Mapping event property names to output field names"""
+
+
+class MappingOfFieldNames(BaseModel):
+    r"""Mapping event property names to output field names"""
+
+
+class StoreFunctionConfigurationTypedDict(TypedDict):
+    type: NotRequired[str]
+    r"""The type of knowledge object, generated by the function (i.e., 'lookup')"""
+    destination: NotRequired[str]
+    r"""Configures where and how the data should be stored"""
+    description: NotRequired[str]
+    r"""The knowledge object's description"""
+    field_mapping: NotRequired[MappingOfFieldNamesTypedDict]
+    r"""Mapping event property names to output field names"""
+    separator: NotRequired[str]
+    r"""Character to be used as value delimiter in output"""
+    overwrite: NotRequired[bool]
+    r"""For existing files, an error is thrown if overwrite is false or the file is replaced if overwrite is true"""
+    compress: NotRequired[str]
+    r"""True will compress output, false leaves it as it is and auto decides based on size"""
+    tee: NotRequired[bool]
+    r"""Tee results to the next operator"""
+    max_events: NotRequired[float]
+    r"""Limits how many events can be stored"""
+    suppress_previews: NotRequired[bool]
+    r"""Suppresses the timer-based export stats generating"""
+
+
+class StoreFunctionConfiguration(BaseModel):
+    type: Optional[str] = "lookup"
+    r"""The type of knowledge object, generated by the function (i.e., 'lookup')"""
+
+    destination: Optional[str] = None
+    r"""Configures where and how the data should be stored"""
+
+    description: Optional[str] = None
+    r"""The knowledge object's description"""
+
+    field_mapping: Annotated[
+        Optional[MappingOfFieldNames], pydantic.Field(alias="fieldMapping")
+    ] = None
+    r"""Mapping event property names to output field names"""
+
+    separator: Optional[str] = ","
+    r"""Character to be used as value delimiter in output"""
+
+    overwrite: Optional[bool] = False
+    r"""For existing files, an error is thrown if overwrite is false or the file is replaced if overwrite is true"""
+
+    compress: Optional[str] = "auto"
+    r"""True will compress output, false leaves it as it is and auto decides based on size"""
+
+    tee: Optional[bool] = False
+    r"""Tee results to the next operator"""
+
+    max_events: Annotated[Optional[float], pydantic.Field(alias="maxEvents")] = 10000
+    r"""Limits how many events can be stored"""
+
+    suppress_previews: Annotated[
+        Optional[bool], pydantic.Field(alias="suppressPreviews")
+    ] = False
+    r"""Suppresses the timer-based export stats generating"""
+
+
+class FunctionStoreTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionStoreID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[StoreFunctionConfigurationTypedDict]
+
+
+class FunctionStore(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionStoreID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[StoreFunctionConfiguration], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionsuppress.py

@@ -0,0 +1,115 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionSuppressID(str, Enum):
+    SUPPRESS = "suppress"
+
+
+class FunctionSuppressSchemaTypedDict(TypedDict):
+    key_expr: str
+    r"""Suppression key expression used to uniquely identify events to suppress. For example, `${ip}:${port}` will use fields ip and port from each event to generate the key."""
+    allow: NotRequired[float]
+    r"""The number of events to allow per time period"""
+    suppress_period_sec: NotRequired[float]
+    r"""The number of seconds to suppress events after 'Number to allow' events are received"""
+    drop_events_mode: NotRequired[bool]
+    r"""If disabled, suppressed events will be tagged with suppress=1 but not dropped"""
+    max_cache_size: NotRequired[float]
+    r"""The maximum number of keys that can be cached before idle entries are removed. Leave at default unless you understand the implications of changing."""
+    cache_idle_timeout_periods: NotRequired[float]
+    r"""The number of suppression periods 'Suppression Period' of inactivity before a cache entry is considered idle. Leave at default unless you understand the implications of changing."""
+    num_events_idle_timeout_trigger: NotRequired[float]
+    r"""Check cache for idle sessions every N events when cache size is > 'Maximum Cache Size'. Leave at default unless you understand the implications of changing."""
+
+
+class FunctionSuppressSchema(BaseModel):
+    key_expr: Annotated[str, pydantic.Field(alias="keyExpr")]
+    r"""Suppression key expression used to uniquely identify events to suppress. For example, `${ip}:${port}` will use fields ip and port from each event to generate the key."""
+
+    allow: Optional[float] = 1
+    r"""The number of events to allow per time period"""
+
+    suppress_period_sec: Annotated[
+        Optional[float], pydantic.Field(alias="suppressPeriodSec")
+    ] = 30
+    r"""The number of seconds to suppress events after 'Number to allow' events are received"""
+
+    drop_events_mode: Annotated[
+        Optional[bool], pydantic.Field(alias="dropEventsMode")
+    ] = True
+    r"""If disabled, suppressed events will be tagged with suppress=1 but not dropped"""
+
+    max_cache_size: Annotated[Optional[float], pydantic.Field(alias="maxCacheSize")] = (
+        50000
+    )
+    r"""The maximum number of keys that can be cached before idle entries are removed. Leave at default unless you understand the implications of changing."""
+
+    cache_idle_timeout_periods: Annotated[
+        Optional[float], pydantic.Field(alias="cacheIdleTimeoutPeriods")
+    ] = 2
+    r"""The number of suppression periods 'Suppression Period' of inactivity before a cache entry is considered idle. Leave at default unless you understand the implications of changing."""
+
+    num_events_idle_timeout_trigger: Annotated[
+        Optional[float], pydantic.Field(alias="numEventsIdleTimeoutTrigger")
+    ] = 10000
+    r"""Check cache for idle sessions every N events when cache size is > 'Maximum Cache Size'. Leave at default unless you understand the implications of changing."""
+
+
+class FunctionSuppressTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionSuppressID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionSuppressSchemaTypedDict]
+
+
+class FunctionSuppress(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionSuppressID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[FunctionSuppressSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functiontee.py

@@ -0,0 +1,90 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionTeeID(str, Enum):
+    TEE = "tee"
+
+
+class FunctionTeeSchemaTypedDict(TypedDict):
+    command: str
+    r"""Command to execute and feed events to, via stdin. One JSON-formatted event per line."""
+    args: NotRequired[List[str]]
+    restart_on_exit: NotRequired[bool]
+    r"""Restart the process if it exits and/or we fail to write to it"""
+    env: NotRequired[Dict[str, str]]
+    r"""Environment variables to overwrite or set"""
+
+
+class FunctionTeeSchema(BaseModel):
+    command: str
+    r"""Command to execute and feed events to, via stdin. One JSON-formatted event per line."""
+
+    args: Optional[List[str]] = None
+
+    restart_on_exit: Annotated[
+        Optional[bool], pydantic.Field(alias="restartOnExit")
+    ] = True
+    r"""Restart the process if it exits and/or we fail to write to it"""
+
+    env: Optional[Dict[str, str]] = None
+    r"""Environment variables to overwrite or set"""
+
+
+class FunctionTeeTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionTeeID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionTeeSchemaTypedDict]
+
+
+class FunctionTee(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionTeeID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[Optional[FunctionTeeSchema], pydantic.Field(alias="schema")] = (
+        None
+    )

cribl_control_plane/models/functiontrimtimestamp.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionTrimTimestampID(str, Enum):
+    TRIM_TIMESTAMP = "trim_timestamp"
+
+
+class FunctionTrimTimestampSchemaTypedDict(TypedDict):
+    field: NotRequired[str]
+    r"""Name of field in which to save the timestamp. (If empty, timestamp will not be saved to a field.)"""
+
+
+class FunctionTrimTimestampSchema(BaseModel):
+    field: Optional[str] = None
+    r"""Name of field in which to save the timestamp. (If empty, timestamp will not be saved to a field.)"""
+
+
+class FunctionTrimTimestampTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionTrimTimestampID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionTrimTimestampSchemaTypedDict]
+
+
+class FunctionTrimTimestamp(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionTrimTimestampID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[FunctionTrimTimestampSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionunion.py

@@ -0,0 +1,80 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionUnionID(str, Enum):
+    UNION = "union"
+
+
+class UnionConfigurationTypedDict(TypedDict):
+    search_job_id: str
+    r"""The id for this search job."""
+    stage_ids: List[str]
+    r"""The stages we are unioning with."""
+
+
+class UnionConfiguration(BaseModel):
+    search_job_id: Annotated[str, pydantic.Field(alias="searchJobId")]
+    r"""The id for this search job."""
+
+    stage_ids: Annotated[List[str], pydantic.Field(alias="stageIds")]
+    r"""The stages we are unioning with."""
+
+
+class FunctionUnionTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionUnionID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[UnionConfigurationTypedDict]
+
+
+class FunctionUnion(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionUnionID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[Optional[UnionConfiguration], pydantic.Field(alias="schema")] = (
+        None
+    )

cribl_control_plane/models/functionunroll.py

@@ -0,0 +1,80 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionUnrollID(str, Enum):
+    UNROLL = "unroll"
+
+
+class FunctionUnrollSchemaTypedDict(TypedDict):
+    src_expr: NotRequired[str]
+    r"""Field in which to find/calculate the array to unroll. Example: _raw, _raw.split(/\n/)"""
+    dst_field: NotRequired[str]
+    r"""Field in destination event in which to place the unrolled value"""
+
+
+class FunctionUnrollSchema(BaseModel):
+    src_expr: Annotated[Optional[str], pydantic.Field(alias="srcExpr")] = "_raw"
+    r"""Field in which to find/calculate the array to unroll. Example: _raw, _raw.split(/\n/)"""
+
+    dst_field: Annotated[Optional[str], pydantic.Field(alias="dstField")] = "_raw"
+    r"""Field in destination event in which to place the unrolled value"""
+
+
+class FunctionUnrollTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionUnrollID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionUnrollSchemaTypedDict]
+
+
+class FunctionUnroll(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionUnrollID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[FunctionUnrollSchema], pydantic.Field(alias="schema")
+    ] = None