cribl-control-plane 0.2.1rc1__py3-none-any.whl → 0.2.1rc2__py3-none-any.whl

cribl_control_plane/models/groupcreaterequest.py

@@ -0,0 +1,152 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .commit import Commit, CommitTypedDict
+from .configgroupcloud import ConfigGroupCloud, ConfigGroupCloudTypedDict
+from .configgrouplookups import ConfigGroupLookups, ConfigGroupLookupsTypedDict
+from cribl_control_plane import utils
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
+from enum import Enum
+import pydantic
+from pydantic.functional_validators import PlainValidator
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GroupCreateRequestEstimatedIngestRate(int, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Maximum expected volume of data ingested by the @{group}. (This setting is available only on @{group}s consisting of Cribl-managed Cribl.Cloud @{node}s.)"""
+
+    # 12 MB/sec
+    RATE12_MB_PER_SEC = 1024
+    # 24 MB/sec
+    RATE24_MB_PER_SEC = 2048
+    # 36 MB/sec
+    RATE36_MB_PER_SEC = 3072
+    # 48 MB/sec
+    RATE48_MB_PER_SEC = 4096
+    # 60 MB/sec
+    RATE60_MB_PER_SEC = 5120
+    # 84 MB/sec
+    RATE84_MB_PER_SEC = 7168
+    # 120 MB/sec
+    RATE120_MB_PER_SEC = 10240
+    # 156 MB/sec
+    RATE156_MB_PER_SEC = 13312
+    # 180 MB/sec
+    RATE180_MB_PER_SEC = 15360
+
+
+class GroupCreateRequestGitTypedDict(TypedDict):
+    commit: NotRequired[str]
+    local_changes: NotRequired[float]
+    log: NotRequired[List[CommitTypedDict]]
+
+
+class GroupCreateRequestGit(BaseModel):
+    commit: Optional[str] = None
+
+    local_changes: Annotated[Optional[float], pydantic.Field(alias="localChanges")] = (
+        None
+    )
+
+    log: Optional[List[Commit]] = None
+
+
+class GroupCreateRequestType(str, Enum, metaclass=utils.OpenEnumMeta):
+    LAKE_ACCESS = "lake_access"
+
+
+class GroupCreateRequestTypedDict(TypedDict):
+    id: str
+    cloud: NotRequired[ConfigGroupCloudTypedDict]
+    deploying_worker_count: NotRequired[float]
+    description: NotRequired[str]
+    estimated_ingest_rate: NotRequired[GroupCreateRequestEstimatedIngestRate]
+    r"""Maximum expected volume of data ingested by the @{group}. (This setting is available only on @{group}s consisting of Cribl-managed Cribl.Cloud @{node}s.)"""
+    git: NotRequired[GroupCreateRequestGitTypedDict]
+    incompatible_worker_count: NotRequired[float]
+    inherits: NotRequired[str]
+    is_fleet: NotRequired[bool]
+    is_search: NotRequired[bool]
+    lookup_deployments: NotRequired[List[ConfigGroupLookupsTypedDict]]
+    max_worker_age: NotRequired[str]
+    name: NotRequired[str]
+    on_prem: NotRequired[bool]
+    provisioned: NotRequired[bool]
+    source_group_id: NotRequired[str]
+    streamtags: NotRequired[List[str]]
+    tags: NotRequired[str]
+    type: NotRequired[GroupCreateRequestType]
+    upgrade_version: NotRequired[str]
+    worker_count: NotRequired[float]
+    worker_remote_access: NotRequired[bool]
+
+
+class GroupCreateRequest(BaseModel):
+    id: str
+
+    cloud: Optional[ConfigGroupCloud] = None
+
+    deploying_worker_count: Annotated[
+        Optional[float], pydantic.Field(alias="deployingWorkerCount")
+    ] = None
+
+    description: Optional[str] = None
+
+    estimated_ingest_rate: Annotated[
+        Annotated[
+            Optional[GroupCreateRequestEstimatedIngestRate],
+            PlainValidator(validate_open_enum(True)),
+        ],
+        pydantic.Field(alias="estimatedIngestRate"),
+    ] = None
+    r"""Maximum expected volume of data ingested by the @{group}. (This setting is available only on @{group}s consisting of Cribl-managed Cribl.Cloud @{node}s.)"""
+
+    git: Optional[GroupCreateRequestGit] = None
+
+    incompatible_worker_count: Annotated[
+        Optional[float], pydantic.Field(alias="incompatibleWorkerCount")
+    ] = None
+
+    inherits: Optional[str] = None
+
+    is_fleet: Annotated[Optional[bool], pydantic.Field(alias="isFleet")] = None
+
+    is_search: Annotated[Optional[bool], pydantic.Field(alias="isSearch")] = None
+
+    lookup_deployments: Annotated[
+        Optional[List[ConfigGroupLookups]], pydantic.Field(alias="lookupDeployments")
+    ] = None
+
+    max_worker_age: Annotated[Optional[str], pydantic.Field(alias="maxWorkerAge")] = (
+        None
+    )
+
+    name: Optional[str] = None
+
+    on_prem: Annotated[Optional[bool], pydantic.Field(alias="onPrem")] = None
+
+    provisioned: Optional[bool] = None
+
+    source_group_id: Annotated[Optional[str], pydantic.Field(alias="sourceGroupId")] = (
+        None
+    )
+
+    streamtags: Optional[List[str]] = None
+
+    tags: Optional[str] = None
+
+    type: Annotated[
+        Optional[GroupCreateRequestType], PlainValidator(validate_open_enum(False))
+    ] = None
+
+    upgrade_version: Annotated[
+        Optional[str], pydantic.Field(alias="upgradeVersion")
+    ] = None
+
+    worker_count: Annotated[Optional[float], pydantic.Field(alias="workerCount")] = None
+
+    worker_remote_access: Annotated[
+        Optional[bool], pydantic.Field(alias="workerRemoteAccess")
+    ] = None

cribl_control_plane/models/{healthstatus.py → healthserverstatus.py}

@@ -12,25 +12,25 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class Role(str, Enum, metaclass=utils.OpenEnumMeta):
-    PRIMARY = "primary"
     STANDBY = "standby"
+    PRIMARY = "primary"
 
 
 class Status(str, Enum, metaclass=utils.OpenEnumMeta):
-    HEALTHY = "healthy"
     SHUTTING_DOWN = "shutting down"
+    HEALTHY = "healthy"
     STANDBY = "standby"
 
 
-class HealthStatusTypedDict(TypedDict):
-    status: Status
+class HealthServerStatusTypedDict(TypedDict):
     start_time: float
+    status: Status
     role: NotRequired[Role]
 
 
-class HealthStatus(BaseModel):
-    status: Annotated[Status, PlainValidator(validate_open_enum(False))]
-
+class HealthServerStatus(BaseModel):
     start_time: Annotated[float, pydantic.Field(alias="startTime")]
 
+    status: Annotated[Status, PlainValidator(validate_open_enum(False))]
+
     role: Annotated[Optional[Role], PlainValidator(validate_open_enum(False))] = None

cribl_control_plane/models/logininfo.py

@@ -6,11 +6,11 @@ from typing_extensions import TypedDict
 
 
 class LoginInfoTypedDict(TypedDict):
-    username: str
     password: str
+    username: str
 
 
 class LoginInfo(BaseModel):
-    username: str
-
     password: str
+
+    username: str

cribl_control_plane/models/pipeline.py

@@ -26,7 +26,7 @@ class PipelineGroups(BaseModel):
     r"""Whether this group is disabled"""
 
 
-class PipelineConfTypedDict(TypedDict):
+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]
@@ -39,7 +39,7 @@ class PipelineConfTypedDict(TypedDict):
     groups: NotRequired[Dict[str, PipelineGroupsTypedDict]]
 
 
-class PipelineConf(BaseModel):
+class Conf(BaseModel):
     async_func_timeout: Annotated[
         Optional[int], pydantic.Field(alias="asyncFuncTimeout")
     ] = None
@@ -61,10 +61,10 @@ class PipelineConf(BaseModel):
 
 class PipelineTypedDict(TypedDict):
     id: str
-    conf: PipelineConfTypedDict
+    conf: ConfTypedDict
 
 
 class Pipeline(BaseModel):
     id: str
 
-    conf: PipelineConf
+    conf: Conf

cribl_control_plane/pipelines.py

@@ -176,7 +176,7 @@ class Pipelines(BaseSDK):
         self,
         *,
         id: str,
-        conf: Union[models.PipelineConf, models.PipelineConfTypedDict],
+        conf: Union[models.Conf, models.ConfTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -205,7 +205,7 @@ class Pipelines(BaseSDK):
 
         request = models.Pipeline(
             id=id,
-            conf=utils.get_pydantic_model(conf, models.PipelineConf),
+            conf=utils.get_pydantic_model(conf, models.Conf),
         )
 
         req = self._build_request(
@@ -269,7 +269,7 @@ class Pipelines(BaseSDK):
         self,
         *,
         id: str,
-        conf: Union[models.PipelineConf, models.PipelineConfTypedDict],
+        conf: Union[models.Conf, models.ConfTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -298,7 +298,7 @@ class Pipelines(BaseSDK):
 
         request = models.Pipeline(
             id=id,
-            conf=utils.get_pydantic_model(conf, models.PipelineConf),
+            conf=utils.get_pydantic_model(conf, models.Conf),
         )
 
         req = self._build_request_async(
@@ -537,7 +537,7 @@ class Pipelines(BaseSDK):
         *,
         id_param: str,
         id: str,
-        conf: Union[models.PipelineConf, models.PipelineConfTypedDict],
+        conf: Union[models.Conf, models.ConfTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -569,7 +569,7 @@ class Pipelines(BaseSDK):
             id_param=id_param,
             pipeline=models.Pipeline(
                 id=id,
-                conf=utils.get_pydantic_model(conf, models.PipelineConf),
+                conf=utils.get_pydantic_model(conf, models.Conf),
             ),
         )
 
@@ -635,7 +635,7 @@ class Pipelines(BaseSDK):
         *,
         id_param: str,
         id: str,
-        conf: Union[models.PipelineConf, models.PipelineConfTypedDict],
+        conf: Union[models.Conf, models.ConfTypedDict],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -667,7 +667,7 @@ class Pipelines(BaseSDK):
             id_param=id_param,
             pipeline=models.Pipeline(
                 id=id,
-                conf=utils.get_pydantic_model(conf, models.PipelineConf),
+                conf=utils.get_pydantic_model(conf, models.Conf),
             ),
         )
 

cribl_control_plane/routes_sdk.py

@@ -584,11 +584,11 @@ class RoutesSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateRoutesAppendByIDResponse:
-        r"""Append a Route to the end of the Routing table
+        r"""Add a Route to the end of the Routing table
 
-        Append a Route to the end of the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to append, in the request body. Cribl removes any omitted Routes and fields in the Routing table when appending the Route.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
+        Add a Route to the end of the specified Routing table.
 
-        :param id: The <code>id</code> of the Routing table to append the Route to. The supported value is <code>default</code>.
+        :param id: The <code>id</code> of the Routing table to add the Route to. The supported value is <code>default</code>.
         :param request_body: RouteDefinitions object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -679,11 +679,11 @@ class RoutesSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateRoutesAppendByIDResponse:
-        r"""Append a Route to the end of the Routing table
+        r"""Add a Route to the end of the Routing table
 
-        Append a Route to the end of the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to append, in the request body. Cribl removes any omitted Routes and fields in the Routing table when appending the Route.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
+        Add a Route to the end of the specified Routing table.
 
-        :param id: The <code>id</code> of the Routing table to append the Route to. The supported value is <code>default</code>.
+        :param id: The <code>id</code> of the Routing table to add the Route to. The supported value is <code>default</code>.
         :param request_body: RouteDefinitions object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method

cribl_control_plane/tokens.py

@@ -5,15 +5,15 @@ from cribl_control_plane import errors, models, utils
 from cribl_control_plane._hooks import HookContext
 from cribl_control_plane.types import OptionalNullable, UNSET
 from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_response
-from typing import Mapping, Optional
+from typing import Any, Mapping, Optional
 
 
 class Tokens(BaseSDK):
     def get(
         self,
         *,
-        username: str,
         password: str,
+        username: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -21,10 +21,10 @@ class Tokens(BaseSDK):
     ) -> models.AuthToken:
         r"""Log in and fetch an authentication token
 
-        This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+        This endpoint is unavailable on Cribl.Cloud.Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
 
-        :param username:
         :param password:
+        :param username:
         :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
@@ -41,8 +41,8 @@ class Tokens(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.LoginInfo(
-            username=username,
             password=password,
+            username=username,
         )
 
         req = self._build_request(
@@ -75,18 +75,22 @@ class Tokens(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="login",
+                operation_id="createAuthLogin",
                 oauth2_scopes=[],
                 security_source=None,
             ),
             request=req,
-            error_status_codes=["401", "403", "429", "4XX", "5XX"],
+            error_status_codes=["401", "429", "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.AuthToken, http_res)
-        if utils.match_response(http_res, ["401", "403", "429", "4XX"], "*"):
+        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", "429", "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", "*"):
@@ -98,8 +102,8 @@ class Tokens(BaseSDK):
     async def get_async(
         self,
         *,
-        username: str,
         password: str,
+        username: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -107,10 +111,10 @@ class Tokens(BaseSDK):
     ) -> models.AuthToken:
         r"""Log in and fetch an authentication token
 
-        This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+        This endpoint is unavailable on Cribl.Cloud.Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
 
-        :param username:
         :param password:
+        :param username:
         :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
@@ -127,8 +131,8 @@ class Tokens(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.LoginInfo(
-            username=username,
             password=password,
+            username=username,
         )
 
         req = self._build_request_async(
@@ -161,18 +165,22 @@ class Tokens(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="login",
+                operation_id="createAuthLogin",
                 oauth2_scopes=[],
                 security_source=None,
             ),
             request=req,
-            error_status_codes=["401", "403", "429", "4XX", "5XX"],
+            error_status_codes=["401", "429", "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.AuthToken, http_res)
-        if utils.match_response(http_res, ["401", "403", "429", "4XX"], "*"):
+        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", "429", "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", "*"):

{cribl_control_plane-0.2.1rc1.dist-info → cribl_control_plane-0.2.1rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cribl-control-plane
-Version: 0.2.1rc1
+Version: 0.2.1rc2
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -359,15 +359,6 @@ with CriblControlPlane(
 
 * [get](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/configsversions/README.md#get) - Get the configuration version for a Worker Group or Edge Fleet
 
-#### [groups.mappings](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/mappings/README.md)
-
-* [activate](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/mappings/README.md#activate) - Set a Mapping Ruleset as the active configuration for the specified Cribl product
-* [create](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/mappings/README.md#create) - Create a new Mapping Ruleset for the specified Cribl product
-* [list](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/mappings/README.md#list) - List all Mapping Rulesets for the specified Cribl product
-* [delete](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/mappings/README.md#delete) - Delete the specified Mapping Ruleset from the Worker Group or Edge Fleet
-* [get](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/mappings/README.md#get) - Retrieve a Specific Mapping Ruleset
-* [update](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/mappings/README.md#update) - Update an existing Mapping Ruleset for a Worker Group or Edge Fleet
-
 ### [health](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/health/README.md)
 
 * [get](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/health/README.md#get) - Retrieve health status of the server
@@ -411,7 +402,7 @@ with CriblControlPlane(
 * [list](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/routessdk/README.md#list) - List all Routes
 * [get](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/routessdk/README.md#get) - Get a Routing table
 * [update](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/routessdk/README.md#update) - Update a Route
-* [append](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/routessdk/README.md#append) - Append a Route to the end of the Routing table
+* [append](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/routessdk/README.md#append) - Add a Route to the end of the Routing table
 
 ### [sources](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/docs/sdks/sources/README.md)
 
@@ -687,7 +678,7 @@ with CriblControlPlane(
 ### Error Classes
 **Primary errors:**
 * [`CriblControlPlaneError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/criblcontrolplaneerror.py): The base class for HTTP error responses.
-  * [`Error`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/error.py): Unexpected error. Status code `500`. *
+  * [`Error`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/error.py): Unexpected error. Status code `500`.
 
 <details><summary>Less common errors (6)</summary>
 
@@ -700,7 +691,7 @@ with CriblControlPlane(
 
 
 **Inherit from [`CriblControlPlaneError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/criblcontrolplaneerror.py)**:
-* [`HealthStatusError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/healthstatuserror.py): Healthy status. Status code `420`. Applicable to 1 of 69 methods.*
+* [`HealthServerStatusError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/healthserverstatuserror.py): Healthy status. Status code `420`. Applicable to 1 of 63 methods.*
 * [`ResponseValidationError`](https://github.com/criblio/cribl_control_plane_sdk_python/blob/master/./src/cribl_control_plane/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>