cribl-control-plane 0.0.13__py3-none-any.whl → 0.0.15__py3-none-any.whl

cribl_control_plane/models/pipeline.py

@@ -0,0 +1,70 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .pipelinefunctionconf import PipelineFunctionConf, PipelineFunctionConfTypedDict
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineGroupsTypedDict(TypedDict):
+    name: str
+    description: NotRequired[str]
+    r"""Short description of this group"""
+    disabled: NotRequired[bool]
+    r"""Whether this group is disabled"""
+
+
+class PipelineGroups(BaseModel):
+    name: str
+
+    description: Optional[str] = None
+    r"""Short description of this group"""
+
+    disabled: Optional[bool] = None
+    r"""Whether this group is disabled"""
+
+
+class ConfTypedDict(TypedDict):
+    async_func_timeout: NotRequired[int]
+    r"""Time (in ms) to wait for an async function to complete processing of a data item"""
+    output: NotRequired[str]
+    r"""The output destination for events processed by this Pipeline"""
+    description: NotRequired[str]
+    streamtags: NotRequired[List[str]]
+    r"""Tags for filtering and grouping in @{product}"""
+    functions: NotRequired[List[PipelineFunctionConfTypedDict]]
+    r"""List of Functions to pass data through"""
+    groups: NotRequired[Dict[str, PipelineGroupsTypedDict]]
+
+
+class Conf(BaseModel):
+    async_func_timeout: Annotated[
+        Optional[int], pydantic.Field(alias="asyncFuncTimeout")
+    ] = None
+    r"""Time (in ms) to wait for an async function to complete processing of a data item"""
+
+    output: Optional[str] = "default"
+    r"""The output destination for events processed by this Pipeline"""
+
+    description: Optional[str] = None
+
+    streamtags: Optional[List[str]] = None
+    r"""Tags for filtering and grouping in @{product}"""
+
+    functions: Optional[List[PipelineFunctionConf]] = None
+    r"""List of Functions to pass data through"""
+
+    groups: Optional[Dict[str, PipelineGroups]] = None
+
+
+class PipelineTypedDict(TypedDict):
+    id: str
+    conf: ConfTypedDict
+
+
+class Pipeline(BaseModel):
+    id: str
+
+    conf: Conf

cribl_control_plane/models/pipelinefunctionconf.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionSpecificConfigsTypedDict(TypedDict):
+    pass
+
+
+class FunctionSpecificConfigs(BaseModel):
+    pass
+
+
+class PipelineFunctionConfTypedDict(TypedDict):
+    id: str
+    r"""Function ID"""
+    conf: FunctionSpecificConfigsTypedDict
+    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 PipelineFunctionConf(BaseModel):
+    id: str
+    r"""Function ID"""
+
+    conf: FunctionSpecificConfigs
+
+    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/routecloneconf.py

@@ -0,0 +1,13 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class RouteCloneConfTypedDict(TypedDict):
+    pass
+
+
+class RouteCloneConf(BaseModel):
+    pass

cribl_control_plane/models/routeconf.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .routecloneconf import RouteCloneConf, RouteCloneConfTypedDict
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class RouteConfTypedDict(TypedDict):
+    final: bool
+    id: str
+    name: str
+    pipeline: str
+    clones: NotRequired[List[RouteCloneConfTypedDict]]
+    context: NotRequired[str]
+    description: NotRequired[str]
+    disabled: NotRequired[bool]
+    enable_output_expression: NotRequired[bool]
+    filter_: NotRequired[str]
+    group_id: NotRequired[str]
+    output: NotRequired[str]
+    output_expression: NotRequired[str]
+
+
+class RouteConf(BaseModel):
+    final: bool
+
+    id: str
+
+    name: str
+
+    pipeline: str
+
+    clones: Optional[List[RouteCloneConf]] = None
+
+    context: Optional[str] = None
+
+    description: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    enable_output_expression: Annotated[
+        Optional[bool], pydantic.Field(alias="enableOutputExpression")
+    ] = None
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = None
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+
+    output: Optional[str] = None
+
+    output_expression: Annotated[
+        Optional[str], pydantic.Field(alias="outputExpression")
+    ] = None

cribl_control_plane/models/routes.py

@@ -0,0 +1,97 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .routesroute import RoutesRoute, RoutesRouteTypedDict
+from .routesroute_input import RoutesRouteInput, RoutesRouteInputTypedDict
+from cribl_control_plane.types import BaseModel
+import pydantic
+from pydantic import ConfigDict
+from typing import Any, Dict, List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class RoutesGroupsTypedDict(TypedDict):
+    name: str
+    description: NotRequired[str]
+    r"""Short description of this group"""
+    disabled: NotRequired[bool]
+    r"""Whether this group is disabled"""
+
+
+class RoutesGroups(BaseModel):
+    name: str
+
+    description: Optional[str] = None
+    r"""Short description of this group"""
+
+    disabled: Optional[bool] = None
+    r"""Whether this group is disabled"""
+
+
+class CommentTypedDict(TypedDict):
+    comment: NotRequired[str]
+    r"""Optional, short description of this Route's purpose"""
+
+
+class Comment(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True, arbitrary_types_allowed=True, extra="allow"
+    )
+    __pydantic_extra__: Dict[str, Any] = pydantic.Field(init=False)
+
+    comment: Optional[str] = None
+    r"""Optional, short description of this Route's purpose"""
+
+    @property
+    def additional_properties(self):
+        return self.__pydantic_extra__
+
+    @additional_properties.setter
+    def additional_properties(self, value):
+        self.__pydantic_extra__ = value  # pyright: ignore[reportIncompatibleVariableOverride]
+
+
+class RoutesTypedDict(TypedDict):
+    routes: List[RoutesRouteTypedDict]
+    r"""Pipeline routing rules"""
+    id: NotRequired[str]
+    r"""Routes ID"""
+    groups: NotRequired[Dict[str, RoutesGroupsTypedDict]]
+    comments: NotRequired[List[CommentTypedDict]]
+    r"""Comments"""
+
+
+class Routes(BaseModel):
+    routes: List[RoutesRoute]
+    r"""Pipeline routing rules"""
+
+    id: Optional[str] = None
+    r"""Routes ID"""
+
+    groups: Optional[Dict[str, RoutesGroups]] = None
+
+    comments: Optional[List[Comment]] = None
+    r"""Comments"""
+
+
+class RoutesInputTypedDict(TypedDict):
+    routes: List[RoutesRouteInputTypedDict]
+    r"""Pipeline routing rules"""
+    id: NotRequired[str]
+    r"""Routes ID"""
+    groups: NotRequired[Dict[str, RoutesGroupsTypedDict]]
+    comments: NotRequired[List[CommentTypedDict]]
+    r"""Comments"""
+
+
+class RoutesInput(BaseModel):
+    routes: List[RoutesRouteInput]
+    r"""Pipeline routing rules"""
+
+    id: Optional[str] = None
+    r"""Routes ID"""
+
+    groups: Optional[Dict[str, RoutesGroups]] = None
+
+    comments: Optional[List[Comment]] = None
+    r"""Comments"""

cribl_control_plane/models/routesroute.py

@@ -0,0 +1,70 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from pydantic import ConfigDict
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class RoutesRouteTypedDict(TypedDict):
+    name: str
+    pipeline: str
+    r"""Pipeline to send the matching data to"""
+    id: NotRequired[str]
+    disabled: NotRequired[bool]
+    r"""Disable this routing rule"""
+    filter_: NotRequired[str]
+    r"""JavaScript expression to select data to route"""
+    enable_output_expression: NotRequired[bool]
+    r"""Enable to use a JavaScript expression that evaluates to the name of the Description below"""
+    output: NotRequired[Any]
+    output_expression: NotRequired[Any]
+    description: NotRequired[str]
+    final: NotRequired[bool]
+    r"""Flag to control whether the event gets consumed by this Route (Final), or cloned into it"""
+
+
+class RoutesRoute(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True, arbitrary_types_allowed=True, extra="allow"
+    )
+    __pydantic_extra__: Dict[str, Any] = pydantic.Field(init=False)
+
+    name: str
+
+    pipeline: str
+    r"""Pipeline to send the matching data to"""
+
+    id: Optional[str] = None
+
+    disabled: Optional[bool] = None
+    r"""Disable this routing rule"""
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""JavaScript expression to select data to route"""
+
+    enable_output_expression: Annotated[
+        Optional[bool], pydantic.Field(alias="enableOutputExpression")
+    ] = False
+    r"""Enable to use a JavaScript expression that evaluates to the name of the Description below"""
+
+    output: Optional[Any] = None
+
+    output_expression: Annotated[
+        Optional[Any], pydantic.Field(alias="outputExpression")
+    ] = None
+
+    description: Optional[str] = None
+
+    final: Optional[bool] = True
+    r"""Flag to control whether the event gets consumed by this Route (Final), or cloned into it"""
+
+    @property
+    def additional_properties(self):
+        return self.__pydantic_extra__
+
+    @additional_properties.setter
+    def additional_properties(self, value):
+        self.__pydantic_extra__ = value  # pyright: ignore[reportIncompatibleVariableOverride]

cribl_control_plane/models/routesroute_input.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
+import pydantic
+from pydantic import ConfigDict
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class RoutesRouteInputTypedDict(TypedDict):
+    name: str
+    pipeline: str
+    r"""Pipeline to send the matching data to"""
+    disabled: NotRequired[bool]
+    r"""Disable this routing rule"""
+    filter_: NotRequired[str]
+    r"""JavaScript expression to select data to route"""
+    enable_output_expression: NotRequired[bool]
+    r"""Enable to use a JavaScript expression that evaluates to the name of the Description below"""
+    output: NotRequired[Any]
+    output_expression: NotRequired[Any]
+    description: NotRequired[str]
+    final: NotRequired[bool]
+    r"""Flag to control whether the event gets consumed by this Route (Final), or cloned into it"""
+
+
+class RoutesRouteInput(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True, arbitrary_types_allowed=True, extra="allow"
+    )
+    __pydantic_extra__: Dict[str, Any] = pydantic.Field(init=False)
+
+    name: str
+
+    pipeline: str
+    r"""Pipeline to send the matching data to"""
+
+    disabled: Optional[bool] = None
+    r"""Disable this routing rule"""
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""JavaScript expression to select data to route"""
+
+    enable_output_expression: Annotated[
+        Optional[bool], pydantic.Field(alias="enableOutputExpression")
+    ] = False
+    r"""Enable to use a JavaScript expression that evaluates to the name of the Description below"""
+
+    output: Optional[Any] = None
+
+    output_expression: Annotated[
+        Optional[Any], pydantic.Field(alias="outputExpression")
+    ] = None
+
+    description: Optional[str] = None
+
+    final: Optional[bool] = True
+    r"""Flag to control whether the event gets consumed by this Route (Final), or cloned into it"""
+
+    @property
+    def additional_properties(self):
+        return self.__pydantic_extra__
+
+    @additional_properties.setter
+    def additional_properties(self, value):
+        self.__pydantic_extra__ = value  # pyright: ignore[reportIncompatibleVariableOverride]

cribl_control_plane/models/updatepipelinebyidop.py

@@ -0,0 +1,47 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .pipeline import Pipeline, PipelineTypedDict
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpdatePipelineByIDRequestTypedDict(TypedDict):
+    id_param: str
+    r"""Unique ID to PATCH"""
+    pipeline: PipelineTypedDict
+    r"""Pipeline object to be updated"""
+
+
+class UpdatePipelineByIDRequest(BaseModel):
+    id_param: Annotated[
+        str,
+        pydantic.Field(alias="id"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Unique ID to PATCH"""
+
+    pipeline: Annotated[
+        Pipeline, FieldMetadata(request=RequestMetadata(media_type="application/json"))
+    ]
+    r"""Pipeline object to be updated"""
+
+
+class UpdatePipelineByIDResponseTypedDict(TypedDict):
+    r"""a list of Pipeline objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[PipelineTypedDict]]
+
+
+class UpdatePipelineByIDResponse(BaseModel):
+    r"""a list of Pipeline objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[Pipeline]] = None

cribl_control_plane/models/updateroutesbyidop.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .routes import Routes, RoutesInput, RoutesInputTypedDict, RoutesTypedDict
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpdateRoutesByIDRequestTypedDict(TypedDict):
+    id_param: str
+    r"""Unique ID to PATCH"""
+    routes: RoutesInputTypedDict
+    r"""Routes object to be updated"""
+
+
+class UpdateRoutesByIDRequest(BaseModel):
+    id_param: Annotated[
+        str,
+        pydantic.Field(alias="id"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Unique ID to PATCH"""
+
+    routes: Annotated[
+        RoutesInput,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+    r"""Routes object to be updated"""
+
+
+class UpdateRoutesByIDResponseTypedDict(TypedDict):
+    r"""a list of Routes objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[RoutesTypedDict]]
+
+
+class UpdateRoutesByIDResponse(BaseModel):
+    r"""a list of Routes objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[Routes]] = None