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

cribl_control_plane/models/functionautotimestamp.py

@@ -0,0 +1,173 @@
+"""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, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionAutoTimestampID(str, Enum):
+    AUTO_TIMESTAMP = "auto_timestamp"
+
+
+class DefaultTime(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How to set the time field if no timestamp is found"""
+
+    # Current Time
+    NOW = "now"
+    # Last Event's Time
+    LAST = "last"
+    # None
+    NONE = "none"
+
+
+class TimestampTypedDict(TypedDict):
+    regex: str
+    r"""Regex with first capturing group matching the timestamp"""
+    strptime: str
+    r"""Select or enter strptime format for the captured timestamp"""
+
+
+class Timestamp(BaseModel):
+    regex: str
+    r"""Regex with first capturing group matching the timestamp"""
+
+    strptime: str
+    r"""Select or enter strptime format for the captured timestamp"""
+
+
+class FunctionAutoTimestampSchemaTypedDict(TypedDict):
+    src_field: NotRequired[str]
+    r"""Field to search for a timestamp"""
+    dst_field: NotRequired[str]
+    r"""Field to place timestamp in"""
+    default_timezone: NotRequired[str]
+    r"""Timezone to assign to timestamps without timezone info"""
+    time_expression: NotRequired[str]
+    r"""Expression to use to format time. Current time, as a JavaScript Date object, is in global `time`. You can access other fields' values via __e.<fieldName>."""
+    offset: NotRequired[float]
+    r"""The offset into the string from which to look for a timestamp"""
+    max_len: NotRequired[float]
+    r"""Maximum string length at which to look for a timestamp"""
+    default_time: NotRequired[DefaultTime]
+    r"""How to set the time field if no timestamp is found"""
+    latest_date_allowed: NotRequired[str]
+    r"""The latest timestamp value allowed relative to now, such as +42days. Parsed values after this date will be set to the Default time."""
+    spacer: NotRequired[str]
+    earliest_date_allowed: NotRequired[str]
+    r"""The earliest timestamp value allowed relative to now, such as -42years. Parsed values prior to this date will be set to the Default time."""
+    timestamps: NotRequired[List[TimestampTypedDict]]
+    r"""Add regex/strptime pairs to extract additional timestamp formats"""
+
+
+class FunctionAutoTimestampSchema(BaseModel):
+    src_field: Annotated[Optional[str], pydantic.Field(alias="srcField")] = "_raw"
+    r"""Field to search for a timestamp"""
+
+    dst_field: Annotated[Optional[str], pydantic.Field(alias="dstField")] = "_time"
+    r"""Field to place timestamp in"""
+
+    default_timezone: Annotated[
+        Optional[str], pydantic.Field(alias="defaultTimezone")
+    ] = "local"
+    r"""Timezone to assign to timestamps without timezone info"""
+
+    time_expression: Annotated[
+        Optional[str], pydantic.Field(alias="timeExpression")
+    ] = "time.getTime() / 1000"
+    r"""Expression to use to format time. Current time, as a JavaScript Date object, is in global `time`. You can access other fields' values via __e.<fieldName>."""
+
+    offset: Optional[float] = 0
+    r"""The offset into the string from which to look for a timestamp"""
+
+    max_len: Annotated[Optional[float], pydantic.Field(alias="maxLen")] = 150
+    r"""Maximum string length at which to look for a timestamp"""
+
+    default_time: Annotated[
+        Annotated[Optional[DefaultTime], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="defaultTime"),
+    ] = DefaultTime.NOW
+    r"""How to set the time field if no timestamp is found"""
+
+    latest_date_allowed: Annotated[
+        Optional[str], pydantic.Field(alias="latestDateAllowed")
+    ] = "+1week"
+    r"""The latest timestamp value allowed relative to now, such as +42days. Parsed values after this date will be set to the Default time."""
+
+    spacer: Optional[str] = None
+
+    earliest_date_allowed: Annotated[
+        Optional[str], pydantic.Field(alias="earliestDateAllowed")
+    ] = "-420weeks"
+    r"""The earliest timestamp value allowed relative to now, such as -42years. Parsed values prior to this date will be set to the Default time."""
+
+    timestamps: Optional[List[Timestamp]] = None
+    r"""Add regex/strptime pairs to extract additional timestamp formats"""
+
+    @field_serializer("default_time")
+    def serialize_default_time(self, value):
+        if isinstance(value, str):
+            try:
+                return models.DefaultTime(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionAutoTimestampTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionAutoTimestampID
+    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[FunctionAutoTimestampSchemaTypedDict]
+
+
+class FunctionAutoTimestamp(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionAutoTimestampID
+
+    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[FunctionAutoTimestampSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functioncef.py

@@ -0,0 +1,111 @@
+"""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 FunctionCefID(str, Enum):
+    CEF = "cef"
+
+
+class HeaderTypedDict(TypedDict):
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+    name: NotRequired[str]
+
+
+class Header(BaseModel):
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+
+    name: Optional[str] = None
+
+
+class ExtensionTypedDict(TypedDict):
+    name: str
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+
+
+class Extension(BaseModel):
+    name: str
+
+    value: str
+    r"""JavaScript expression to compute the value (can be constant)"""
+
+
+class FunctionCefSchemaTypedDict(TypedDict):
+    output_field: NotRequired[str]
+    r"""The field to which the CEF formatted event will be output"""
+    header: NotRequired[List[HeaderTypedDict]]
+    r"""Set of header key/value pairs"""
+    extension: NotRequired[List[ExtensionTypedDict]]
+    r"""Set of extension key-value pairs"""
+
+
+class FunctionCefSchema(BaseModel):
+    output_field: Annotated[Optional[str], pydantic.Field(alias="outputField")] = "_raw"
+    r"""The field to which the CEF formatted event will be output"""
+
+    header: Optional[List[Header]] = None
+    r"""Set of header key/value pairs"""
+
+    extension: Optional[List[Extension]] = None
+    r"""Set of extension key-value pairs"""
+
+
+class FunctionCefTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionCefID
+    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[FunctionCefSchemaTypedDict]
+
+
+class FunctionCef(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionCefID
+
+    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[FunctionCefSchema], pydantic.Field(alias="schema")] = (
+        None
+    )

cribl_control_plane/models/functionchain.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 FunctionChainID(str, Enum):
+    CHAIN = "chain"
+
+
+class FunctionChainSchemaTypedDict(TypedDict):
+    processor: str
+    r"""The data processor (Pack/Pipeline) to send events through"""
+
+
+class FunctionChainSchema(BaseModel):
+    processor: str
+    r"""The data processor (Pack/Pipeline) to send events through"""
+
+
+class FunctionChainTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionChainID
+    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[FunctionChainSchemaTypedDict]
+
+
+class FunctionChain(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionChainID
+
+    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[FunctionChainSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionclone.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, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionCloneID(str, Enum):
+    CLONE = "clone"
+
+
+class FunctionCloneSchemaTypedDict(TypedDict):
+    clones: NotRequired[List[Dict[str, str]]]
+    r"""Create clones with the following fields set"""
+
+
+class FunctionCloneSchema(BaseModel):
+    clones: Optional[List[Dict[str, str]]] = None
+    r"""Create clones with the following fields set"""
+
+
+class FunctionCloneTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionCloneID
+    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[FunctionCloneSchemaTypedDict]
+
+
+class FunctionClone(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionCloneID
+
+    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[FunctionCloneSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functioncode.py

@@ -0,0 +1,96 @@
+"""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 FunctionCodeID(str, Enum):
+    CODE = "code"
+
+
+class FunctionCodeSchemaTypedDict(TypedDict):
+    code: NotRequired[str]
+    r"""Caution: This Function will be evaluated in an unprotected context. This means that you will be able to execute almost any JavaScript code."""
+    max_num_of_iterations: NotRequired[float]
+    r"""The maximum number of allowed iterations within this Function. Defaults to 5,000."""
+    active_log_sample_rate: NotRequired[float]
+    r"""Rate at which this Function logs errors. For example, a value of 1 (the default) logs every error, a value of 10 logs every tenth error, and so on."""
+    use_unique_log_channel: NotRequired[bool]
+    r"""Logs from this Function will be sent to a unique channel in the form `func:code:${pipelineName}:${functionIndex}`. Disable to use the generic `func:code` log channel instead."""
+
+
+class FunctionCodeSchema(BaseModel):
+    code: Optional[str] = None
+    r"""Caution: This Function will be evaluated in an unprotected context. This means that you will be able to execute almost any JavaScript code."""
+
+    max_num_of_iterations: Annotated[
+        Optional[float], pydantic.Field(alias="maxNumOfIterations")
+    ] = 5000
+    r"""The maximum number of allowed iterations within this Function. Defaults to 5,000."""
+
+    active_log_sample_rate: Annotated[
+        Optional[float], pydantic.Field(alias="activeLogSampleRate")
+    ] = 1
+    r"""Rate at which this Function logs errors. For example, a value of 1 (the default) logs every error, a value of 10 logs every tenth error, and so on."""
+
+    use_unique_log_channel: Annotated[
+        Optional[bool], pydantic.Field(alias="useUniqueLogChannel")
+    ] = True
+    r"""Logs from this Function will be sent to a unique channel in the form `func:code:${pipelineName}:${functionIndex}`. Disable to use the generic `func:code` log channel instead."""
+
+
+class FunctionCodeTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionCodeID
+    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[FunctionCodeSchemaTypedDict]
+
+
+class FunctionCode(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionCodeID
+
+    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[FunctionCodeSchema], pydantic.Field(alias="schema")] = (
+        None
+    )

cribl_control_plane/models/functioncomment.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 FunctionCommentID(str, Enum):
+    COMMENT = "comment"
+
+
+class FunctionCommentSchemaTypedDict(TypedDict):
+    comment: NotRequired[str]
+    r"""Optional, short description of this Function's purpose in the Pipeline"""
+
+
+class FunctionCommentSchema(BaseModel):
+    comment: Optional[str] = None
+    r"""Optional, short description of this Function's purpose in the Pipeline"""
+
+
+class FunctionCommentTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionCommentID
+    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[FunctionCommentSchemaTypedDict]
+
+
+class FunctionComment(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionCommentID
+
+    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[FunctionCommentSchema], pydantic.Field(alias="schema")
+    ] = None