cribl-control-plane 0.4.0b23__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/pipelinefunctionlookup.py

@@ -0,0 +1,136 @@
+"""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, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionLookupID(str, Enum):
+    r"""Function ID"""
+
+    LOOKUP = "lookup"
+
+
+class PipelineFunctionLookupInFieldTypedDict(TypedDict):
+    event_field: str
+    r"""Field name as it appears in events"""
+    lookup_field: NotRequired[str]
+    r"""Optional: The field name as it appears in the lookup file. Defaults to event field name"""
+
+
+class PipelineFunctionLookupInField(BaseModel):
+    event_field: Annotated[str, pydantic.Field(alias="eventField")]
+    r"""Field name as it appears in events"""
+
+    lookup_field: Annotated[Optional[str], pydantic.Field(alias="lookupField")] = None
+    r"""Optional: The field name as it appears in the lookup file. Defaults to event field name"""
+
+
+class PipelineFunctionLookupOutFieldTypedDict(TypedDict):
+    lookup_field: str
+    r"""The field name as it appears in the lookup file"""
+    event_field: NotRequired[str]
+    r"""Optional: Field name to add to event. Defaults to lookup field name."""
+    default_value: NotRequired[str]
+    r"""Optional: Value to assign if lookup entry is not found"""
+
+
+class PipelineFunctionLookupOutField(BaseModel):
+    lookup_field: Annotated[str, pydantic.Field(alias="lookupField")]
+    r"""The field name as it appears in the lookup file"""
+
+    event_field: Annotated[Optional[str], pydantic.Field(alias="eventField")] = None
+    r"""Optional: Field name to add to event. Defaults to lookup field name."""
+
+    default_value: Annotated[Optional[str], pydantic.Field(alias="defaultValue")] = None
+    r"""Optional: Value to assign if lookup entry is not found"""
+
+
+class PipelineFunctionLookupConfTypedDict(TypedDict):
+    file: str
+    r"""Path to the lookup file. Reference environment variables via $. Example: $HOME/file.csv"""
+    db_lookup: NotRequired[bool]
+    r"""Enable to use a disk-based lookup. This option displays only the settings relevant to disk-based mode and hides those for in-memory lookups."""
+    match_mode: NotRequired[Any]
+    match_type: NotRequired[Any]
+    reload_period_sec: NotRequired[Any]
+    in_fields: NotRequired[List[PipelineFunctionLookupInFieldTypedDict]]
+    r"""Fields that should be used to key into the lookup table"""
+    out_fields: NotRequired[List[PipelineFunctionLookupOutFieldTypedDict]]
+    r"""Fields to add to events after matching lookup. Defaults to all if not specified."""
+    add_to_event: NotRequired[bool]
+    r"""Add the looked-up values to _raw, as key=value pairs"""
+    ignore_case: NotRequired[Any]
+
+
+class PipelineFunctionLookupConf(BaseModel):
+    file: str
+    r"""Path to the lookup file. Reference environment variables via $. Example: $HOME/file.csv"""
+
+    db_lookup: Annotated[Optional[bool], pydantic.Field(alias="dbLookup")] = False
+    r"""Enable to use a disk-based lookup. This option displays only the settings relevant to disk-based mode and hides those for in-memory lookups."""
+
+    match_mode: Annotated[Optional[Any], pydantic.Field(alias="matchMode")] = None
+
+    match_type: Annotated[Optional[Any], pydantic.Field(alias="matchType")] = None
+
+    reload_period_sec: Annotated[
+        Optional[Any], pydantic.Field(alias="reloadPeriodSec")
+    ] = None
+
+    in_fields: Annotated[
+        Optional[List[PipelineFunctionLookupInField]], pydantic.Field(alias="inFields")
+    ] = None
+    r"""Fields that should be used to key into the lookup table"""
+
+    out_fields: Annotated[
+        Optional[List[PipelineFunctionLookupOutField]],
+        pydantic.Field(alias="outFields"),
+    ] = None
+    r"""Fields to add to events after matching lookup. Defaults to all if not specified."""
+
+    add_to_event: Annotated[Optional[bool], pydantic.Field(alias="addToEvent")] = False
+    r"""Add the looked-up values to _raw, as key=value pairs"""
+
+    ignore_case: Annotated[Optional[Any], pydantic.Field(alias="ignoreCase")] = None
+
+
+class PipelineFunctionLookupTypedDict(TypedDict):
+    id: PipelineFunctionLookupID
+    r"""Function ID"""
+    conf: PipelineFunctionLookupConfTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionLookup(BaseModel):
+    id: PipelineFunctionLookupID
+    r"""Function ID"""
+
+    conf: PipelineFunctionLookupConf
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionmask.py

@@ -0,0 +1,108 @@
+"""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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionMaskID(str, Enum):
+    r"""Function ID"""
+
+    MASK = "mask"
+
+
+class PipelineFunctionMaskRuleTypedDict(TypedDict):
+    match_regex: str
+    r"""Pattern to replace. Use /g to replace all matches."""
+    replace_expr: NotRequired[str]
+    r"""A JavaScript expression or literal to replace the matching content. Capturing groups can be referenced as g1, g2, and so on, and event fields as event.<fieldName>."""
+    disabled: NotRequired[bool]
+    r"""Set to No to disable the evaluation of an individual rule"""
+
+
+class PipelineFunctionMaskRule(BaseModel):
+    match_regex: Annotated[str, pydantic.Field(alias="matchRegex")]
+    r"""Pattern to replace. Use /g to replace all matches."""
+
+    replace_expr: Annotated[Optional[str], pydantic.Field(alias="replaceExpr")] = "''"
+    r"""A JavaScript expression or literal to replace the matching content. Capturing groups can be referenced as g1, g2, and so on, and event fields as event.<fieldName>."""
+
+    disabled: Optional[bool] = False
+    r"""Set to No to disable the evaluation of an individual rule"""
+
+
+class PipelineFunctionMaskFlagTypedDict(TypedDict):
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+    name: NotRequired[str]
+
+
+class PipelineFunctionMaskFlag(BaseModel):
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+
+    name: Optional[str] = None
+
+
+class PipelineFunctionMaskConfTypedDict(TypedDict):
+    rules: List[PipelineFunctionMaskRuleTypedDict]
+    fields: NotRequired[List[str]]
+    r"""Fields on which to apply the masking rules. Supports * wildcards, except when used on internal fields."""
+    depth: NotRequired[int]
+    r"""Depth to which the Mask Function will search for fields to mask"""
+    flags: NotRequired[List[PipelineFunctionMaskFlagTypedDict]]
+    r"""Fields to evaluate if one or more masking rules are matched"""
+
+
+class PipelineFunctionMaskConf(BaseModel):
+    rules: List[PipelineFunctionMaskRule]
+
+    fields: Optional[List[str]] = None
+    r"""Fields on which to apply the masking rules. Supports * wildcards, except when used on internal fields."""
+
+    depth: Optional[int] = 5
+    r"""Depth to which the Mask Function will search for fields to mask"""
+
+    flags: Optional[List[PipelineFunctionMaskFlag]] = None
+    r"""Fields to evaluate if one or more masking rules are matched"""
+
+
+class PipelineFunctionMaskTypedDict(TypedDict):
+    id: PipelineFunctionMaskID
+    r"""Function ID"""
+    conf: PipelineFunctionMaskConfTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionMask(BaseModel):
+    id: PipelineFunctionMaskID
+    r"""Function ID"""
+
+    conf: PipelineFunctionMaskConf
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionmvexpand.py

@@ -0,0 +1,116 @@
+"""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
+
+
+class PipelineFunctionMvExpandID(str, Enum):
+    r"""Function ID"""
+
+    MV_EXPAND = "mv_expand"
+
+
+class PipelineFunctionMvExpandBagExpansionMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""decides if bag-values are expanded to bags or arrays"""
+
+    # Store as object
+    BAG = "bag"
+    # Store as array
+    ARRAY = "array"
+
+
+class PipelineFunctionMvExpandConfTypedDict(TypedDict):
+    source_fields: List[str]
+    r"""Array of property-/field-names to expand"""
+    target_names: NotRequired[List[str]]
+    r"""stores the value as new target field name"""
+    row_limit: NotRequired[float]
+    r"""max. number of rows generated out of every source events"""
+    item_index_name: NotRequired[str]
+    r"""name of an optional index property generated into the output"""
+    bag_expansion_mode: NotRequired[PipelineFunctionMvExpandBagExpansionMode]
+    r"""decides if bag-values are expanded to bags or arrays"""
+
+
+class PipelineFunctionMvExpandConf(BaseModel):
+    source_fields: Annotated[List[str], pydantic.Field(alias="sourceFields")]
+    r"""Array of property-/field-names to expand"""
+
+    target_names: Annotated[
+        Optional[List[str]], pydantic.Field(alias="targetNames")
+    ] = None
+    r"""stores the value as new target field name"""
+
+    row_limit: Annotated[Optional[float], pydantic.Field(alias="rowLimit")] = (
+        9007199254740991
+    )
+    r"""max. number of rows generated out of every source events"""
+
+    item_index_name: Annotated[Optional[str], pydantic.Field(alias="itemIndexName")] = (
+        None
+    )
+    r"""name of an optional index property generated into the output"""
+
+    bag_expansion_mode: Annotated[
+        Annotated[
+            Optional[PipelineFunctionMvExpandBagExpansionMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="bagExpansionMode"),
+    ] = PipelineFunctionMvExpandBagExpansionMode.BAG
+    r"""decides if bag-values are expanded to bags or arrays"""
+
+    @field_serializer("bag_expansion_mode")
+    def serialize_bag_expansion_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionMvExpandBagExpansionMode(value)
+            except ValueError:
+                return value
+        return value
+
+
+class PipelineFunctionMvExpandTypedDict(TypedDict):
+    id: PipelineFunctionMvExpandID
+    r"""Function ID"""
+    conf: PipelineFunctionMvExpandConfTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionMvExpand(BaseModel):
+    id: PipelineFunctionMvExpandID
+    r"""Function ID"""
+
+    conf: PipelineFunctionMvExpandConf
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionmvpull.py

@@ -0,0 +1,86 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionMvPullID(str, Enum):
+    r"""Function ID"""
+
+    MV_PULL = "mv_pull"
+
+
+class PipelineFunctionMvPullConfTypedDict(TypedDict):
+    array_path: str
+    r"""Field name of the array within events that contains the data objects of interest. Can be a path."""
+    relative_key_path: str
+    r"""Extract the K-V pair's key from this field, relative to the data object."""
+    relative_value_path: str
+    r"""Extract the K-V pair's value from this field, relative to the data object."""
+    target_bag_path: NotRequired[str]
+    r"""Optionally, specify a bag as the target for K-V entries. If not specified, these entries are stored on each top-level event."""
+    delete_original: NotRequired[bool]
+    r"""Toggle this on to remove each original array of data objects after extraction. If toggled off, arrays are retained."""
+
+
+class PipelineFunctionMvPullConf(BaseModel):
+    array_path: Annotated[str, pydantic.Field(alias="arrayPath")]
+    r"""Field name of the array within events that contains the data objects of interest. Can be a path."""
+
+    relative_key_path: Annotated[str, pydantic.Field(alias="relativeKeyPath")]
+    r"""Extract the K-V pair's key from this field, relative to the data object."""
+
+    relative_value_path: Annotated[str, pydantic.Field(alias="relativeValuePath")]
+    r"""Extract the K-V pair's value from this field, relative to the data object."""
+
+    target_bag_path: Annotated[Optional[str], pydantic.Field(alias="targetBagPath")] = (
+        None
+    )
+    r"""Optionally, specify a bag as the target for K-V entries. If not specified, these entries are stored on each top-level event."""
+
+    delete_original: Annotated[
+        Optional[bool], pydantic.Field(alias="deleteOriginal")
+    ] = False
+    r"""Toggle this on to remove each original array of data objects after extraction. If toggled off, arrays are retained."""
+
+
+class PipelineFunctionMvPullTypedDict(TypedDict):
+    id: PipelineFunctionMvPullID
+    r"""Function ID"""
+    conf: PipelineFunctionMvPullConfTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionMvPull(BaseModel):
+    id: PipelineFunctionMvPullID
+    r"""Function ID"""
+
+    conf: PipelineFunctionMvPullConf
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionnotificationpolicies.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemanotificationpolicies import (
+    FunctionConfSchemaNotificationPolicies,
+    FunctionConfSchemaNotificationPoliciesTypedDict,
+)
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionNotificationPoliciesID(str, Enum):
+    r"""Function ID"""
+
+    NOTIFICATION_POLICIES = "notification_policies"
+
+
+class PipelineFunctionNotificationPoliciesTypedDict(TypedDict):
+    id: PipelineFunctionNotificationPoliciesID
+    r"""Function ID"""
+    conf: FunctionConfSchemaNotificationPoliciesTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionNotificationPolicies(BaseModel):
+    id: PipelineFunctionNotificationPoliciesID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaNotificationPolicies
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionnotifications.py

@@ -0,0 +1,72 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionNotificationsID(str, Enum):
+    r"""Function ID"""
+
+    NOTIFICATIONS = "notifications"
+
+
+class PipelineFunctionNotificationsConfTypedDict(TypedDict):
+    id: str
+    r"""Notification ID"""
+    field: str
+    r"""Notification event state field name"""
+    deduplicate: bool
+    r"""Toggle deduplication."""
+
+
+class PipelineFunctionNotificationsConf(BaseModel):
+    id: str
+    r"""Notification ID"""
+
+    field: str
+    r"""Notification event state field name"""
+
+    deduplicate: bool
+    r"""Toggle deduplication."""
+
+
+class PipelineFunctionNotificationsTypedDict(TypedDict):
+    id: PipelineFunctionNotificationsID
+    r"""Function ID"""
+    conf: PipelineFunctionNotificationsConfTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionNotifications(BaseModel):
+    id: PipelineFunctionNotificationsID
+    r"""Function ID"""
+
+    conf: PipelineFunctionNotificationsConf
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""