cribl-control-plane 0.4.0__tar.gz → 0.4.0a12__tar.gz

{cribl_control_plane-0.4.0 → cribl_control_plane-0.4.0a12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cribl-control-plane
-Version: 0.4.0
+Version: 0.4.0a12
 Summary: Python Client SDK Generated by Speakeasy.
 License-File: LICENSE
 Author: Speakeasy
@@ -18,20 +18,11 @@ Project-URL: Repository, https://github.com/criblio/cribl_control_plane_sdk_pyth
 Description-Content-Type: text/markdown
 
 # cribl_control_plane_sdk_python
+<!-- Start Summary [summary] -->
+## Summary
 
-The Cribl Python SDK for the control plane provides operational control over Cribl resources and helps streamline the process of integrating with Cribl.
-
-In addition to the usage examples in this repository, the Cribl documentation includes [code examples for common use cases](https://docs.cribl.io/cribl-as-code/code-examples).
-
-Complementary API reference documentation is available at https://docs.cribl.io/cribl-as-code/api-reference. Product documentation is available at https://docs.cribl.io.
-
-> [!IMPORTANT]
-> **Preview Feature**
-> The Cribl SDKs are Preview features that are still being developed. We do not recommend using them in a production environment, because the features might not be fully tested or optimized for performance, and related documentation could be incomplete.
->
-> Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the features remain in Preview.
-
-<!-- No Summary [summary] -->
+Cribl API Reference: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. See our complementary product documentation at [docs.cribl.io](http://docs.cribl.io).
+<!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
@@ -251,14 +242,9 @@ asyncio.run(main())
 ```
 <!-- End SDK Example Usage [usage] -->
 
+<!-- Start Authentication [security] -->
 ## Authentication
 
-Except for the `health.get` and `auth.tokens.get` methods, all Cribl SDK requests require you to authenticate with a Bearer token. You must include a valid Bearer token in the configuration when initializing your SDK client. The Bearer token verifies your identity and ensures secure access to the requested resources. The SDK automatically manages the `Authorization` header for subsequent requests once properly authenticated.
-
-For information about Bearer token expiration, see [Token Management](https://docs.cribl.io/cribl-as-code/sdks-auth/#sdks-token-mgmt) in the Cribl as Code documentation.
-
-**Authentication happens once during SDK initialization**. After you initialize the SDK client with authentication as shown in the [authentication examples](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#authentication-examples), the SDK automatically handles authentication for all subsequent API calls. You do not need to include authentication parameters in individual API requests. The [SDK Example Usage](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#sdk-example-usage) section shows how to initialize the SDK and make API calls, but if you've properly initialized your client as shown in the authentication examples, you only need to make the API method calls themselves without re-initializing.
-
 ### Per-Client Security Schemes
 
 This SDK supports the following security schemes globally:
@@ -268,19 +254,62 @@ This SDK supports the following security schemes globally:
 | `bearer_auth`  | http   | HTTP Bearer  | `CRIBLCONTROLPLANE_BEARER_AUTH`  |
 | `client_oauth` | oauth2 | OAuth2 token | `CRIBLCONTROLPLANE_CLIENT_OAUTH` |
 
-To configure authentication on Cribl.Cloud and in hybrid deployments, use the `client_oauth` security scheme. The SDK uses the OAuth credentials that you provide to obtain a Bearer token and refresh the token within its expiration window using the standard OAuth2 flow.
-
-In on-prem deployments, use the `bearer_auth` security scheme. The SDK uses the username/password credentials that you provide to obtain a Bearer token. Automatically refreshing the Bearer token within its expiration window requires a callback function as shown in the [On-Prem Authentication Example](https://github.com/criblio/cribl_control_plane_sdk_python/blob/main/examples/example_onprem_auth.py).
+You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
+```python
+from cribl_control_plane import CriblControlPlane, models
+import os
 
-Set the security scheme through the `security` optional parameter when initializing the SDK client instance. The SDK uses the selected scheme by default to authenticate with the API for all operations that support it.
 
-### Authentication Examples
+with CriblControlPlane(
+    server_url="https://api.example.com",
+    security=models.Security(
+        bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
+    ),
+) as ccp_client:
 
-The [Cribl.Cloud and Hybrid Authentication Example](https://github.com/criblio/cribl_control_plane_sdk_python/blob/main/examples/example_cloud_auth.py) demonstrates how to configure authentication on Cribl.Cloud and in hybrid deployments. To obtain the Client ID and Client Secret you'll need to initialize using the `client_oauth` security schema, follow the [instructions for creating an API Credential](https://docs.cribl.io/cribl-as-code/sdks-auth/#sdks-auth-cloud) in the Cribl as Code documentation.
+    res = ccp_client.lake_datasets.create(lake_id="<id>", id="<id>", accelerated_fields=[
+        "<value 1>",
+        "<value 2>",
+    ], bucket_name="<value>", cache_connection={
+        "accelerated_fields": [
+            "<value 1>",
+            "<value 2>",
+        ],
+        "backfill_status": models.CacheConnectionBackfillStatus.PENDING,
+        "cache_ref": "<value>",
+        "created_at": 7795.06,
+        "lakehouse_connection_type": models.LakehouseConnectionType.CACHE,
+        "migration_query_id": "<id>",
+        "retention_in_days": 1466.58,
+    }, deletion_started_at=8310.58, description="pleased toothbrush long brush smooth swiftly rightfully phooey chapel", format_=models.CriblLakeDatasetFormat.DDSS, http_da_used=True, metrics={
+        "current_size_bytes": 6170.04,
+        "metrics_date": "<value>",
+    }, retention_period_in_days=456.37, search_config={
+        "datatypes": [
+            "<value 1>",
+        ],
+        "metadata": {
+            "earliest": "<value>",
+            "enable_acceleration": True,
+            "field_list": [
+                "<value 1>",
+                "<value 2>",
+            ],
+            "latest_run_info": {
+                "earliest_scanned_time": 4334.7,
+                "finished_at": 6811.22,
+                "latest_scanned_time": 5303.3,
+                "object_count": 9489.04,
+            },
+            "scan_mode": models.ScanMode.DETAILED,
+        },
+    }, storage_location_id="<id>", view_name="<value>")
 
-The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_plane_sdk_python/blob/main/examples/example_onprem_auth.py) demonstrates how to configure authentication in on-prem deployments using your username and password.
+    # Handle response
+    print(res)
 
-<!-- No Authentication [security] -->
+```
+<!-- End Authentication [security] -->
 
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations

{cribl_control_plane-0.4.0 → cribl_control_plane-0.4.0a12}/README-PYPI.md

@@ -1,18 +1,9 @@
 # cribl_control_plane_sdk_python
+<!-- Start Summary [summary] -->
+## Summary
 
-The Cribl Python SDK for the control plane provides operational control over Cribl resources and helps streamline the process of integrating with Cribl.
-
-In addition to the usage examples in this repository, the Cribl documentation includes [code examples for common use cases](https://docs.cribl.io/cribl-as-code/code-examples).
-
-Complementary API reference documentation is available at https://docs.cribl.io/cribl-as-code/api-reference. Product documentation is available at https://docs.cribl.io.
-
-> [!IMPORTANT]
-> **Preview Feature**
-> The Cribl SDKs are Preview features that are still being developed. We do not recommend using them in a production environment, because the features might not be fully tested or optimized for performance, and related documentation could be incomplete.
->
-> Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the features remain in Preview.
-
-<!-- No Summary [summary] -->
+Cribl API Reference: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. See our complementary product documentation at [docs.cribl.io](http://docs.cribl.io).
+<!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
@@ -232,14 +223,9 @@ asyncio.run(main())
 ```
 <!-- End SDK Example Usage [usage] -->
 
+<!-- Start Authentication [security] -->
 ## Authentication
 
-Except for the `health.get` and `auth.tokens.get` methods, all Cribl SDK requests require you to authenticate with a Bearer token. You must include a valid Bearer token in the configuration when initializing your SDK client. The Bearer token verifies your identity and ensures secure access to the requested resources. The SDK automatically manages the `Authorization` header for subsequent requests once properly authenticated.
-
-For information about Bearer token expiration, see [Token Management](https://docs.cribl.io/cribl-as-code/sdks-auth/#sdks-token-mgmt) in the Cribl as Code documentation.
-
-**Authentication happens once during SDK initialization**. After you initialize the SDK client with authentication as shown in the [authentication examples](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#authentication-examples), the SDK automatically handles authentication for all subsequent API calls. You do not need to include authentication parameters in individual API requests. The [SDK Example Usage](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/#sdk-example-usage) section shows how to initialize the SDK and make API calls, but if you've properly initialized your client as shown in the authentication examples, you only need to make the API method calls themselves without re-initializing.
-
 ### Per-Client Security Schemes
 
 This SDK supports the following security schemes globally:
@@ -249,19 +235,62 @@ This SDK supports the following security schemes globally:
 | `bearer_auth`  | http   | HTTP Bearer  | `CRIBLCONTROLPLANE_BEARER_AUTH`  |
 | `client_oauth` | oauth2 | OAuth2 token | `CRIBLCONTROLPLANE_CLIENT_OAUTH` |
 
-To configure authentication on Cribl.Cloud and in hybrid deployments, use the `client_oauth` security scheme. The SDK uses the OAuth credentials that you provide to obtain a Bearer token and refresh the token within its expiration window using the standard OAuth2 flow.
-
-In on-prem deployments, use the `bearer_auth` security scheme. The SDK uses the username/password credentials that you provide to obtain a Bearer token. Automatically refreshing the Bearer token within its expiration window requires a callback function as shown in the [On-Prem Authentication Example](https://github.com/criblio/cribl_control_plane_sdk_python/blob/main/examples/example_onprem_auth.py).
+You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
+```python
+from cribl_control_plane import CriblControlPlane, models
+import os
 
-Set the security scheme through the `security` optional parameter when initializing the SDK client instance. The SDK uses the selected scheme by default to authenticate with the API for all operations that support it.
 
-### Authentication Examples
+with CriblControlPlane(
+    server_url="https://api.example.com",
+    security=models.Security(
+        bearer_auth=os.getenv("CRIBLCONTROLPLANE_BEARER_AUTH", ""),
+    ),
+) as ccp_client:
 
-The [Cribl.Cloud and Hybrid Authentication Example](https://github.com/criblio/cribl_control_plane_sdk_python/blob/main/examples/example_cloud_auth.py) demonstrates how to configure authentication on Cribl.Cloud and in hybrid deployments. To obtain the Client ID and Client Secret you'll need to initialize using the `client_oauth` security schema, follow the [instructions for creating an API Credential](https://docs.cribl.io/cribl-as-code/sdks-auth/#sdks-auth-cloud) in the Cribl as Code documentation.
+    res = ccp_client.lake_datasets.create(lake_id="<id>", id="<id>", accelerated_fields=[
+        "<value 1>",
+        "<value 2>",
+    ], bucket_name="<value>", cache_connection={
+        "accelerated_fields": [
+            "<value 1>",
+            "<value 2>",
+        ],
+        "backfill_status": models.CacheConnectionBackfillStatus.PENDING,
+        "cache_ref": "<value>",
+        "created_at": 7795.06,
+        "lakehouse_connection_type": models.LakehouseConnectionType.CACHE,
+        "migration_query_id": "<id>",
+        "retention_in_days": 1466.58,
+    }, deletion_started_at=8310.58, description="pleased toothbrush long brush smooth swiftly rightfully phooey chapel", format_=models.CriblLakeDatasetFormat.DDSS, http_da_used=True, metrics={
+        "current_size_bytes": 6170.04,
+        "metrics_date": "<value>",
+    }, retention_period_in_days=456.37, search_config={
+        "datatypes": [
+            "<value 1>",
+        ],
+        "metadata": {
+            "earliest": "<value>",
+            "enable_acceleration": True,
+            "field_list": [
+                "<value 1>",
+                "<value 2>",
+            ],
+            "latest_run_info": {
+                "earliest_scanned_time": 4334.7,
+                "finished_at": 6811.22,
+                "latest_scanned_time": 5303.3,
+                "object_count": 9489.04,
+            },
+            "scan_mode": models.ScanMode.DETAILED,
+        },
+    }, storage_location_id="<id>", view_name="<value>")
 
-The [On-Prem Authentication Example](https://github.com/criblio/cribl_control_plane_sdk_python/blob/main/examples/example_onprem_auth.py) demonstrates how to configure authentication in on-prem deployments using your username and password.
+    # Handle response
+    print(res)
 
-<!-- No Authentication [security] -->
+```
+<!-- End Authentication [security] -->
 
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations

{cribl_control_plane-0.4.0 → cribl_control_plane-0.4.0a12}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "cribl-control-plane"
-version = "0.4.0"
+version = "0.4.0a12"
 description = "Python Client SDK Generated by Speakeasy."
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"

{cribl_control_plane-0.4.0 → cribl_control_plane-0.4.0a12}/src/cribl_control_plane/_version.py

@@ -3,12 +3,10 @@
 import importlib.metadata
 
 __title__: str = "cribl-control-plane"
-__version__: str = "0.4.0"
-__openapi_doc_version__: str = "4.15.1-1b453caa"
+__version__: str = "0.4.0a12"
+__openapi_doc_version__: str = "4.15.1-alpha.1764975753193-67dd5070"
 __gen_version__: str = "2.778.0"
-__user_agent__: str = (
-    "speakeasy-sdk/python 0.4.0 2.778.0 4.15.1-1b453caa cribl-control-plane"
-)
+__user_agent__: str = "speakeasy-sdk/python 0.4.0a12 2.778.0 4.15.1-alpha.1764975753193-67dd5070 cribl-control-plane"
 
 try:
     if __package__ is not None:

{cribl_control_plane-0.4.0 → cribl_control_plane-0.4.0a12}/src/cribl_control_plane/models/outputcriblhttp.py

@@ -323,8 +323,6 @@ class OutputCriblHTTPTypedDict(TypedDict):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
     safe_headers: NotRequired[List[str]]
     r"""List of headers that are safe to log in plain text"""
-    throttle_rate_per_sec: NotRequired[str]
-    r"""Rate (in bytes per second) to throttle while writing to an output. Accepts values with multiple-byte units, such as KB, MB, and GB. (Example: 42 MB) Default value of 0 specifies no throttling."""
     response_retry_settings: NotRequired[
         List[OutputCriblHTTPResponseRetrySettingTypedDict]
     ]
@@ -462,11 +460,6 @@ class OutputCriblHTTP(BaseModel):
     ] = None
     r"""List of headers that are safe to log in plain text"""
 
-    throttle_rate_per_sec: Annotated[
-        Optional[str], pydantic.Field(alias="throttleRatePerSec")
-    ] = "0"
-    r"""Rate (in bytes per second) to throttle while writing to an output. Accepts values with multiple-byte units, such as KB, MB, and GB. (Example: 42 MB) Default value of 0 specifies no throttling."""
-
     response_retry_settings: Annotated[
         Optional[List[OutputCriblHTTPResponseRetrySetting]],
         pydantic.Field(alias="responseRetrySettings"),

{cribl_control_plane-0.4.0 → cribl_control_plane-0.4.0a12}/src/cribl_control_plane/models/outputnetflow.py

@@ -43,6 +43,8 @@ class OutputNetflowTypedDict(TypedDict):
     r"""Tags for filtering and grouping in @{product}"""
     dns_resolve_period_sec: NotRequired[float]
     r"""How often to resolve the destination hostname to an IP address. Ignored if all destinations are IP addresses. A value of 0 means every datagram sent will incur a DNS lookup."""
+    enable_ip_spoofing: NotRequired[bool]
+    r"""Send NetFlow 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."""
     description: NotRequired[str]
 
 
@@ -74,4 +76,9 @@ class OutputNetflow(BaseModel):
     ] = 0
     r"""How often to resolve the destination hostname to an IP address. Ignored if all destinations are IP addresses. A value of 0 means every datagram sent will incur a DNS lookup."""
 
+    enable_ip_spoofing: Annotated[
+        Optional[bool], pydantic.Field(alias="enableIpSpoofing")
+    ] = False
+    r"""Send NetFlow 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."""
+
     description: Optional[str] = None