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

cribl_control_plane/models/pipelinefunctionsensitivedatascanner.py

@@ -0,0 +1,120 @@
+"""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 PipelineFunctionSensitiveDataScannerID(str, Enum):
+    r"""Function ID"""
+
+    SENSITIVE_DATA_SCANNER = "sensitive_data_scanner"
+
+
+class PipelineFunctionSensitiveDataScannerRuleTypedDict(TypedDict):
+    ruleset_id: str
+    r"""The ID of the ruleset to use for the scan"""
+    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]
+
+
+class PipelineFunctionSensitiveDataScannerRule(BaseModel):
+    ruleset_id: Annotated[str, pydantic.Field(alias="rulesetId")]
+    r"""The ID of the ruleset to use for the scan"""
+
+    replace_expr: Annotated[Optional[str], pydantic.Field(alias="replaceExpr")] = (
+        "'REDACTED'"
+    )
+    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
+
+
+class PipelineFunctionSensitiveDataScannerFlagTypedDict(TypedDict):
+    value: str
+    name: NotRequired[str]
+
+
+class PipelineFunctionSensitiveDataScannerFlag(BaseModel):
+    value: str
+
+    name: Optional[str] = None
+
+
+class PipelineFunctionSensitiveDataScannerConfTypedDict(TypedDict):
+    rules: List[PipelineFunctionSensitiveDataScannerRuleTypedDict]
+    fields: NotRequired[List[str]]
+    r"""Rulesets act on the events contained in these fields. Mitigation expressions apply to the scan results. Supports wildcards (*)."""
+    exclude_fields: NotRequired[List[str]]
+    r"""Fields that the mitigation expression will not be applied to. Supports wildcards (*)."""
+    flags: NotRequired[List[PipelineFunctionSensitiveDataScannerFlagTypedDict]]
+    r"""Fields to add when mitigation is applied to an event"""
+    include_detected_rules: NotRequired[bool]
+    r"""Add matching ruleset IDs to a field called \"__detected\" """
+    background_detection: NotRequired[bool]
+
+
+class PipelineFunctionSensitiveDataScannerConf(BaseModel):
+    rules: List[PipelineFunctionSensitiveDataScannerRule]
+
+    fields: Optional[List[str]] = None
+    r"""Rulesets act on the events contained in these fields. Mitigation expressions apply to the scan results. Supports wildcards (*)."""
+
+    exclude_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="excludeFields")
+    ] = None
+    r"""Fields that the mitigation expression will not be applied to. Supports wildcards (*)."""
+
+    flags: Optional[List[PipelineFunctionSensitiveDataScannerFlag]] = None
+    r"""Fields to add when mitigation is applied to an event"""
+
+    include_detected_rules: Annotated[
+        Optional[bool], pydantic.Field(alias="includeDetectedRules")
+    ] = True
+    r"""Add matching ruleset IDs to a field called \"__detected\" """
+
+    background_detection: Annotated[
+        Optional[bool], pydantic.Field(alias="backgroundDetection")
+    ] = False
+
+
+class PipelineFunctionSensitiveDataScannerTypedDict(TypedDict):
+    id: PipelineFunctionSensitiveDataScannerID
+    r"""Function ID"""
+    conf: PipelineFunctionSensitiveDataScannerConfTypedDict
+    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 PipelineFunctionSensitiveDataScanner(BaseModel):
+    id: PipelineFunctionSensitiveDataScannerID
+    r"""Function ID"""
+
+    conf: PipelineFunctionSensitiveDataScannerConf
+
+    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/pipelinefunctionserde.py

@@ -0,0 +1,149 @@
+"""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, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionSerdeID(str, Enum):
+    r"""Function ID"""
+
+    SERDE = "serde"
+
+
+class PipelineFunctionSerdeOperationMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Extract creates new fields. Reserialize extracts and filters fields, and then reserializes."""
+
+    # Extract
+    EXTRACT = "extract"
+    # Reserialize
+    RESERIALIZE = "reserialize"
+
+
+class PipelineFunctionSerdeType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Parser or formatter type to use"""
+
+    # CSV
+    CSV = "csv"
+    # Extended Log File Format
+    ELFF = "elff"
+    # Common Log Format
+    CLF = "clf"
+    # Key=Value Pairs
+    KVP = "kvp"
+    # JSON Object
+    JSON = "json"
+    # Delimited values
+    DELIM = "delim"
+    # Regular Expression
+    REGEX = "regex"
+    # Grok
+    GROK = "grok"
+
+
+class PipelineFunctionSerdeConfTypedDict(TypedDict):
+    mode: NotRequired[PipelineFunctionSerdeOperationMode]
+    r"""Extract creates new fields. Reserialize extracts and filters fields, and then reserializes."""
+    type: NotRequired[PipelineFunctionSerdeType]
+    r"""Parser or formatter type to use"""
+    delim_char: NotRequired[Any]
+    quote_char: NotRequired[Any]
+    escape_char: NotRequired[Any]
+    null_value: NotRequired[Any]
+    src_field: NotRequired[str]
+    r"""Field containing text to be parsed"""
+    dst_field: NotRequired[str]
+    r"""Name of the field to add fields to. Extract mode only."""
+    clean_fields: NotRequired[Any]
+
+
+class PipelineFunctionSerdeConf(BaseModel):
+    mode: Annotated[
+        Optional[PipelineFunctionSerdeOperationMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = PipelineFunctionSerdeOperationMode.EXTRACT
+    r"""Extract creates new fields. Reserialize extracts and filters fields, and then reserializes."""
+
+    type: Annotated[
+        Optional[PipelineFunctionSerdeType], PlainValidator(validate_open_enum(False))
+    ] = PipelineFunctionSerdeType.CSV
+    r"""Parser or formatter type to use"""
+
+    delim_char: Annotated[Optional[Any], pydantic.Field(alias="delimChar")] = None
+
+    quote_char: Annotated[Optional[Any], pydantic.Field(alias="quoteChar")] = None
+
+    escape_char: Annotated[Optional[Any], pydantic.Field(alias="escapeChar")] = None
+
+    null_value: Annotated[Optional[Any], pydantic.Field(alias="nullValue")] = None
+
+    src_field: Annotated[Optional[str], pydantic.Field(alias="srcField")] = "_raw"
+    r"""Field containing text to be parsed"""
+
+    dst_field: Annotated[Optional[str], pydantic.Field(alias="dstField")] = None
+    r"""Name of the field to add fields to. Extract mode only."""
+
+    clean_fields: Annotated[Optional[Any], pydantic.Field(alias="cleanFields")] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionSerdeOperationMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("type")
+    def serialize_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionSerdeType(value)
+            except ValueError:
+                return value
+        return value
+
+
+class PipelineFunctionSerdeTypedDict(TypedDict):
+    id: PipelineFunctionSerdeID
+    r"""Function ID"""
+    conf: PipelineFunctionSerdeConfTypedDict
+    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 PipelineFunctionSerde(BaseModel):
+    id: PipelineFunctionSerdeID
+    r"""Function ID"""
+
+    conf: PipelineFunctionSerdeConf
+
+    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/pipelinefunctionserialize.py

@@ -0,0 +1,122 @@
+"""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
+
+
+class PipelineFunctionSerializeID(str, Enum):
+    r"""Function ID"""
+
+    SERIALIZE = "serialize"
+
+
+class PipelineFunctionSerializeType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Data output format"""
+
+    # CSV
+    CSV = "csv"
+    # Extended Log File Format
+    ELFF = "elff"
+    # Common Log Format
+    CLF = "clf"
+    # Key=Value Pairs
+    KVP = "kvp"
+    # JSON Object
+    JSON = "json"
+    # Delimited values
+    DELIM = "delim"
+
+
+class PipelineFunctionSerializeConfTypedDict(TypedDict):
+    type: NotRequired[PipelineFunctionSerializeType]
+    r"""Data output format"""
+    delim_char: NotRequired[Any]
+    quote_char: NotRequired[Any]
+    escape_char: NotRequired[Any]
+    null_value: NotRequired[Any]
+    fields: NotRequired[List[str]]
+    r"""Required for CSV, ELFF, CLF, and Delimited values. All other formats support wildcard field lists. Examples: host, array*, !host *"""
+    src_field: NotRequired[str]
+    r"""Field containing object to serialize. Leave blank to serialize top-level event fields."""
+    dst_field: NotRequired[str]
+    r"""Field to serialize data to"""
+
+
+class PipelineFunctionSerializeConf(BaseModel):
+    type: Annotated[
+        Optional[PipelineFunctionSerializeType],
+        PlainValidator(validate_open_enum(False)),
+    ] = PipelineFunctionSerializeType.CSV
+    r"""Data output format"""
+
+    delim_char: Annotated[Optional[Any], pydantic.Field(alias="delimChar")] = None
+
+    quote_char: Annotated[Optional[Any], pydantic.Field(alias="quoteChar")] = None
+
+    escape_char: Annotated[Optional[Any], pydantic.Field(alias="escapeChar")] = None
+
+    null_value: Annotated[Optional[Any], pydantic.Field(alias="nullValue")] = None
+
+    fields: Optional[List[str]] = None
+    r"""Required for CSV, ELFF, CLF, and Delimited values. All other formats support wildcard field lists. Examples: host, array*, !host *"""
+
+    src_field: Annotated[Optional[str], pydantic.Field(alias="srcField")] = None
+    r"""Field containing object to serialize. Leave blank to serialize top-level event fields."""
+
+    dst_field: Annotated[Optional[str], pydantic.Field(alias="dstField")] = "_raw"
+    r"""Field to serialize data to"""
+
+    @field_serializer("type")
+    def serialize_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionSerializeType(value)
+            except ValueError:
+                return value
+        return value
+
+
+class PipelineFunctionSerializeTypedDict(TypedDict):
+    id: PipelineFunctionSerializeID
+    r"""Function ID"""
+    conf: PipelineFunctionSerializeConfTypedDict
+    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 PipelineFunctionSerialize(BaseModel):
+    id: PipelineFunctionSerializeID
+    r"""Function ID"""
+
+    conf: PipelineFunctionSerializeConf
+
+    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/pipelinefunctionsidlookup.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemasidlookup import (
+    FunctionConfSchemaSidlookup,
+    FunctionConfSchemaSidlookupTypedDict,
+)
+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 PipelineFunctionSidlookupID(str, Enum):
+    r"""Function ID"""
+
+    SIDLOOKUP = "sidlookup"
+
+
+class PipelineFunctionSidlookupTypedDict(TypedDict):
+    id: PipelineFunctionSidlookupID
+    r"""Function ID"""
+    conf: FunctionConfSchemaSidlookupTypedDict
+    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 PipelineFunctionSidlookup(BaseModel):
+    id: PipelineFunctionSidlookupID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaSidlookup
+
+    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/pipelinefunctionsnmptrapserialize.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemasnmptrapserialize import (
+    FunctionConfSchemaSnmpTrapSerialize,
+    FunctionConfSchemaSnmpTrapSerializeTypedDict,
+)
+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 PipelineFunctionSnmpTrapSerializeID(str, Enum):
+    r"""Function ID"""
+
+    SNMP_TRAP_SERIALIZE = "snmp_trap_serialize"
+
+
+class PipelineFunctionSnmpTrapSerializeTypedDict(TypedDict):
+    id: PipelineFunctionSnmpTrapSerializeID
+    r"""Function ID"""
+    conf: FunctionConfSchemaSnmpTrapSerializeTypedDict
+    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 PipelineFunctionSnmpTrapSerialize(BaseModel):
+    id: PipelineFunctionSnmpTrapSerializeID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaSnmpTrapSerialize
+
+    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/pipelinefunctionsort.py

@@ -0,0 +1,84 @@
+"""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 PipelineFunctionSortID(str, Enum):
+    r"""Function ID"""
+
+    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 PipelineFunctionSortTypedDict(TypedDict):
+    id: PipelineFunctionSortID
+    r"""Function ID"""
+    conf: SortConfigurationTypedDict
+    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 PipelineFunctionSort(BaseModel):
+    id: PipelineFunctionSortID
+    r"""Function ID"""
+
+    conf: SortConfiguration
+
+    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"""