cribl-control-plane 0.0.39__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/pipelinefunctionnotify.py

@@ -0,0 +1,189 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionNotifyID(str, Enum):
+    r"""Function ID"""
+
+    NOTIFY = "notify"
+
+
+class PipelineFunctionNotifyTriggerType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count"""
+
+    # Where
+    CUSTOM = "custom"
+    # Count of Results
+    RESULTS_COUNT = "resultsCount"
+
+
+class PipelineFunctionNotifyCountComparator(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Operation to be applied over the results count"""
+
+    # greater than
+    GREATER_THAN_ = ">"
+    # less than
+    LESS_THAN_ = "<"
+    # equals
+    EQUAL_EQUAL_EQUAL_ = "==="
+    # not equal to
+    NOT_EQUAL_EQUAL_ = "!=="
+    # greater than or equal to
+    GREATER_THAN_EQUAL_ = ">="
+    # less than or equal to
+    LESS_THAN_EQUAL_ = "<="
+
+
+class NotifyConfigurationTypedDict(TypedDict):
+    search_id: str
+    r"""Id of the search this function is running on."""
+    saved_query_id: str
+    r"""Id of the saved query"""
+    search_url: str
+    r"""Url of the search results"""
+    auth_token: str
+    r"""Auth token for sending notification messages"""
+    messages_endpoint: str
+    r"""System messages api endpoint"""
+    group: NotRequired[str]
+    r"""Group the notification belongs to"""
+    notification_id: NotRequired[str]
+    r"""Workspace within the deployment to send the search results to."""
+    trigger: NotRequired[str]
+    r"""Js expression that filters events, a greater than 'Trigger Count' events will trigger the notification"""
+    trigger_type: NotRequired[PipelineFunctionNotifyTriggerType]
+    r"""Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count"""
+    trigger_comparator: NotRequired[PipelineFunctionNotifyCountComparator]
+    r"""Operation to be applied over the results count"""
+    trigger_count: NotRequired[float]
+    r"""How many results that match trigger the condition"""
+    results_limit: NotRequired[float]
+    r"""Number of results to include in the notification event"""
+    message: NotRequired[str]
+    r"""Message content template, available fields: searchId, resultSet, savedQueryId, notificationId, searchResultsUrl"""
+    tenant_id: NotRequired[str]
+    r"""Current tenant id"""
+
+
+class NotifyConfiguration(BaseModel):
+    search_id: Annotated[str, pydantic.Field(alias="searchId")]
+    r"""Id of the search this function is running on."""
+
+    saved_query_id: Annotated[str, pydantic.Field(alias="savedQueryId")]
+    r"""Id of the saved query"""
+
+    search_url: Annotated[str, pydantic.Field(alias="searchUrl")]
+    r"""Url of the search results"""
+
+    auth_token: Annotated[str, pydantic.Field(alias="authToken")]
+    r"""Auth token for sending notification messages"""
+
+    messages_endpoint: Annotated[str, pydantic.Field(alias="messagesEndpoint")]
+    r"""System messages api endpoint"""
+
+    group: Optional[str] = "default"
+    r"""Group the notification belongs to"""
+
+    notification_id: Annotated[
+        Optional[str], pydantic.Field(alias="notificationId")
+    ] = "main"
+    r"""Workspace within the deployment to send the search results to."""
+
+    trigger: Optional[str] = None
+    r"""Js expression that filters events, a greater than 'Trigger Count' events will trigger the notification"""
+
+    trigger_type: Annotated[
+        Annotated[
+            Optional[PipelineFunctionNotifyTriggerType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="triggerType"),
+    ] = None
+    r"""Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count"""
+
+    trigger_comparator: Annotated[
+        Annotated[
+            Optional[PipelineFunctionNotifyCountComparator],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="triggerComparator"),
+    ] = None
+    r"""Operation to be applied over the results count"""
+
+    trigger_count: Annotated[Optional[float], pydantic.Field(alias="triggerCount")] = 0
+    r"""How many results that match trigger the condition"""
+
+    results_limit: Annotated[Optional[float], pydantic.Field(alias="resultsLimit")] = 50
+    r"""Number of results to include in the notification event"""
+
+    message: Optional[str] = None
+    r"""Message content template, available fields: searchId, resultSet, savedQueryId, notificationId, searchResultsUrl"""
+
+    tenant_id: Annotated[Optional[str], pydantic.Field(alias="tenantId")] = None
+    r"""Current tenant id"""
+
+    @field_serializer("trigger_type")
+    def serialize_trigger_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionNotifyTriggerType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("trigger_comparator")
+    def serialize_trigger_comparator(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionNotifyCountComparator(value)
+            except ValueError:
+                return value
+        return value
+
+
+class PipelineFunctionNotifyTypedDict(TypedDict):
+    id: PipelineFunctionNotifyID
+    r"""Function ID"""
+    conf: NotifyConfigurationTypedDict
+    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 PipelineFunctionNotify(BaseModel):
+    id: PipelineFunctionNotifyID
+    r"""Function ID"""
+
+    conf: NotifyConfiguration
+
+    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/pipelinefunctionnumerify.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemanumerify import (
+    FunctionConfSchemaNumerify,
+    FunctionConfSchemaNumerifyTypedDict,
+)
+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 PipelineFunctionNumerifyID(str, Enum):
+    r"""Function ID"""
+
+    NUMERIFY = "numerify"
+
+
+class PipelineFunctionNumerifyTypedDict(TypedDict):
+    id: PipelineFunctionNumerifyID
+    r"""Function ID"""
+    conf: FunctionConfSchemaNumerifyTypedDict
+    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 PipelineFunctionNumerify(BaseModel):
+    id: PipelineFunctionNumerifyID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaNumerify
+
+    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/pipelinefunctionotlplogs.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemaotlplogs import (
+    FunctionConfSchemaOtlpLogs,
+    FunctionConfSchemaOtlpLogsTypedDict,
+)
+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 PipelineFunctionOtlpLogsID(str, Enum):
+    r"""Function ID"""
+
+    OTLP_LOGS = "otlp_logs"
+
+
+class PipelineFunctionOtlpLogsTypedDict(TypedDict):
+    id: PipelineFunctionOtlpLogsID
+    r"""Function ID"""
+    conf: FunctionConfSchemaOtlpLogsTypedDict
+    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 PipelineFunctionOtlpLogs(BaseModel):
+    id: PipelineFunctionOtlpLogsID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaOtlpLogs
+
+    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/pipelinefunctionotlpmetrics.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemaotlpmetrics import (
+    FunctionConfSchemaOtlpMetrics,
+    FunctionConfSchemaOtlpMetricsTypedDict,
+)
+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 PipelineFunctionOtlpMetricsID(str, Enum):
+    r"""Function ID"""
+
+    OTLP_METRICS = "otlp_metrics"
+
+
+class PipelineFunctionOtlpMetricsTypedDict(TypedDict):
+    id: PipelineFunctionOtlpMetricsID
+    r"""Function ID"""
+    conf: FunctionConfSchemaOtlpMetricsTypedDict
+    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 PipelineFunctionOtlpMetrics(BaseModel):
+    id: PipelineFunctionOtlpMetricsID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaOtlpMetrics
+
+    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/pipelinefunctionotlptraces.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemaotlptraces import (
+    FunctionConfSchemaOtlpTraces,
+    FunctionConfSchemaOtlpTracesTypedDict,
+)
+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 PipelineFunctionOtlpTracesID(str, Enum):
+    r"""Function ID"""
+
+    OTLP_TRACES = "otlp_traces"
+
+
+class PipelineFunctionOtlpTracesTypedDict(TypedDict):
+    id: PipelineFunctionOtlpTracesID
+    r"""Function ID"""
+    conf: FunctionConfSchemaOtlpTracesTypedDict
+    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 PipelineFunctionOtlpTraces(BaseModel):
+    id: PipelineFunctionOtlpTracesID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaOtlpTraces
+
+    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/pipelinefunctionpack.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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionPackID(str, Enum):
+    r"""Function ID"""
+
+    PACK = "pack"
+
+
+class PipelineFunctionPackConfTypedDict(TypedDict):
+    unpacked_fields: List[str]
+    r"""List of fields to keep, everything else will be packed"""
+    target: NotRequired[str]
+    r"""Name of the (packed) target field"""
+
+
+class PipelineFunctionPackConf(BaseModel):
+    unpacked_fields: Annotated[List[str], pydantic.Field(alias="unpackedFields")]
+    r"""List of fields to keep, everything else will be packed"""
+
+    target: Optional[str] = "_pack"
+    r"""Name of the (packed) target field"""
+
+
+class PipelineFunctionPackTypedDict(TypedDict):
+    id: PipelineFunctionPackID
+    r"""Function ID"""
+    conf: PipelineFunctionPackConfTypedDict
+    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 PipelineFunctionPack(BaseModel):
+    id: PipelineFunctionPackID
+    r"""Function ID"""
+
+    conf: PipelineFunctionPackConf
+
+    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/pipelinefunctionpivot.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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionPivotID(str, Enum):
+    r"""Function ID"""
+
+    PIVOT = "pivot"
+
+
+class SimplePivotConfigurationTypedDict(TypedDict):
+    label_field: str
+    r"""Fields to be used for the left-most column."""
+    data_fields: List[str]
+    r"""Fields with the cell values (i.e. aggregates)"""
+    qualifier_fields: List[str]
+    r"""Fields to qualify or group data fields"""
+
+
+class SimplePivotConfiguration(BaseModel):
+    label_field: Annotated[str, pydantic.Field(alias="labelField")]
+    r"""Fields to be used for the left-most column."""
+
+    data_fields: Annotated[List[str], pydantic.Field(alias="dataFields")]
+    r"""Fields with the cell values (i.e. aggregates)"""
+
+    qualifier_fields: Annotated[List[str], pydantic.Field(alias="qualifierFields")]
+    r"""Fields to qualify or group data fields"""
+
+
+class PipelineFunctionPivotTypedDict(TypedDict):
+    id: PipelineFunctionPivotID
+    r"""Function ID"""
+    conf: SimplePivotConfigurationTypedDict
+    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 PipelineFunctionPivot(BaseModel):
+    id: PipelineFunctionPivotID
+    r"""Function ID"""
+
+    conf: SimplePivotConfiguration
+
+    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/pipelinefunctionpublishmetrics.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemapublishmetrics import (
+    FunctionConfSchemaPublishMetrics,
+    FunctionConfSchemaPublishMetricsTypedDict,
+)
+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 PipelineFunctionPublishMetricsID(str, Enum):
+    r"""Function ID"""
+
+    PUBLISH_METRICS = "publish_metrics"
+
+
+class PipelineFunctionPublishMetricsTypedDict(TypedDict):
+    id: PipelineFunctionPublishMetricsID
+    r"""Function ID"""
+    conf: FunctionConfSchemaPublishMetricsTypedDict
+    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 PipelineFunctionPublishMetrics(BaseModel):
+    id: PipelineFunctionPublishMetricsID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaPublishMetrics
+
+    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"""