cribl-control-plane 0.2.0b8__py3-none-any.whl → 0.2.0rc1__py3-none-any.whl

cribl_control_plane/models/outputwavefront.py

@@ -36,11 +36,8 @@ class OutputWavefrontExtraHTTPHeader(BaseModel):
 class OutputWavefrontFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
-    # Payload
     PAYLOAD = "payload"
-    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
-    # None
     NONE = "none"
 
 
@@ -101,40 +98,30 @@ class OutputWavefrontTimeoutRetrySettings(BaseModel):
 class OutputWavefrontBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
-    # Persistent Queue
     QUEUE = "queue"
 
 
 class OutputWavefrontCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputWavefrontQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
-    # Block
     BLOCK = "block"
-    # Drop new data
     DROP = "drop"
 
 
 class OutputWavefrontMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
-    # Error
     ERROR = "error"
-    # Backpressure
     BACKPRESSURE = "backpressure"
-    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/outputwebhook.py

@@ -26,13 +26,9 @@ class OutputWebhookMethod(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputWebhookFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to format events before sending out"""
 
-    # NDJSON (Newline Delimited JSON)
     NDJSON = "ndjson"
-    # JSON Array
     JSON_ARRAY = "json_array"
-    # Custom
     CUSTOM = "custom"
-    # Advanced
     ADVANCED = "advanced"
 
 
@@ -50,11 +46,8 @@ class OutputWebhookExtraHTTPHeader(BaseModel):
 class OutputWebhookFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
-    # Payload
     PAYLOAD = "payload"
-    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
-    # None
     NONE = "none"
 
 
@@ -115,28 +108,19 @@ class OutputWebhookTimeoutRetrySettings(BaseModel):
 class OutputWebhookBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
-    # Persistent Queue
     QUEUE = "queue"
 
 
 class OutputWebhookAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Authentication method to use for the HTTP request"""
 
-    # None
     NONE = "none"
-    # Basic
     BASIC = "basic"
-    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
-    # Token
     TOKEN = "token"
-    # Token (text secret)
     TEXT_SECRET = "textSecret"
-    # OAuth
     OAUTH = "oauth"
 
 
@@ -215,29 +199,22 @@ class OutputWebhookTLSSettingsClientSide(BaseModel):
 class OutputWebhookCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputWebhookQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
-    # Block
     BLOCK = "block"
-    # Drop new data
     DROP = "drop"
 
 
 class OutputWebhookMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
-    # Error
     ERROR = "error"
-    # Backpressure
     BACKPRESSURE = "backpressure"
-    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/outputxsiam.py

@@ -29,11 +29,8 @@ class OutputXsiamExtraHTTPHeader(BaseModel):
 class OutputXsiamFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
-    # Payload
     PAYLOAD = "payload"
-    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
-    # None
     NONE = "none"
 
 
@@ -101,11 +98,8 @@ class OutputXsiamTimeoutRetrySettings(BaseModel):
 class OutputXsiamBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
-    # Persistent Queue
     QUEUE = "queue"
 
 
@@ -125,29 +119,22 @@ class OutputXsiamURL(BaseModel):
 class OutputXsiamCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputXsiamQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
-    # Block
     BLOCK = "block"
-    # Drop new data
     DROP = "drop"
 
 
 class OutputXsiamMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
 
-    # Error
     ERROR = "error"
-    # Backpressure
     BACKPRESSURE = "backpressure"
-    # Always On
     ALWAYS = "always"
 
 

cribl_control_plane/models/packinfo.py

@@ -8,27 +8,26 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class PackInfoTagsTypedDict(TypedDict):
-    data_type: NotRequired[List[str]]
+    data_type: List[str]
+    technology: List[str]
     domain: NotRequired[List[str]]
     streamtags: NotRequired[List[str]]
-    technology: NotRequired[List[str]]
 
 
 class PackInfoTags(BaseModel):
-    data_type: Annotated[Optional[List[str]], pydantic.Field(alias="dataType")] = None
+    data_type: Annotated[List[str], pydantic.Field(alias="dataType")]
+
+    technology: List[str]
 
     domain: Optional[List[str]] = None
 
     streamtags: Optional[List[str]] = None
 
-    technology: Optional[List[str]] = None
-
 
 class PackInfoTypedDict(TypedDict):
     id: str
     source: str
     author: NotRequired[str]
-    dependencies: NotRequired[Dict[str, str]]
     description: NotRequired[str]
     display_name: NotRequired[str]
     exports: NotRequired[List[str]]
@@ -49,8 +48,6 @@ class PackInfo(BaseModel):
 
     author: Optional[str] = None
 
-    dependencies: Optional[Dict[str, str]] = None
-
     description: Optional[str] = None
 
     display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None

cribl_control_plane/models/packinstallinfo.py

@@ -8,27 +8,26 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class PackInstallInfoTagsTypedDict(TypedDict):
-    data_type: NotRequired[List[str]]
+    data_type: List[str]
+    technology: List[str]
     domain: NotRequired[List[str]]
     streamtags: NotRequired[List[str]]
-    technology: NotRequired[List[str]]
 
 
 class PackInstallInfoTags(BaseModel):
-    data_type: Annotated[Optional[List[str]], pydantic.Field(alias="dataType")] = None
+    data_type: Annotated[List[str], pydantic.Field(alias="dataType")]
+
+    technology: List[str]
 
     domain: Optional[List[str]] = None
 
     streamtags: Optional[List[str]] = None
 
-    technology: Optional[List[str]] = None
-
 
 class PackInstallInfoTypedDict(TypedDict):
     id: str
     source: str
     author: NotRequired[str]
-    dependencies: NotRequired[Dict[str, str]]
     description: NotRequired[str]
     display_name: NotRequired[str]
     exports: NotRequired[List[str]]
@@ -50,8 +49,6 @@ class PackInstallInfo(BaseModel):
 
     author: Optional[str] = None
 
-    dependencies: Optional[Dict[str, str]] = None
-
     description: Optional[str] = None
 
     display_name: Annotated[Optional[str], pydantic.Field(alias="displayName")] = None

cribl_control_plane/models/{uploadpackresponse.py → routecloneconf.py}

@@ -5,9 +5,9 @@ from cribl_control_plane.types import BaseModel
 from typing_extensions import TypedDict
 
 
-class UploadPackResponseTypedDict(TypedDict):
-    source: str
+class RouteCloneConfTypedDict(TypedDict):
+    pass
 
 
-class UploadPackResponse(BaseModel):
-    source: str
+class RouteCloneConf(BaseModel):
+    pass

cribl_control_plane/models/routeconf.py

@@ -1,9 +1,10 @@
 """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 Dict, List, Optional
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -12,7 +13,7 @@ class RouteConfTypedDict(TypedDict):
     id: str
     name: str
     pipeline: str
-    clones: NotRequired[List[Dict[str, str]]]
+    clones: NotRequired[List[RouteCloneConfTypedDict]]
     context: NotRequired[str]
     description: NotRequired[str]
     disabled: NotRequired[bool]
@@ -32,7 +33,7 @@ class RouteConf(BaseModel):
 
     pipeline: str
 
-    clones: Optional[List[Dict[str, str]]] = None
+    clones: Optional[List[RouteCloneConf]] = None
 
     context: Optional[str] = None
 

cribl_control_plane/models/runnablejobcollection.py

@@ -363,13 +363,9 @@ class RunnableJobCollectionTimeWarning(BaseModel):
 
 
 class WhereToCapture(int, Enum, metaclass=utils.OpenEnumMeta):
-    # 1. Before pre-processing Pipeline
     ZERO = 0
-    # 2. Before the Routes
     ONE = 1
-    # 3. Before post-processing Pipeline
     TWO = 2
-    # 4. Before the Destination
     THREE = 3
 
 

cribl_control_plane/packs.py

@@ -6,8 +6,7 @@ from cribl_control_plane._hooks import HookContext
 from cribl_control_plane.types import BaseModel, OptionalNullable, UNSET
 from cribl_control_plane.utils import get_security_from_env
 from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_response
-import io
-from typing import Any, IO, Mapping, Optional, Union, cast
+from typing import Any, Mapping, Optional, Union, cast
 
 
 class Packs(BaseSDK):
@@ -24,9 +23,9 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Install a Pack
+        r"""Create or install a Pack
 
-        Install a Pack.<br><br>To install an uploaded Pack, provide the <code>source</code> value from the <code>PUT /packs</code> response as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a URL, provide the direct URL location of the <code>.crbl</code> file for the Pack as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a Git repository, provide <code>git+<repo-url></code> as the <code>source</code> parameter in the request body.<br><br>If you do not include the <code>source</code> parameter in the request body, an empty Pack is created.
+        Create or install a Pack.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -116,9 +115,9 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Install a Pack
+        r"""Create or install a Pack
 
-        Install a Pack.<br><br>To install an uploaded Pack, provide the <code>source</code> value from the <code>PUT /packs</code> response as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a URL, provide the direct URL location of the <code>.crbl</code> file for the Pack as the <code>source</code> parameter in the request body.<br><br>To install a Pack by importing from a Git repository, provide <code>git+<repo-url></code> as the <code>source</code> parameter in the request body.<br><br>If you do not include the <code>source</code> parameter in the request body, an empty Pack is created.
+        Create or install a Pack.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -371,200 +370,6 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def upload(
-        self,
-        *,
-        filename: str,
-        request_body: Union[bytes, IO[bytes], io.BufferedReader],
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UploadPackResponse:
-        r"""Upload a Pack file
-
-        Upload a Pack file. Returns the <code>source</code> ID needed to install the Pack with <code>POST /packs source</code>, which you must call separately.
-
-        :param filename: Filename of the Pack file to upload.
-        :param request_body:
-        :param retries: Override the default retry configuration for this method
-        :param server_url: Override the default server URL for this method
-        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
-        :param http_headers: Additional headers to set or replace on requests.
-        """
-        base_url = None
-        url_variables = None
-        if timeout_ms is None:
-            timeout_ms = self.sdk_configuration.timeout_ms
-
-        if server_url is not None:
-            base_url = server_url
-        else:
-            base_url = self._get_url(base_url, url_variables)
-
-        request = models.UpdatePacksRequest(
-            filename=filename,
-            request_body=request_body,
-        )
-
-        req = self._build_request(
-            method="PUT",
-            path="/packs",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=True,
-            request_has_path_params=False,
-            request_has_query_params=True,
-            user_agent_header="user-agent",
-            accept_header_value="application/json",
-            http_headers=http_headers,
-            security=self.sdk_configuration.security,
-            get_serialized_body=lambda: utils.serialize_request_body(
-                request.request_body,
-                False,
-                False,
-                "raw",
-                Union[bytes, IO[bytes], io.BufferedReader],
-            ),
-            timeout_ms=timeout_ms,
-        )
-
-        if retries == UNSET:
-            if self.sdk_configuration.retry_config is not UNSET:
-                retries = self.sdk_configuration.retry_config
-
-        retry_config = None
-        if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
-
-        http_res = self.do_request(
-            hook_ctx=HookContext(
-                config=self.sdk_configuration,
-                base_url=base_url or "",
-                operation_id="updatePacks",
-                oauth2_scopes=[],
-                security_source=get_security_from_env(
-                    self.sdk_configuration.security, models.Security
-                ),
-            ),
-            request=req,
-            error_status_codes=["401", "4XX", "500", "5XX"],
-            retry_config=retry_config,
-        )
-
-        response_data: Any = None
-        if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.UploadPackResponse, 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)
-        if utils.match_response(http_res, ["401", "4XX"], "*"):
-            http_res_text = utils.stream_to_text(http_res)
-            raise errors.APIError("API error occurred", http_res, http_res_text)
-        if utils.match_response(http_res, "5XX", "*"):
-            http_res_text = utils.stream_to_text(http_res)
-            raise errors.APIError("API error occurred", http_res, http_res_text)
-
-        raise errors.APIError("Unexpected response received", http_res)
-
-    async def upload_async(
-        self,
-        *,
-        filename: str,
-        request_body: Union[bytes, IO[bytes], io.BufferedReader],
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UploadPackResponse:
-        r"""Upload a Pack file
-
-        Upload a Pack file. Returns the <code>source</code> ID needed to install the Pack with <code>POST /packs source</code>, which you must call separately.
-
-        :param filename: Filename of the Pack file to upload.
-        :param request_body:
-        :param retries: Override the default retry configuration for this method
-        :param server_url: Override the default server URL for this method
-        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
-        :param http_headers: Additional headers to set or replace on requests.
-        """
-        base_url = None
-        url_variables = None
-        if timeout_ms is None:
-            timeout_ms = self.sdk_configuration.timeout_ms
-
-        if server_url is not None:
-            base_url = server_url
-        else:
-            base_url = self._get_url(base_url, url_variables)
-
-        request = models.UpdatePacksRequest(
-            filename=filename,
-            request_body=request_body,
-        )
-
-        req = self._build_request_async(
-            method="PUT",
-            path="/packs",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=True,
-            request_has_path_params=False,
-            request_has_query_params=True,
-            user_agent_header="user-agent",
-            accept_header_value="application/json",
-            http_headers=http_headers,
-            security=self.sdk_configuration.security,
-            get_serialized_body=lambda: utils.serialize_request_body(
-                request.request_body,
-                False,
-                False,
-                "raw",
-                Union[bytes, IO[bytes], io.BufferedReader],
-            ),
-            timeout_ms=timeout_ms,
-        )
-
-        if retries == UNSET:
-            if self.sdk_configuration.retry_config is not UNSET:
-                retries = self.sdk_configuration.retry_config
-
-        retry_config = None
-        if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
-
-        http_res = await self.do_request_async(
-            hook_ctx=HookContext(
-                config=self.sdk_configuration,
-                base_url=base_url or "",
-                operation_id="updatePacks",
-                oauth2_scopes=[],
-                security_source=get_security_from_env(
-                    self.sdk_configuration.security, models.Security
-                ),
-            ),
-            request=req,
-            error_status_codes=["401", "4XX", "500", "5XX"],
-            retry_config=retry_config,
-        )
-
-        response_data: Any = None
-        if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.UploadPackResponse, 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)
-        if utils.match_response(http_res, ["401", "4XX"], "*"):
-            http_res_text = await utils.stream_to_text_async(http_res)
-            raise errors.APIError("API error occurred", http_res, http_res_text)
-        if utils.match_response(http_res, "5XX", "*"):
-            http_res_text = await utils.stream_to_text_async(http_res)
-            raise errors.APIError("API error occurred", http_res, http_res_text)
-
-        raise errors.APIError("Unexpected response received", http_res)
-
     def delete(
         self,
         *,
@@ -928,7 +733,7 @@ class Packs(BaseSDK):
     ) -> models.UpdatePacksByIDResponse:
         r"""Upgrade a Pack
 
-        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack.Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
         :param id: The <code>id</code> of the Pack to upgrade.
         :param source:
@@ -1036,7 +841,7 @@ class Packs(BaseSDK):
     ) -> models.UpdatePacksByIDResponse:
         r"""Upgrade a Pack
 
-        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack.Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
         :param id: The <code>id</code> of the Pack to upgrade.
         :param source: