cribl-control-plane 0.0.14__py3-none-any.whl → 0.0.16__py3-none-any.whl

cribl_control_plane/models/inputwef.py

@@ -317,11 +317,11 @@ class InputWefMetadatum(BaseModel):
 
 
 class InputWefTypedDict(TypedDict):
-    type: InputWefType
     subscriptions: List[SubscriptionTypedDict]
     r"""Subscriptions to events on forwarding endpoints"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
+    type: NotRequired[InputWefType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -377,14 +377,16 @@ class InputWefTypedDict(TypedDict):
 
 
 class InputWef(BaseModel):
-    type: Annotated[InputWefType, PlainValidator(validate_open_enum(False))]
-
     subscriptions: List[Subscription]
     r"""Subscriptions to events on forwarding endpoints"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
+    type: Annotated[
+        Optional[InputWefType], PlainValidator(validate_open_enum(False))
+    ] = None
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/inputwiz.py

@@ -190,7 +190,6 @@ class InputWizAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
 
 
 class InputWizTypedDict(TypedDict):
-    type: InputWizType
     auth_url: str
     r"""The authentication URL to generate an OAuth token"""
     client_id: str
@@ -198,6 +197,7 @@ class InputWizTypedDict(TypedDict):
     content_config: List[InputWizContentConfigTypedDict]
     id: NotRequired[str]
     r"""Unique ID for this input"""
+    type: NotRequired[InputWizType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -239,8 +239,6 @@ class InputWizTypedDict(TypedDict):
 
 
 class InputWiz(BaseModel):
-    type: Annotated[InputWizType, PlainValidator(validate_open_enum(False))]
-
     auth_url: Annotated[str, pydantic.Field(alias="authUrl")]
     r"""The authentication URL to generate an OAuth token"""
 
@@ -254,6 +252,10 @@ class InputWiz(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
+    type: Annotated[
+        Optional[InputWizType], PlainValidator(validate_open_enum(False))
+    ] = None
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/inputzscalerhec.py

@@ -246,11 +246,11 @@ class InputZscalerHecMetadatum(BaseModel):
 
 
 class InputZscalerHecTypedDict(TypedDict):
-    type: InputZscalerHecType
     port: float
     r"""Port to listen on"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
+    type: NotRequired[InputZscalerHecType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -309,14 +309,16 @@ class InputZscalerHecTypedDict(TypedDict):
 
 
 class InputZscalerHec(BaseModel):
-    type: Annotated[InputZscalerHecType, PlainValidator(validate_open_enum(False))]
-
     port: float
     r"""Port to listen on"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
+    type: Annotated[
+        Optional[InputZscalerHecType], PlainValidator(validate_open_enum(False))
+    ] = None
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/listoutputop.py

@@ -8,7 +8,7 @@ from typing_extensions import NotRequired, TypedDict
 
 
 class ListOutputResponseTypedDict(TypedDict):
-    r"""a list of Output objects"""
+    r"""a list of Destination objects"""
 
     count: NotRequired[int]
     r"""number of items present in the items array"""
@@ -16,7 +16,7 @@ class ListOutputResponseTypedDict(TypedDict):
 
 
 class ListOutputResponse(BaseModel):
-    r"""a list of Output objects"""
+    r"""a list of Destination objects"""
 
     count: Optional[int] = None
     r"""number of items present in the items array"""

cribl_control_plane/models/listpipelineop.py

@@ -0,0 +1,24 @@
+"""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 typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ListPipelineResponseTypedDict(TypedDict):
+    r"""a list of Pipeline objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[PipelineTypedDict]]
+
+
+class ListPipelineResponse(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/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/routes.py

@@ -10,7 +10,7 @@ from typing import Any, Dict, List, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-class GroupsTypedDict(TypedDict):
+class RoutesGroupsTypedDict(TypedDict):
     name: str
     description: NotRequired[str]
     r"""Short description of this group"""
@@ -18,7 +18,7 @@ class GroupsTypedDict(TypedDict):
     r"""Whether this group is disabled"""
 
 
-class Groups(BaseModel):
+class RoutesGroups(BaseModel):
     name: str
 
     description: Optional[str] = None
@@ -56,7 +56,7 @@ class RoutesTypedDict(TypedDict):
     r"""Pipeline routing rules"""
     id: NotRequired[str]
     r"""Routes ID"""
-    groups: NotRequired[Dict[str, GroupsTypedDict]]
+    groups: NotRequired[Dict[str, RoutesGroupsTypedDict]]
     comments: NotRequired[List[CommentTypedDict]]
     r"""Comments"""
 
@@ -68,7 +68,7 @@ class Routes(BaseModel):
     id: Optional[str] = None
     r"""Routes ID"""
 
-    groups: Optional[Dict[str, Groups]] = None
+    groups: Optional[Dict[str, RoutesGroups]] = None
 
     comments: Optional[List[Comment]] = None
     r"""Comments"""
@@ -79,7 +79,7 @@ class RoutesInputTypedDict(TypedDict):
     r"""Pipeline routing rules"""
     id: NotRequired[str]
     r"""Routes ID"""
-    groups: NotRequired[Dict[str, GroupsTypedDict]]
+    groups: NotRequired[Dict[str, RoutesGroupsTypedDict]]
     comments: NotRequired[List[CommentTypedDict]]
     r"""Comments"""
 
@@ -91,7 +91,7 @@ class RoutesInput(BaseModel):
     id: Optional[str] = None
     r"""Routes ID"""
 
-    groups: Optional[Dict[str, Groups]] = None
+    groups: Optional[Dict[str, RoutesGroups]] = None
 
     comments: Optional[List[Comment]] = None
     r"""Comments"""

cribl_control_plane/models/updateoutputbyidop.py

@@ -12,7 +12,7 @@ class UpdateOutputByIDRequestTypedDict(TypedDict):
     id: str
     r"""Unique ID to PATCH"""
     output: OutputTypedDict
-    r"""Output object to be updated"""
+    r"""Destination object to be updated"""
 
 
 class UpdateOutputByIDRequest(BaseModel):
@@ -24,11 +24,11 @@ class UpdateOutputByIDRequest(BaseModel):
     output: Annotated[
         Output, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
-    r"""Output object to be updated"""
+    r"""Destination object to be updated"""
 
 
 class UpdateOutputByIDResponseTypedDict(TypedDict):
-    r"""a list of Output objects"""
+    r"""a list of Destination objects"""
 
     count: NotRequired[int]
     r"""number of items present in the items array"""
@@ -36,7 +36,7 @@ class UpdateOutputByIDResponseTypedDict(TypedDict):
 
 
 class UpdateOutputByIDResponse(BaseModel):
-    r"""a list of Output objects"""
+    r"""a list of Destination objects"""
 
     count: Optional[int] = None
     r"""number of items present in the items array"""

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