cribl-control-plane 0.2.1rc11__py3-none-any.whl → 0.4.0a6__py3-none-any.whl

cribl_control_plane/models/outputsecuritylake.py

@@ -202,6 +202,8 @@ class OutputSecurityLakeTypedDict(TypedDict):
     r"""If a file fails to move to its final destination after the maximum number of retries, move it to a designated directory to prevent further errors"""
     on_disk_full_backpressure: NotRequired[OutputSecurityLakeDiskSpaceProtection]
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
+    force_close_on_shutdown: NotRequired[bool]
+    r"""Force all staged files to close during an orderly Node shutdown. This triggers immediate upload of in-progress data — regardless of idle time, file age, or size thresholds — to minimize data loss."""
     max_file_open_time_sec: NotRequired[float]
     r"""Maximum amount of time to write to a file. Files open for longer than this will be closed and moved to final output location."""
     max_file_idle_time_sec: NotRequired[float]
@@ -239,6 +241,8 @@ class OutputSecurityLakeTypedDict(TypedDict):
     r"""Select or create a stored secret that references your access key and secret key"""
     empty_dir_cleanup_sec: NotRequired[float]
     r"""How frequently, in seconds, to clean up empty directories"""
+    directory_batch_size: NotRequired[float]
+    r"""Number of directories to process in each batch during cleanup of empty directories. Minimum is 10, maximum is 10000. Higher values may require more memory."""
     parquet_schema: NotRequired[str]
     r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
     deadletter_path: NotRequired[str]
@@ -422,6 +426,11 @@ class OutputSecurityLake(BaseModel):
     ] = OutputSecurityLakeDiskSpaceProtection.BLOCK
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    force_close_on_shutdown: Annotated[
+        Optional[bool], pydantic.Field(alias="forceCloseOnShutdown")
+    ] = False
+    r"""Force all staged files to close during an orderly Node shutdown. This triggers immediate upload of in-progress data — regardless of idle time, file age, or size thresholds — to minimize data loss."""
+
     max_file_open_time_sec: Annotated[
         Optional[float], pydantic.Field(alias="maxFileOpenTimeSec")
     ] = 300
@@ -519,6 +528,11 @@ class OutputSecurityLake(BaseModel):
     ] = 300
     r"""How frequently, in seconds, to clean up empty directories"""
 
+    directory_batch_size: Annotated[
+        Optional[float], pydantic.Field(alias="directoryBatchSize")
+    ] = 1000
+    r"""Number of directories to process in each batch during cleanup of empty directories. Minimum is 10, maximum is 10000. Higher values may require more memory."""
+
     parquet_schema: Annotated[Optional[str], pydantic.Field(alias="parquetSchema")] = (
         None
     )

cribl_control_plane/models/outputsyslog.py

@@ -346,6 +346,8 @@ class OutputSyslogTypedDict(TypedDict):
     r"""Maximum size of syslog messages. Make sure this value is less than or equal to the MTU to avoid UDP packet fragmentation."""
     udp_dns_resolve_period_sec: NotRequired[float]
     r"""How often to resolve the destination hostname to an IP address. Ignored if the destination is an IP address. A value of 0 means every message sent will incur a DNS lookup."""
+    enable_ip_spoofing: NotRequired[bool]
+    r"""Send Syslog traffic using the original event's Source IP and port. To enable this, you must install the external `udp-sender` helper binary at `/usr/bin/udp-sender` on all Worker Nodes and grant it the `CAP_NET_RAW` capability."""
     pq_strict_ordering: NotRequired[bool]
     r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
     pq_rate_per_sec: NotRequired[float]
@@ -502,6 +504,11 @@ class OutputSyslog(BaseModel):
     ] = 0
     r"""How often to resolve the destination hostname to an IP address. Ignored if the destination is an IP address. A value of 0 means every message sent will incur a DNS lookup."""
 
+    enable_ip_spoofing: Annotated[
+        Optional[bool], pydantic.Field(alias="enableIpSpoofing")
+    ] = False
+    r"""Send Syslog traffic using the original event's Source IP and port. To enable this, you must install the external `udp-sender` helper binary at `/usr/bin/udp-sender` on all Worker Nodes and grant it the `CAP_NET_RAW` capability."""
+
     pq_strict_ordering: Annotated[
         Optional[bool], pydantic.Field(alias="pqStrictOrdering")
     ] = True

cribl_control_plane/models/runnablejobcollection.py

@@ -73,7 +73,6 @@ class RunnableJobCollectionRunSettingsTypedDict(TypedDict):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
     max_task_size: NotRequired[str]
@@ -88,7 +87,6 @@ class RunnableJobCollectionRunSettingsTypedDict(TypedDict):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
 
@@ -152,7 +150,6 @@ class RunnableJobCollectionRunSettings(BaseModel):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
 
@@ -170,7 +167,6 @@ class RunnableJobCollectionRunSettings(BaseModel):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
 
@@ -452,7 +448,6 @@ class RunnableJobCollectionRunTypedDict(TypedDict):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
     max_task_size: NotRequired[str]
@@ -466,7 +461,6 @@ class RunnableJobCollectionRunTypedDict(TypedDict):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
     discover_to_routes: NotRequired[bool]
@@ -536,7 +530,6 @@ class RunnableJobCollectionRun(BaseModel):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
 
@@ -553,7 +546,6 @@ class RunnableJobCollectionRun(BaseModel):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
 

cribl_control_plane/models/runnablejobexecutor.py

@@ -73,7 +73,6 @@ class RunnableJobExecutorRunSettingsTypedDict(TypedDict):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
     max_task_size: NotRequired[str]
@@ -88,7 +87,6 @@ class RunnableJobExecutorRunSettingsTypedDict(TypedDict):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
 
@@ -150,7 +148,6 @@ class RunnableJobExecutorRunSettings(BaseModel):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
 
@@ -168,7 +165,6 @@ class RunnableJobExecutorRunSettings(BaseModel):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
 

cribl_control_plane/models/runnablejobscheduledsearch.py

@@ -73,7 +73,6 @@ class RunnableJobScheduledSearchRunSettingsTypedDict(TypedDict):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
     max_task_size: NotRequired[str]
@@ -88,7 +87,6 @@ class RunnableJobScheduledSearchRunSettingsTypedDict(TypedDict):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
 
@@ -151,7 +149,6 @@ class RunnableJobScheduledSearchRunSettings(BaseModel):
 
 
 
-
     if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
     """
 
@@ -169,7 +166,6 @@ class RunnableJobScheduledSearchRunSettings(BaseModel):
 
 
 
-
     you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
     """
 

cribl_control_plane/models/updateconfiggroupbyproductandidop.py

@@ -14,7 +14,8 @@ from cribl_control_plane.utils import (
 import pydantic
 from pydantic import field_serializer
 from pydantic.functional_validators import PlainValidator
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateConfigGroupByProductAndIDRequestTypedDict(TypedDict):
@@ -54,3 +55,20 @@ class UpdateConfigGroupByProductAndIDRequest(BaseModel):
             except ValueError:
                 return value
         return value
+
+
+class UpdateConfigGroupByProductAndIDResponseTypedDict(TypedDict):
+    r"""a list of ConfigGroup objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[ConfigGroupTypedDict]]
+
+
+class UpdateConfigGroupByProductAndIDResponse(BaseModel):
+    r"""a list of ConfigGroup objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[ConfigGroup]] = None

cribl_control_plane/models/updateconfiggroupdeploybyproductandidop.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .configgroup import ConfigGroup, ConfigGroupTypedDict
 from .deployrequest import DeployRequest, DeployRequestTypedDict
 from .productscore import ProductsCore
 from cribl_control_plane import models
@@ -13,7 +14,8 @@ from cribl_control_plane.utils import (
 )
 from pydantic import field_serializer
 from pydantic.functional_validators import PlainValidator
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateConfigGroupDeployByProductAndIDRequestTypedDict(TypedDict):
@@ -51,3 +53,20 @@ class UpdateConfigGroupDeployByProductAndIDRequest(BaseModel):
             except ValueError:
                 return value
         return value
+
+
+class UpdateConfigGroupDeployByProductAndIDResponseTypedDict(TypedDict):
+    r"""a list of ConfigGroup objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[ConfigGroupTypedDict]]
+
+
+class UpdateConfigGroupDeployByProductAndIDResponse(BaseModel):
+    r"""a list of ConfigGroup objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[ConfigGroup]] = None

cribl_control_plane/models/updatecribllakedatasetbylakeidandidop.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .cribllakedataset import CriblLakeDataset, CriblLakeDatasetTypedDict
 from .cribllakedatasetupdate import (
     CriblLakeDatasetUpdate,
     CriblLakeDatasetUpdateTypedDict,
@@ -8,7 +9,8 @@ from .cribllakedatasetupdate import (
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
 import pydantic
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateCriblLakeDatasetByLakeIDAndIDRequestTypedDict(TypedDict):
@@ -40,3 +42,20 @@ class UpdateCriblLakeDatasetByLakeIDAndIDRequest(BaseModel):
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
     r"""CriblLakeDatasetUpdate object"""
+
+
+class UpdateCriblLakeDatasetByLakeIDAndIDResponseTypedDict(TypedDict):
+    r"""a list of CriblLakeDataset objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[CriblLakeDatasetTypedDict]]
+
+
+class UpdateCriblLakeDatasetByLakeIDAndIDResponse(BaseModel):
+    r"""a list of CriblLakeDataset objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[CriblLakeDataset]] = None

cribl_control_plane/models/updateinputbyidop.py

@@ -4,7 +4,8 @@ from __future__ import annotations
 from .input import Input, InputTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateInputByIDRequestTypedDict(TypedDict):
@@ -24,3 +25,20 @@ class UpdateInputByIDRequest(BaseModel):
         Input, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
     r"""Input object"""
+
+
+class UpdateInputByIDResponseTypedDict(TypedDict):
+    r"""a list of Source objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[InputTypedDict]]
+
+
+class UpdateInputByIDResponse(BaseModel):
+    r"""a list of Source objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[Input]] = None

cribl_control_plane/models/updateinputhectokenbyidandtokenop.py

@@ -1,10 +1,12 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .inputsplunkhec import InputSplunkHec, InputSplunkHecTypedDict
 from .updatehectokenrequest import UpdateHecTokenRequest, UpdateHecTokenRequestTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateInputHecTokenByIDAndTokenRequestTypedDict(TypedDict):
@@ -32,3 +34,20 @@ class UpdateInputHecTokenByIDAndTokenRequest(BaseModel):
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
     r"""UpdateHecTokenRequest object"""
+
+
+class UpdateInputHecTokenByIDAndTokenResponseTypedDict(TypedDict):
+    r"""a list of InputSplunkHec objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[InputSplunkHecTypedDict]]
+
+
+class UpdateInputHecTokenByIDAndTokenResponse(BaseModel):
+    r"""a list of InputSplunkHec objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[InputSplunkHec]] = None

cribl_control_plane/models/updateoutputbyidop.py

@@ -4,7 +4,8 @@ from __future__ import annotations
 from .output import Output, OutputTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateOutputByIDRequestTypedDict(TypedDict):
@@ -24,3 +25,20 @@ class UpdateOutputByIDRequest(BaseModel):
         Output, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
     r"""Output object"""
+
+
+class UpdateOutputByIDResponseTypedDict(TypedDict):
+    r"""a list of Destination objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[OutputTypedDict]]
+
+
+class UpdateOutputByIDResponse(BaseModel):
+    r"""a list of Destination objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[Output]] = None

cribl_control_plane/models/updatepacksbyidop.py

@@ -1,10 +1,12 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .packinfo import PackInfo, PackInfoTypedDict
 from .packupgraderequest import PackUpgradeRequest, PackUpgradeRequestTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdatePacksByIDRequestTypedDict(TypedDict):
@@ -25,3 +27,20 @@ class UpdatePacksByIDRequest(BaseModel):
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
     r"""PackUpgradeRequest object"""
+
+
+class UpdatePacksByIDResponseTypedDict(TypedDict):
+    r"""a list of PackInfo objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[PackInfoTypedDict]]
+
+
+class UpdatePacksByIDResponse(BaseModel):
+    r"""a list of PackInfo objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[PackInfo]] = None

cribl_control_plane/models/updatepipelinebyidop.py

@@ -5,7 +5,8 @@ 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_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdatePipelineByIDRequestTypedDict(TypedDict):
@@ -27,3 +28,20 @@ class UpdatePipelineByIDRequest(BaseModel):
         Pipeline, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
     r"""Pipeline object"""
+
+
+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

@@ -5,7 +5,8 @@ from .routes import Routes, RoutesTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
 import pydantic
-from typing_extensions import Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class UpdateRoutesByIDRequestTypedDict(TypedDict):
@@ -27,3 +28,20 @@ class UpdateRoutesByIDRequest(BaseModel):
         Routes, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
     r"""Routes object"""
+
+
+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

cribl_control_plane/nodes.py

@@ -37,7 +37,7 @@ class Nodes(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListMasterWorkerEntry:
+    ) -> models.ListMasterWorkerEntryResponse:
         r"""Get detailed metadata for Worker and Edge Nodes
 
         Get detailed metadata for Worker and Edge Nodes.
@@ -114,7 +114,7 @@ class Nodes(BaseSDK):
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
             return unmarshal_json_response(
-                models.CountedListMasterWorkerEntry, http_res
+                models.ListMasterWorkerEntryResponse, http_res
             )
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
@@ -141,7 +141,7 @@ class Nodes(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListMasterWorkerEntry:
+    ) -> models.ListMasterWorkerEntryResponse:
         r"""Get detailed metadata for Worker and Edge Nodes
 
         Get detailed metadata for Worker and Edge Nodes.
@@ -218,7 +218,7 @@ class Nodes(BaseSDK):
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
             return unmarshal_json_response(
-                models.CountedListMasterWorkerEntry, http_res
+                models.ListMasterWorkerEntryResponse, http_res
             )
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
@@ -240,7 +240,7 @@ class Nodes(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListnumber:
+    ) -> models.GetMasterWorkerEntryResponse:
         r"""Get a count of Worker and Edge Nodes
 
         Get a count of all Worker and Edge Nodes.
@@ -306,7 +306,9 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListnumber, http_res)
+            return unmarshal_json_response(
+                models.GetMasterWorkerEntryResponse, http_res
+            )
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -327,7 +329,7 @@ class Nodes(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListnumber:
+    ) -> models.GetMasterWorkerEntryResponse:
         r"""Get a count of Worker and Edge Nodes
 
         Get a count of all Worker and Edge Nodes.
@@ -393,7 +395,9 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListnumber, http_res)
+            return unmarshal_json_response(
+                models.GetMasterWorkerEntryResponse, http_res
+            )
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)