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

cribl_control_plane/models/functionredis.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 FunctionRedisID(str, Enum):
+    REDIS = "redis"
+
+
+class CommandTypedDict(TypedDict):
+    command: str
+    r"""Redis command to perform. For a complete list visit: https://redis.io/commands"""
+    key_expr: str
+    r"""A JavaScript expression to compute the value of the key to operate on. Can also be a constant such as 'username'."""
+    out_field: NotRequired[str]
+    r"""Name of the field in which to store the returned value. Leave blank to discard returned value."""
+    args_expr: NotRequired[str]
+    r"""A JavaScript expression to compute arguments to the operation. Can return an array."""
+
+
+class Command(BaseModel):
+    command: str
+    r"""Redis command to perform. For a complete list visit: https://redis.io/commands"""
+
+    key_expr: Annotated[str, pydantic.Field(alias="keyExpr")]
+    r"""A JavaScript expression to compute the value of the key to operate on. Can also be a constant such as 'username'."""
+
+    out_field: Annotated[Optional[str], pydantic.Field(alias="outField")] = None
+    r"""Name of the field in which to store the returned value. Leave blank to discard returned value."""
+
+    args_expr: Annotated[Optional[str], pydantic.Field(alias="argsExpr")] = None
+    r"""A JavaScript expression to compute arguments to the operation. Can return an array."""
+
+
+class DeploymentType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How the Redis server is configured. Defaults to Standalone"""
+
+    # Standalone
+    STANDALONE = "standalone"
+    # Cluster
+    CLUSTER = "cluster"
+    # Sentinel
+    SENTINEL = "sentinel"
+
+
+class FunctionRedisAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
+    # None
+    NONE = "none"
+    # Manual
+    MANUAL = "manual"
+    # User Secret
+    CREDENTIALS_SECRET = "credentialsSecret"
+    # Admin Secret
+    TEXT_SECRET = "textSecret"
+
+
+class FunctionRedisSchemaTypedDict(TypedDict):
+    commands: List[CommandTypedDict]
+    deployment_type: NotRequired[DeploymentType]
+    r"""How the Redis server is configured. Defaults to Standalone"""
+    auth_type: NotRequired[FunctionRedisAuthenticationMethod]
+    max_block_secs: NotRequired[float]
+    r"""Maximum amount of time (seconds) to wait before assuming that Redis is down and passing events through. Use 0 to disable."""
+    enable_client_side_caching: NotRequired[bool]
+    r"""Enable client-side cache. Redundant when using Redis write operations. See more options at Settings > General > Limits > Redis Cache."""
+
+
+class FunctionRedisSchema(BaseModel):
+    commands: List[Command]
+
+    deployment_type: Annotated[
+        Annotated[Optional[DeploymentType], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="deploymentType"),
+    ] = DeploymentType.STANDALONE
+    r"""How the Redis server is configured. Defaults to Standalone"""
+
+    auth_type: Annotated[
+        Annotated[
+            Optional[FunctionRedisAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = FunctionRedisAuthenticationMethod.NONE
+
+    max_block_secs: Annotated[Optional[float], pydantic.Field(alias="maxBlockSecs")] = (
+        60
+    )
+    r"""Maximum amount of time (seconds) to wait before assuming that Redis is down and passing events through. Use 0 to disable."""
+
+    enable_client_side_caching: Annotated[
+        Optional[bool], pydantic.Field(alias="enableClientSideCaching")
+    ] = None
+    r"""Enable client-side cache. Redundant when using Redis write operations. See more options at Settings > General > Limits > Redis Cache."""
+
+    @field_serializer("deployment_type")
+    def serialize_deployment_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.DeploymentType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionRedisAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionRedisTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionRedisID
+    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[FunctionRedisSchemaTypedDict]
+
+
+class FunctionRedis(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionRedisID
+
+    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[FunctionRedisSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionregexextract.py

@@ -0,0 +1,112 @@
+"""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 FunctionRegexExtractID(str, Enum):
+    REGEX_EXTRACT = "regex_extract"
+
+
+class FunctionRegexExtractRegexListTypedDict(TypedDict):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+
+
+class FunctionRegexExtractRegexList(BaseModel):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+
+
+class FunctionRegexExtractSchemaTypedDict(TypedDict):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+    regex_list: NotRequired[List[FunctionRegexExtractRegexListTypedDict]]
+    source: NotRequired[str]
+    r"""Field on which to perform regex field extraction"""
+    iterations: NotRequired[float]
+    r"""The maximum number of times to apply regex to source field when the global flag is set, or when using _NAME_ and _VALUE_ capturing groups"""
+    field_name_expression: NotRequired[str]
+    r"""JavaScript expression to format field names when _NAME_n and _VALUE_n capturing groups are used. Original field name is in global variable 'name'. Example: To append XX to all field names, use `${name}_XX` (backticks are literal). If empty, names will be sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can access other fields values via __e.<fieldName>."""
+    overwrite: NotRequired[bool]
+    r"""Overwrite existing event fields with extracted values. If disabled, existing fields will be converted to an array."""
+
+
+class FunctionRegexExtractSchema(BaseModel):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+
+    regex_list: Annotated[
+        Optional[List[FunctionRegexExtractRegexList]], pydantic.Field(alias="regexList")
+    ] = None
+
+    source: Optional[str] = "_raw"
+    r"""Field on which to perform regex field extraction"""
+
+    iterations: Optional[float] = 100
+    r"""The maximum number of times to apply regex to source field when the global flag is set, or when using _NAME_ and _VALUE_ capturing groups"""
+
+    field_name_expression: Annotated[
+        Optional[str], pydantic.Field(alias="fieldNameExpression")
+    ] = None
+    r"""JavaScript expression to format field names when _NAME_n and _VALUE_n capturing groups are used. Original field name is in global variable 'name'. Example: To append XX to all field names, use `${name}_XX` (backticks are literal). If empty, names will be sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can access other fields values via __e.<fieldName>."""
+
+    overwrite: Optional[bool] = False
+    r"""Overwrite existing event fields with extracted values. If disabled, existing fields will be converted to an array."""
+
+
+class FunctionRegexExtractTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionRegexExtractID
+    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[FunctionRegexExtractSchemaTypedDict]
+
+
+class FunctionRegexExtract(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionRegexExtractID
+
+    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[FunctionRegexExtractSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionregexfilter.py

@@ -0,0 +1,95 @@
+"""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 FunctionRegexFilterID(str, Enum):
+    REGEX_FILTER = "regex_filter"
+
+
+class FunctionRegexFilterRegexListTypedDict(TypedDict):
+    regex: str
+    r"""Regex to test against"""
+
+
+class FunctionRegexFilterRegexList(BaseModel):
+    regex: str
+    r"""Regex to test against"""
+
+
+class FunctionRegexFilterSchemaTypedDict(TypedDict):
+    regex: NotRequired[str]
+    r"""Regex to test against"""
+    regex_list: NotRequired[List[FunctionRegexFilterRegexListTypedDict]]
+    field: NotRequired[str]
+    r"""Name of the field to apply the regex on (defaults to _raw)"""
+
+
+class FunctionRegexFilterSchema(BaseModel):
+    regex: Optional[str] = None
+    r"""Regex to test against"""
+
+    regex_list: Annotated[
+        Optional[List[FunctionRegexFilterRegexList]], pydantic.Field(alias="regexList")
+    ] = None
+
+    field: Optional[str] = "_raw"
+    r"""Name of the field to apply the regex on (defaults to _raw)"""
+
+
+class FunctionRegexFilterTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionRegexFilterID
+    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[FunctionRegexFilterSchemaTypedDict]
+
+
+class FunctionRegexFilter(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionRegexFilterID
+
+    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[FunctionRegexFilterSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionrename.py

@@ -0,0 +1,107 @@
+"""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 FunctionRenameID(str, Enum):
+    RENAME = "rename"
+
+
+class RenameTypedDict(TypedDict):
+    current_name: str
+    r"""Name of the field to rename. Literal identifiers must be quoted."""
+    new_name: str
+    r"""The name the field will be renamed to. Literal identifiers must be quoted."""
+
+
+class Rename(BaseModel):
+    current_name: Annotated[str, pydantic.Field(alias="currentName")]
+    r"""Name of the field to rename. Literal identifiers must be quoted."""
+
+    new_name: Annotated[str, pydantic.Field(alias="newName")]
+    r"""The name the field will be renamed to. Literal identifiers must be quoted."""
+
+
+class FunctionRenameSchemaTypedDict(TypedDict):
+    base_fields: NotRequired[List[str]]
+    r"""Fields whose children will inherit the Rename fields and Rename expression operations. Supports wildcards. If empty, only top-level fields will be renamed."""
+    rename: NotRequired[List[RenameTypedDict]]
+    r"""Set of key-value pairs to rename fields, where key is the current name and value is the new name. Does not support internal fields."""
+    rename_expr: NotRequired[str]
+    r"""Optional JavaScript expression whose returned value will be used to rename fields. Use the 'name' and 'value' global variables to access field names/values. Example: `name.startsWith('data') ? name.toUpperCase() : name`. You can access other field values via __e.<fieldName>."""
+    wildcard_depth: NotRequired[int]
+    r"""For wildcards specified in Parent fields, sets the maximum depth within events to match and rename fields. Enter `0` to match only top-level fields. Defaults to `5` levels down."""
+
+
+class FunctionRenameSchema(BaseModel):
+    base_fields: Annotated[Optional[List[str]], pydantic.Field(alias="baseFields")] = (
+        None
+    )
+    r"""Fields whose children will inherit the Rename fields and Rename expression operations. Supports wildcards. If empty, only top-level fields will be renamed."""
+
+    rename: Optional[List[Rename]] = None
+    r"""Set of key-value pairs to rename fields, where key is the current name and value is the new name. Does not support internal fields."""
+
+    rename_expr: Annotated[Optional[str], pydantic.Field(alias="renameExpr")] = None
+    r"""Optional JavaScript expression whose returned value will be used to rename fields. Use the 'name' and 'value' global variables to access field names/values. Example: `name.startsWith('data') ? name.toUpperCase() : name`. You can access other field values via __e.<fieldName>."""
+
+    wildcard_depth: Annotated[Optional[int], pydantic.Field(alias="wildcardDepth")] = 5
+    r"""For wildcards specified in Parent fields, sets the maximum depth within events to match and rename fields. Enter `0` to match only top-level fields. Defaults to `5` levels down."""
+
+
+class FunctionRenameTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionRenameID
+    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[FunctionRenameSchemaTypedDict]
+
+
+class FunctionRename(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionRenameID
+
+    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[FunctionRenameSchema], pydantic.Field(alias="schema")
+    ] = None