cribl-control-plane 0.0.24__py3-none-any.whl → 0.0.25__py3-none-any.whl

cribl_control_plane/models/outputkafka.py

@@ -37,6 +37,13 @@ class OutputKafkaCompression(str, Enum):
     LZ4 = "lz4"
 
 
+class OutputKafkaSchemaType(str, Enum):
+    r"""The schema format used to encode and decode event data"""
+
+    AVRO = "avro"
+    JSON = "json"
+
+
 class OutputKafkaAuthTypedDict(TypedDict):
     r"""Credentials to use when authenticating with the schema registry using basic HTTP authentication"""
 
@@ -137,6 +144,8 @@ class OutputKafkaKafkaSchemaRegistryAuthenticationTypedDict(TypedDict):
     disabled: NotRequired[bool]
     schema_registry_url: NotRequired[str]
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
+    schema_type: NotRequired[OutputKafkaSchemaType]
+    r"""The schema format used to encode and decode event data"""
     connection_timeout: NotRequired[float]
     r"""Maximum time to wait for a Schema Registry connection to complete successfully"""
     request_timeout: NotRequired[float]
@@ -160,6 +169,11 @@ class OutputKafkaKafkaSchemaRegistryAuthentication(BaseModel):
     ] = "http://localhost:8081"
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
 
+    schema_type: Annotated[
+        Optional[OutputKafkaSchemaType], pydantic.Field(alias="schemaType")
+    ] = OutputKafkaSchemaType.AVRO
+    r"""The schema format used to encode and decode event data"""
+
     connection_timeout: Annotated[
         Optional[float], pydantic.Field(alias="connectionTimeout")
     ] = 30000

cribl_control_plane/models/outputloki.py

@@ -198,6 +198,10 @@ class OutputLokiTypedDict(TypedDict):
     timeout_retry_settings: NotRequired[OutputLokiTimeoutRetrySettingsTypedDict]
     response_honor_retry_after_header: NotRequired[bool]
     r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
+    enable_dynamic_headers: NotRequired[bool]
+    r"""Add per-event HTTP headers from the __headers field to outgoing requests. Events with different headers are batched and sent separately."""
+    send_structured_metadata: NotRequired[bool]
+    r"""Add structured metadata fields from __structuredMetadata to each log. Key-value pairs must be strings."""
     on_backpressure: NotRequired[OutputLokiBackpressureBehavior]
     r"""How to handle events when all receivers are exerting backpressure"""
     total_memory_limit_kb: NotRequired[float]
@@ -335,6 +339,16 @@ class OutputLoki(BaseModel):
     ] = False
     r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
 
+    enable_dynamic_headers: Annotated[
+        Optional[bool], pydantic.Field(alias="enableDynamicHeaders")
+    ] = False
+    r"""Add per-event HTTP headers from the __headers field to outgoing requests. Events with different headers are batched and sent separately."""
+
+    send_structured_metadata: Annotated[
+        Optional[bool], pydantic.Field(alias="sendStructuredMetadata")
+    ] = False
+    r"""Add structured metadata fields from __structuredMetadata to each log. Key-value pairs must be strings."""
+
     on_backpressure: Annotated[
         Optional[OutputLokiBackpressureBehavior], pydantic.Field(alias="onBackpressure")
     ] = OutputLokiBackpressureBehavior.BLOCK

cribl_control_plane/models/outputmsk.py

@@ -37,6 +37,13 @@ class OutputMskCompression(str, Enum):
     LZ4 = "lz4"
 
 
+class OutputMskSchemaType(str, Enum):
+    r"""The schema format used to encode and decode event data"""
+
+    AVRO = "avro"
+    JSON = "json"
+
+
 class OutputMskAuthTypedDict(TypedDict):
     r"""Credentials to use when authenticating with the schema registry using basic HTTP authentication"""
 
@@ -137,6 +144,8 @@ class OutputMskKafkaSchemaRegistryAuthenticationTypedDict(TypedDict):
     disabled: NotRequired[bool]
     schema_registry_url: NotRequired[str]
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
+    schema_type: NotRequired[OutputMskSchemaType]
+    r"""The schema format used to encode and decode event data"""
     connection_timeout: NotRequired[float]
     r"""Maximum time to wait for a Schema Registry connection to complete successfully"""
     request_timeout: NotRequired[float]
@@ -160,6 +169,11 @@ class OutputMskKafkaSchemaRegistryAuthentication(BaseModel):
     ] = "http://localhost:8081"
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
 
+    schema_type: Annotated[
+        Optional[OutputMskSchemaType], pydantic.Field(alias="schemaType")
+    ] = OutputMskSchemaType.AVRO
+    r"""The schema format used to encode and decode event data"""
+
     connection_timeout: Annotated[
         Optional[float], pydantic.Field(alias="connectionTimeout")
     ] = 30000

cribl_control_plane/models/outputs3.py

@@ -161,7 +161,7 @@ class OutputS3TypedDict(TypedDict):
     add_id_to_stage_path: NotRequired[bool]
     r"""Add the Output ID value to staging location"""
     dest_path: NotRequired[str]
-    r"""Prefix to append to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
+    r"""Prefix to prepend to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
     object_acl: NotRequired[OutputS3ObjectACL]
     r"""Object ACL to assign to uploaded objects"""
     storage_class: NotRequired[OutputS3StorageClass]
@@ -326,7 +326,7 @@ class OutputS3(BaseModel):
     r"""Add the Output ID value to staging location"""
 
     dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = ""
-    r"""Prefix to append to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
+    r"""Prefix to prepend to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
 
     object_acl: Annotated[
         Optional[OutputS3ObjectACL], pydantic.Field(alias="objectACL")

cribl_control_plane/nodes.py

@@ -10,180 +10,6 @@ from typing import Any, Mapping, Optional
 
 
 class Nodes(BaseSDK):
-    def get_count(
-        self,
-        *,
-        filter_exp: Optional[str] = None,
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetSummaryWorkersResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
-
-        get worker and edge nodes count
-
-        :param filter_exp: Filter expression evaluated against nodes
-        :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.GetSummaryWorkersRequest(
-            filter_exp=filter_exp,
-        )
-
-        req = self._build_request(
-            method="GET",
-            path="/master/summary/workers",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=False,
-            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,
-            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="getSummaryWorkers",
-                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.GetSummaryWorkersResponse, 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 get_count_async(
-        self,
-        *,
-        filter_exp: Optional[str] = None,
-        retries: OptionalNullable[utils.RetryConfig] = UNSET,
-        server_url: Optional[str] = None,
-        timeout_ms: Optional[int] = None,
-        http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetSummaryWorkersResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
-
-        get worker and edge nodes count
-
-        :param filter_exp: Filter expression evaluated against nodes
-        :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.GetSummaryWorkersRequest(
-            filter_exp=filter_exp,
-        )
-
-        req = self._build_request_async(
-            method="GET",
-            path="/master/summary/workers",
-            base_url=base_url,
-            url_variables=url_variables,
-            request=request,
-            request_body_required=False,
-            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,
-            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="getSummaryWorkers",
-                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.GetSummaryWorkersResponse, 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 list(
         self,
         *,

cribl_control_plane/pipelines.py

@@ -12,7 +12,7 @@ from typing import Any, Mapping, Optional, Union
 class Pipelines(BaseSDK):
     r"""Actions related to Pipelines"""
 
-    def list_pipeline(
+    def list(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -20,9 +20,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListPipelineResponse:
-        r"""Get a list of Pipeline objects
+        r"""List all Pipelines
 
-        Get a list of Pipeline objects
+        List all Pipelines
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -92,7 +92,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def list_pipeline_async(
+    async def list_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -100,9 +100,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListPipelineResponse:
-        r"""Get a list of Pipeline objects
+        r"""List all Pipelines
 
-        Get a list of Pipeline objects
+        List all Pipelines
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -358,7 +358,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_pipeline_by_id(
+    def get(
         self,
         *,
         id: str,
@@ -367,9 +367,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetPipelineByIDResponse:
-        r"""Get Pipeline by ID
+        r"""Retrieve a Pipeline
 
-        Get Pipeline by ID
+        Retrieve a Pipeline
 
         :param id: Unique ID to GET
         :param retries: Override the default retry configuration for this method
@@ -445,7 +445,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_pipeline_by_id_async(
+    async def get_async(
         self,
         *,
         id: str,
@@ -454,9 +454,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetPipelineByIDResponse:
-        r"""Get Pipeline by ID
+        r"""Retrieve a Pipeline
 
-        Get Pipeline by ID
+        Retrieve a Pipeline
 
         :param id: Unique ID to GET
         :param retries: Override the default retry configuration for this method
@@ -532,7 +532,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_pipeline_by_id(
+    def update(
         self,
         *,
         id_param: str,
@@ -630,7 +630,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_pipeline_by_id_async(
+    async def update_async(
         self,
         *,
         id_param: str,
@@ -728,7 +728,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def delete_pipeline_by_id(
+    def delete(
         self,
         *,
         id: str,
@@ -737,9 +737,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeletePipelineByIDResponse:
-        r"""Delete Pipeline
+        r"""Delete a Pipeline
 
-        Delete Pipeline
+        Delete a Pipeline
 
         :param id: Unique ID to DELETE
         :param retries: Override the default retry configuration for this method
@@ -815,7 +815,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def delete_pipeline_by_id_async(
+    async def delete_async(
         self,
         *,
         id: str,
@@ -824,9 +824,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeletePipelineByIDResponse:
-        r"""Delete Pipeline
+        r"""Delete a Pipeline
 
-        Delete Pipeline
+        Delete a Pipeline
 
         :param id: Unique ID to DELETE
         :param retries: Override the default retry configuration for this method

cribl_control_plane/sdk.py

@@ -26,6 +26,7 @@ if TYPE_CHECKING:
     from cribl_control_plane.routes_sdk import RoutesSDK
     from cribl_control_plane.sources import Sources
     from cribl_control_plane.versioning import Versioning
+    from cribl_control_plane.workers_sdk import WorkersSDK
 
 
 class CriblControlPlane(BaseSDK):
@@ -40,13 +41,15 @@ class CriblControlPlane(BaseSDK):
     r"""Actions related to Routes"""
     auth: "AuthSDK"
     r"""Actions related to authentication. Do not use the /auth endpoints in Cribl.Cloud deployments. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to authenticate for Cribl.Cloud."""
-    nodes: "Nodes"
     deployments: "Deployments"
     health_info: "HealthInfo"
     packs: "Packs"
     r"""Actions related to Packs"""
     versioning: "Versioning"
     r"""Actions related to Versioning"""
+    workers: "WorkersSDK"
+    r"""Actions related to Workers"""
+    nodes: "Nodes"
     groups: "GroupsSDK"
     r"""Actions related to Groups"""
     _sub_sdk_map = {
@@ -56,11 +59,12 @@ class CriblControlPlane(BaseSDK):
         "pipelines": ("cribl_control_plane.pipelines", "Pipelines"),
         "routes": ("cribl_control_plane.routes_sdk", "RoutesSDK"),
         "auth": ("cribl_control_plane.auth_sdk", "AuthSDK"),
-        "nodes": ("cribl_control_plane.nodes", "Nodes"),
         "deployments": ("cribl_control_plane.deployments", "Deployments"),
         "health_info": ("cribl_control_plane.healthinfo", "HealthInfo"),
         "packs": ("cribl_control_plane.packs", "Packs"),
         "versioning": ("cribl_control_plane.versioning", "Versioning"),
+        "workers": ("cribl_control_plane.workers_sdk", "WorkersSDK"),
+        "nodes": ("cribl_control_plane.nodes", "Nodes"),
         "groups": ("cribl_control_plane.groups_sdk", "GroupsSDK"),
     }
 

cribl_control_plane/versioning.py

@@ -2143,9 +2143,9 @@ class Versioning(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateVersionUndoResponse:
-        r"""Undo the most recent commit and restore the local repository to the previous commit
+        r"""Discard uncommitted (staged) changes
 
-        undo the last commit
+        Discards all uncommitted (staged) configuration changes, resetting the working directory to the last committed state.
 
         :param group: Group ID
         :param retries: Override the default retry configuration for this method
@@ -2230,9 +2230,9 @@ class Versioning(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateVersionUndoResponse:
-        r"""Undo the most recent commit and restore the local repository to the previous commit
+        r"""Discard uncommitted (staged) changes
 
-        undo the last commit
+        Discards all uncommitted (staged) configuration changes, resetting the working directory to the last committed state.
 
         :param group: Group ID
         :param retries: Override the default retry configuration for this method