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

cribl_control_plane/models/pipelinefunctiongrok.py

@@ -0,0 +1,83 @@
+"""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 PipelineFunctionGrokID(str, Enum):
+    r"""Function ID"""
+
+    GROK = "grok"
+
+
+class PipelineFunctionGrokPatternListTypedDict(TypedDict):
+    pattern: str
+    r"""Grok pattern to extract fields. Syntax supported: %{PATTERN_NAME:FIELD_NAME}"""
+
+
+class PipelineFunctionGrokPatternList(BaseModel):
+    pattern: str
+    r"""Grok pattern to extract fields. Syntax supported: %{PATTERN_NAME:FIELD_NAME}"""
+
+
+class PipelineFunctionGrokConfTypedDict(TypedDict):
+    pattern: str
+    r"""Grok pattern to extract fields. Syntax supported: %{PATTERN_NAME:FIELD_NAME}"""
+    pattern_list: NotRequired[List[PipelineFunctionGrokPatternListTypedDict]]
+    source: NotRequired[str]
+    r"""Field on which to perform Grok extractions"""
+
+
+class PipelineFunctionGrokConf(BaseModel):
+    pattern: str
+    r"""Grok pattern to extract fields. Syntax supported: %{PATTERN_NAME:FIELD_NAME}"""
+
+    pattern_list: Annotated[
+        Optional[List[PipelineFunctionGrokPatternList]],
+        pydantic.Field(alias="patternList"),
+    ] = None
+
+    source: Optional[str] = "_raw"
+    r"""Field on which to perform Grok extractions"""
+
+
+class PipelineFunctionGrokTypedDict(TypedDict):
+    id: PipelineFunctionGrokID
+    r"""Function ID"""
+    conf: PipelineFunctionGrokConfTypedDict
+    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 PipelineFunctionGrok(BaseModel):
+    id: PipelineFunctionGrokID
+    r"""Function ID"""
+
+    conf: PipelineFunctionGrokConf
+
+    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/pipelinefunctionhandlebar.py

@@ -0,0 +1,99 @@
+"""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 Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionHandlebarID(str, Enum):
+    r"""Function ID"""
+
+    HANDLEBAR = "handlebar"
+
+
+class PipelineFunctionHandlebarTemplateDefinitionTypedDict(TypedDict):
+    content: str
+    r"""Handlebars template string"""
+    description: NotRequired[str]
+    r"""Optional description of what this template is used for"""
+    type: NotRequired[str]
+    r"""Type categorization for the template (e.g., Universal, Email, Slack)"""
+
+
+class PipelineFunctionHandlebarTemplateDefinition(BaseModel):
+    content: str
+    r"""Handlebars template string"""
+
+    description: Optional[str] = None
+    r"""Optional description of what this template is used for"""
+
+    type: Optional[str] = "Universal"
+    r"""Type categorization for the template (e.g., Universal, Email, Slack)"""
+
+
+class PipelineFunctionHandlebarConfTypedDict(TypedDict):
+    templates: Dict[str, PipelineFunctionHandlebarTemplateDefinitionTypedDict]
+    r"""Object with template_id as keys and template definitions as values. Uses event.__template_id to select template at runtime."""
+    target_field: NotRequired[str]
+    r"""Field name to store the rendered template result. Defaults to _raw."""
+    parse_json: NotRequired[bool]
+    r"""Parse the rendered template as JSON and store as an object instead of a string. Useful for building structured data like Slack blocks."""
+    remove_on_null: NotRequired[bool]
+    r"""Remove the target field if the rendered result is empty or null."""
+
+
+class PipelineFunctionHandlebarConf(BaseModel):
+    templates: Dict[str, PipelineFunctionHandlebarTemplateDefinition]
+    r"""Object with template_id as keys and template definitions as values. Uses event.__template_id to select template at runtime."""
+
+    target_field: Annotated[Optional[str], pydantic.Field(alias="targetField")] = "_raw"
+    r"""Field name to store the rendered template result. Defaults to _raw."""
+
+    parse_json: Annotated[Optional[bool], pydantic.Field(alias="parseJson")] = False
+    r"""Parse the rendered template as JSON and store as an object instead of a string. Useful for building structured data like Slack blocks."""
+
+    remove_on_null: Annotated[Optional[bool], pydantic.Field(alias="removeOnNull")] = (
+        True
+    )
+    r"""Remove the target field if the rendered result is empty or null."""
+
+
+class PipelineFunctionHandlebarTypedDict(TypedDict):
+    id: PipelineFunctionHandlebarID
+    r"""Function ID"""
+    conf: PipelineFunctionHandlebarConfTypedDict
+    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 PipelineFunctionHandlebar(BaseModel):
+    id: PipelineFunctionHandlebarID
+    r"""Function ID"""
+
+    conf: PipelineFunctionHandlebarConf
+
+    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/pipelinefunctionjoin.py

@@ -0,0 +1,100 @@
+"""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 Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionJoinID(str, Enum):
+    r"""Function ID"""
+
+    JOIN = "join"
+
+
+class PipelineFunctionJoinFieldConditionTypedDict(TypedDict):
+    left_field_name: str
+    r"""The field name to join on, on the left side."""
+    right_field_name: str
+    r"""The field name on the right side of the data, i.e. the stage results, that we are joining with"""
+
+
+class PipelineFunctionJoinFieldCondition(BaseModel):
+    left_field_name: Annotated[str, pydantic.Field(alias="leftFieldName")]
+    r"""The field name to join on, on the left side."""
+
+    right_field_name: Annotated[str, pydantic.Field(alias="rightFieldName")]
+    r"""The field name on the right side of the data, i.e. the stage results, that we are joining with"""
+
+
+class JoinConfigurationTypedDict(TypedDict):
+    field_conditions: List[PipelineFunctionJoinFieldConditionTypedDict]
+    r"""Fields to use when joining"""
+    kind: NotRequired[str]
+    r"""Join kind, e.g. inner"""
+    hints: NotRequired[Dict[str, str]]
+    r"""Hints passed to the join function"""
+    search_job_id: NotRequired[str]
+    r"""The id for this search job."""
+    stage_id: NotRequired[str]
+    r"""The stage we are joining with."""
+
+
+class JoinConfiguration(BaseModel):
+    field_conditions: Annotated[
+        List[PipelineFunctionJoinFieldCondition],
+        pydantic.Field(alias="fieldConditions"),
+    ]
+    r"""Fields to use when joining"""
+
+    kind: Optional[str] = None
+    r"""Join kind, e.g. inner"""
+
+    hints: Optional[Dict[str, str]] = None
+    r"""Hints passed to the join function"""
+
+    search_job_id: Annotated[Optional[str], pydantic.Field(alias="searchJobId")] = None
+    r"""The id for this search job."""
+
+    stage_id: Annotated[Optional[str], pydantic.Field(alias="stageId")] = None
+    r"""The stage we are joining with."""
+
+
+class PipelineFunctionJoinTypedDict(TypedDict):
+    id: PipelineFunctionJoinID
+    r"""Function ID"""
+    conf: JoinConfigurationTypedDict
+    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 PipelineFunctionJoin(BaseModel):
+    id: PipelineFunctionJoinID
+    r"""Function ID"""
+
+    conf: JoinConfiguration
+
+    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/pipelinefunctionjsonunroll.py

@@ -0,0 +1,67 @@
+"""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 PipelineFunctionJSONUnrollID(str, Enum):
+    r"""Function ID"""
+
+    JSON_UNROLL = "json_unroll"
+
+
+class PipelineFunctionJSONUnrollConfTypedDict(TypedDict):
+    path: str
+    r"""Path to array to unroll, such as foo.0.bar"""
+    name: NotRequired[str]
+    r"""Name of each exploded array element in each new event. Leave empty to expand the array element with its original name."""
+
+
+class PipelineFunctionJSONUnrollConf(BaseModel):
+    path: str
+    r"""Path to array to unroll, such as foo.0.bar"""
+
+    name: Optional[str] = None
+    r"""Name of each exploded array element in each new event. Leave empty to expand the array element with its original name."""
+
+
+class PipelineFunctionJSONUnrollTypedDict(TypedDict):
+    id: PipelineFunctionJSONUnrollID
+    r"""Function ID"""
+    conf: PipelineFunctionJSONUnrollConfTypedDict
+    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 PipelineFunctionJSONUnroll(BaseModel):
+    id: PipelineFunctionJSONUnrollID
+    r"""Function ID"""
+
+    conf: PipelineFunctionJSONUnrollConf
+
+    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/pipelinefunctionlakeexport.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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionLakeExportID(str, Enum):
+    r"""Function ID"""
+
+    LAKE_EXPORT = "lake_export"
+
+
+class LakeExportConfigurationTypedDict(TypedDict):
+    search_job_id: str
+    r"""Id of the search job this function is running on."""
+    dataset: str
+    r"""Name of the dataset"""
+    lake: NotRequired[str]
+    r"""Name of the lake"""
+    tee: NotRequired[str]
+    r"""Tee results to search. When set to true results will be shipped instead of stats"""
+    flush_ms: NotRequired[float]
+    r"""How often are stats flushed in ms"""
+    suppress_previews: NotRequired[bool]
+    r"""Disables generation of intermediate stats. When true stats will be emitted only on end"""
+
+
+class LakeExportConfiguration(BaseModel):
+    search_job_id: Annotated[str, pydantic.Field(alias="searchJobId")]
+    r"""Id of the search job this function is running on."""
+
+    dataset: str
+    r"""Name of the dataset"""
+
+    lake: Optional[str] = "default"
+    r"""Name of the lake"""
+
+    tee: Optional[str] = "false"
+    r"""Tee results to search. When set to true results will be shipped instead of stats"""
+
+    flush_ms: Annotated[Optional[float], pydantic.Field(alias="flushMs")] = 1000
+    r"""How often are stats flushed in ms"""
+
+    suppress_previews: Annotated[
+        Optional[bool], pydantic.Field(alias="suppressPreviews")
+    ] = None
+    r"""Disables generation of intermediate stats. When true stats will be emitted only on end"""
+
+
+class PipelineFunctionLakeExportTypedDict(TypedDict):
+    id: PipelineFunctionLakeExportID
+    r"""Function ID"""
+    conf: LakeExportConfigurationTypedDict
+    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 PipelineFunctionLakeExport(BaseModel):
+    id: PipelineFunctionLakeExportID
+    r"""Function ID"""
+
+    conf: LakeExportConfiguration
+
+    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/pipelinefunctionlimit.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemalimit import (
+    FunctionConfSchemaLimit,
+    FunctionConfSchemaLimitTypedDict,
+)
+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 PipelineFunctionLimitID(str, Enum):
+    r"""Function ID"""
+
+    LIMIT = "limit"
+
+
+class PipelineFunctionLimitTypedDict(TypedDict):
+    id: PipelineFunctionLimitID
+    r"""Function ID"""
+    conf: FunctionConfSchemaLimitTypedDict
+    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 PipelineFunctionLimit(BaseModel):
+    id: PipelineFunctionLimitID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaLimit
+
+    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/pipelinefunctionlocalsearchdatatypeparser.py

@@ -0,0 +1,62 @@
+"""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 PipelineFunctionLocalSearchDatatypeParserID(str, Enum):
+    r"""Function ID"""
+
+    LOCAL_SEARCH_DATATYPE_PARSER = "local_search_datatype_parser"
+
+
+class PipelineFunctionLocalSearchDatatypeParserConfTypedDict(TypedDict):
+    ruleset_id: str
+    r"""ID of the local search datatype ruleset"""
+
+
+class PipelineFunctionLocalSearchDatatypeParserConf(BaseModel):
+    ruleset_id: Annotated[str, pydantic.Field(alias="rulesetId")]
+    r"""ID of the local search datatype ruleset"""
+
+
+class PipelineFunctionLocalSearchDatatypeParserTypedDict(TypedDict):
+    id: PipelineFunctionLocalSearchDatatypeParserID
+    r"""Function ID"""
+    conf: PipelineFunctionLocalSearchDatatypeParserConfTypedDict
+    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 PipelineFunctionLocalSearchDatatypeParser(BaseModel):
+    id: PipelineFunctionLocalSearchDatatypeParserID
+    r"""Function ID"""
+
+    conf: PipelineFunctionLocalSearchDatatypeParserConf
+
+    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/pipelinefunctionlocalsearchrulesetrunner.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemalocalsearchrulesetrunner import (
+    FunctionConfSchemaLocalSearchRulesetRunner,
+    FunctionConfSchemaLocalSearchRulesetRunnerTypedDict,
+)
+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 PipelineFunctionLocalSearchRulesetRunnerID(str, Enum):
+    r"""Function ID"""
+
+    LOCAL_SEARCH_RULESET_RUNNER = "local_search_ruleset_runner"
+
+
+class PipelineFunctionLocalSearchRulesetRunnerTypedDict(TypedDict):
+    id: PipelineFunctionLocalSearchRulesetRunnerID
+    r"""Function ID"""
+    conf: FunctionConfSchemaLocalSearchRulesetRunnerTypedDict
+    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 PipelineFunctionLocalSearchRulesetRunner(BaseModel):
+    id: PipelineFunctionLocalSearchRulesetRunnerID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaLocalSearchRulesetRunner
+
+    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"""