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

cribl_control_plane/models/functiondynamicsampling.py

@@ -0,0 +1,121 @@
+"""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, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionDynamicSamplingID(str, Enum):
+    DYNAMIC_SAMPLING = "dynamic_sampling"
+
+
+class SampleMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Defines how sample rate will be derived: log(previousPeriodCount) or sqrt(previousPeriodCount)"""
+
+    # Logarithmic
+    LOG = "log"
+    # Square Root
+    SQRT = "sqrt"
+
+
+class FunctionDynamicSamplingSchemaTypedDict(TypedDict):
+    mode: NotRequired[SampleMode]
+    r"""Defines how sample rate will be derived: log(previousPeriodCount) or sqrt(previousPeriodCount)"""
+    key_expr: NotRequired[str]
+    r"""Expression used to derive sample group key. Example:`${domain}:${status}`. Each sample group will have its own derived sampling rate based on volume. Defaults to `${host}`."""
+    sample_period: NotRequired[float]
+    r"""How often (in seconds) sample rates will be adjusted"""
+    min_events: NotRequired[float]
+    r"""Minimum number of events that must be received in previous sample period for sampling mode to be applied to current period. If the number of events received for a sample group is less than this minimum, a sample rate of 1:1 is used."""
+    max_sample_rate: NotRequired[float]
+    r"""Maximum sampling rate. If computed sampling rate is above this value, it will be limited to this value."""
+
+
+class FunctionDynamicSamplingSchema(BaseModel):
+    mode: Annotated[Optional[SampleMode], PlainValidator(validate_open_enum(False))] = (
+        SampleMode.LOG
+    )
+    r"""Defines how sample rate will be derived: log(previousPeriodCount) or sqrt(previousPeriodCount)"""
+
+    key_expr: Annotated[Optional[str], pydantic.Field(alias="keyExpr")] = "`${host}`"
+    r"""Expression used to derive sample group key. Example:`${domain}:${status}`. Each sample group will have its own derived sampling rate based on volume. Defaults to `${host}`."""
+
+    sample_period: Annotated[Optional[float], pydantic.Field(alias="samplePeriod")] = 30
+    r"""How often (in seconds) sample rates will be adjusted"""
+
+    min_events: Annotated[Optional[float], pydantic.Field(alias="minEvents")] = 30
+    r"""Minimum number of events that must be received in previous sample period for sampling mode to be applied to current period. If the number of events received for a sample group is less than this minimum, a sample rate of 1:1 is used."""
+
+    max_sample_rate: Annotated[
+        Optional[float], pydantic.Field(alias="maxSampleRate")
+    ] = 100
+    r"""Maximum sampling rate. If computed sampling rate is above this value, it will be limited to this value."""
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.SampleMode(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionDynamicSamplingTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionDynamicSamplingID
+    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[FunctionDynamicSamplingSchemaTypedDict]
+
+
+class FunctionDynamicSampling(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionDynamicSamplingID
+
+    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[FunctionDynamicSamplingSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functioneval.py

@@ -0,0 +1,103 @@
+"""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 FunctionEvalID(str, Enum):
+    EVAL = "eval"
+
+
+class FunctionEvalAddTypedDict(TypedDict):
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+    name: NotRequired[str]
+    disabled: NotRequired[bool]
+    r"""Set to No to disable the evaluation of an individual expression"""
+
+
+class FunctionEvalAdd(BaseModel):
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+
+    name: Optional[str] = None
+
+    disabled: Optional[bool] = False
+    r"""Set to No to disable the evaluation of an individual expression"""
+
+
+class FunctionEvalSchemaTypedDict(TypedDict):
+    add: NotRequired[List[FunctionEvalAddTypedDict]]
+    r"""Set of key-value pairs to evaluate and add/set"""
+    keep: NotRequired[List[str]]
+    r"""List of fields to keep. Supports * wildcards. Takes precedence over 'Remove fields'."""
+    remove: NotRequired[List[str]]
+    r"""List of fields to remove. Supports * wildcards. Fields that match 'Keep fields' will not be removed. Enclose field names containing special characters in single or double quotes."""
+
+
+class FunctionEvalSchema(BaseModel):
+    add: Optional[List[FunctionEvalAdd]] = None
+    r"""Set of key-value pairs to evaluate and add/set"""
+
+    keep: Optional[List[str]] = None
+    r"""List of fields to keep. Supports * wildcards. Takes precedence over 'Remove fields'."""
+
+    remove: Optional[List[str]] = None
+    r"""List of fields to remove. Supports * wildcards. Fields that match 'Keep fields' will not be removed. Enclose field names containing special characters in single or double quotes."""
+
+
+class FunctionEvalTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionEvalID
+    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[FunctionEvalSchemaTypedDict]
+
+
+class FunctionEval(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionEvalID
+
+    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[FunctionEvalSchema], pydantic.Field(alias="schema")] = (
+        None
+    )

cribl_control_plane/models/functioneventbreaker.py

@@ -0,0 +1,103 @@
+"""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, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionEventBreakerID(str, Enum):
+    EVENT_BREAKER = "event_breaker"
+
+
+class ExistingOrNew(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Use Existing
+    EXISTING = "existing"
+    # Create New
+    NEW = "new"
+
+
+class FunctionEventBreakerSchemaTypedDict(TypedDict):
+    existing_or_new: NotRequired[ExistingOrNew]
+    should_mark_cribl_breaker: NotRequired[bool]
+    r"""Add this Function name to the cribl_breaker field"""
+
+
+class FunctionEventBreakerSchema(BaseModel):
+    existing_or_new: Annotated[
+        Annotated[Optional[ExistingOrNew], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="existingOrNew"),
+    ] = ExistingOrNew.EXISTING
+
+    should_mark_cribl_breaker: Annotated[
+        Optional[bool], pydantic.Field(alias="shouldMarkCriblBreaker")
+    ] = True
+    r"""Add this Function name to the cribl_breaker field"""
+
+    @field_serializer("existing_or_new")
+    def serialize_existing_or_new(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ExistingOrNew(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionEventBreakerTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionEventBreakerID
+    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[FunctionEventBreakerSchemaTypedDict]
+
+
+class FunctionEventBreaker(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionEventBreakerID
+
+    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[FunctionEventBreakerSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functioneventstats.py

@@ -0,0 +1,92 @@
+"""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 FunctionEventstatsID(str, Enum):
+    EVENTSTATS = "eventstats"
+
+
+class EventstatsConfigurationTypedDict(TypedDict):
+    aggregations: List[str]
+    r"""Aggregate function(s) to perform on events. E.g., sum(bytes).where(action=='REJECT').as(TotalBytes)"""
+    group_bys: NotRequired[List[str]]
+    r"""Fields to group aggregates by, supports wildcard expressions."""
+    max_events: NotRequired[float]
+    r"""Specifies how many events are at max kept in memory to be enriched with aggregations"""
+    flush_on_input_close: NotRequired[bool]
+    r"""Determines if aggregations should flush when an input stream is closed. If disabled, time window settings will control flush behavior."""
+
+
+class EventstatsConfiguration(BaseModel):
+    aggregations: List[str]
+    r"""Aggregate function(s) to perform on events. E.g., sum(bytes).where(action=='REJECT').as(TotalBytes)"""
+
+    group_bys: Annotated[Optional[List[str]], pydantic.Field(alias="groupBys")] = None
+    r"""Fields to group aggregates by, supports wildcard expressions."""
+
+    max_events: Annotated[Optional[float], pydantic.Field(alias="maxEvents")] = 50000
+    r"""Specifies how many events are at max kept in memory to be enriched with aggregations"""
+
+    flush_on_input_close: Annotated[
+        Optional[bool], pydantic.Field(alias="flushOnInputClose")
+    ] = False
+    r"""Determines if aggregations should flush when an input stream is closed. If disabled, time window settings will control flush behavior."""
+
+
+class FunctionEventstatsTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionEventstatsID
+    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[EventstatsConfigurationTypedDict]
+
+
+class FunctionEventstats(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionEventstatsID
+
+    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[EventstatsConfiguration], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionexternaldata.py

@@ -0,0 +1,73 @@
+"""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 FunctionExternaldataID(str, Enum):
+    EXTERNALDATA = "externaldata"
+
+
+class FunctionExternaldataSchemaTypedDict(TypedDict):
+    pass
+
+
+class FunctionExternaldataSchema(BaseModel):
+    pass
+
+
+class FunctionExternaldataTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionExternaldataID
+    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[FunctionExternaldataSchemaTypedDict]
+
+
+class FunctionExternaldata(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionExternaldataID
+
+    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[FunctionExternaldataSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionflatten.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 FunctionFlattenID(str, Enum):
+    FLATTEN = "flatten"
+
+
+class FunctionFlattenSchemaTypedDict(TypedDict):
+    fields: NotRequired[List[str]]
+    r"""List of top-level fields to include for flattening. Supports * wildcards, except when used on internal fields. Defaults to empty array, which means all fields."""
+    prefix: NotRequired[str]
+    r"""Prefix string for flattened field names. Defaults to empty."""
+    depth: NotRequired[float]
+    r"""Number representing the nested levels to consider for flattening. Defaults to 5. Minimum should be 1."""
+    delimiter: NotRequired[str]
+    r"""Delimiter to be used for flattening. Defaults to underscore."""
+
+
+class FunctionFlattenSchema(BaseModel):
+    fields: Optional[List[str]] = None
+    r"""List of top-level fields to include for flattening. Supports * wildcards, except when used on internal fields. Defaults to empty array, which means all fields."""
+
+    prefix: Optional[str] = ""
+    r"""Prefix string for flattened field names. Defaults to empty."""
+
+    depth: Optional[float] = 5
+    r"""Number representing the nested levels to consider for flattening. Defaults to 5. Minimum should be 1."""
+
+    delimiter: Optional[str] = "_"
+    r"""Delimiter to be used for flattening. Defaults to underscore."""
+
+
+class FunctionFlattenTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionFlattenID
+    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[FunctionFlattenSchemaTypedDict]
+
+
+class FunctionFlatten(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionFlattenID
+
+    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[FunctionFlattenSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionfoldkeys.py

@@ -0,0 +1,89 @@
+"""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 FunctionFoldkeysID(str, Enum):
+    FOLDKEYS = "foldkeys"
+
+
+class FunctionFoldkeysSchemaTypedDict(TypedDict):
+    delete_original: NotRequired[bool]
+    r"""When enabled (default), only the folded keys are kept. When disabled, the original entries are retained alongside the folded keys."""
+    separator: NotRequired[str]
+    r"""Character or string used to separate key levels to be folded. Defaults to the dot (.) character."""
+    selection_reg_exp: NotRequired[str]
+    r"""Optional regular expression to select a subset of the keys to fold."""
+
+
+class FunctionFoldkeysSchema(BaseModel):
+    delete_original: Annotated[
+        Optional[bool], pydantic.Field(alias="deleteOriginal")
+    ] = True
+    r"""When enabled (default), only the folded keys are kept. When disabled, the original entries are retained alongside the folded keys."""
+
+    separator: Optional[str] = "."
+    r"""Character or string used to separate key levels to be folded. Defaults to the dot (.) character."""
+
+    selection_reg_exp: Annotated[
+        Optional[str], pydantic.Field(alias="selectionRegExp")
+    ] = None
+    r"""Optional regular expression to select a subset of the keys to fold."""
+
+
+class FunctionFoldkeysTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionFoldkeysID
+    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[FunctionFoldkeysSchemaTypedDict]
+
+
+class FunctionFoldkeys(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionFoldkeysID
+
+    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[FunctionFoldkeysSchema], pydantic.Field(alias="schema")
+    ] = None