cribl-control-plane 0.0.39__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/inputzscalerhec.py

@@ -1,9 +1,13 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from cribl_control_plane import models, 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 import field_serializer
+from pydantic.functional_validators import PlainValidator
 from typing import Any, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -23,20 +27,32 @@ class InputZscalerHecConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputZscalerHecMode(str, Enum):
+class InputZscalerHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
-class InputZscalerHecCompression(str, Enum):
+class InputZscalerHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputZscalerHecPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputZscalerHecPqControls(BaseModel):
+    pass
+
+
 class InputZscalerHecPqTypedDict(TypedDict):
     mode: NotRequired[InputZscalerHecMode]
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
@@ -52,10 +68,13 @@ class InputZscalerHecPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputZscalerHecCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputZscalerHecPqControlsTypedDict]
 
 
 class InputZscalerHecPq(BaseModel):
-    mode: Optional[InputZscalerHecMode] = InputZscalerHecMode.ALWAYS
+    mode: Annotated[
+        Optional[InputZscalerHecMode], PlainValidator(validate_open_enum(False))
+    ] = InputZscalerHecMode.ALWAYS
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
     max_buffer_size: Annotated[
@@ -79,11 +98,35 @@ class InputZscalerHecPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputZscalerHecCompression] = InputZscalerHecCompression.NONE
+    compress: Annotated[
+        Optional[InputZscalerHecCompression], PlainValidator(validate_open_enum(False))
+    ] = InputZscalerHecCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputZscalerHecPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputZscalerHecAuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputZscalerHecMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputZscalerHecCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputZscalerHecAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
@@ -104,10 +147,12 @@ class InputZscalerHecAuthTokenMetadatum(BaseModel):
 
 
 class InputZscalerHecAuthTokenTypedDict(TypedDict):
-    token: Any
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
     auth_type: NotRequired[InputZscalerHecAuthenticationMethod]
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
-    token_secret: NotRequired[Any]
+    token_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
     enabled: NotRequired[bool]
     description: NotRequired[str]
     allowed_indexes_at_token: NotRequired[List[str]]
@@ -117,14 +162,20 @@ class InputZscalerHecAuthTokenTypedDict(TypedDict):
 
 
 class InputZscalerHecAuthToken(BaseModel):
-    token: Any
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
 
     auth_type: Annotated[
-        Optional[InputZscalerHecAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputZscalerHecAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputZscalerHecAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
-    token_secret: Annotated[Optional[Any], pydantic.Field(alias="tokenSecret")] = None
+    token_secret: Annotated[Optional[str], pydantic.Field(alias="tokenSecret")] = None
+    r"""Select or create a stored text secret"""
 
     enabled: Optional[bool] = True
 
@@ -138,15 +189,24 @@ class InputZscalerHecAuthToken(BaseModel):
     metadata: Optional[List[InputZscalerHecAuthTokenMetadatum]] = None
     r"""Fields to add to events referencing this token"""
 
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputZscalerHecAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputZscalerHecMinimumTLSVersion(str, Enum):
+class InputZscalerHecMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputZscalerHecMaximumTLSVersion(str, Enum):
+class InputZscalerHecMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -155,6 +215,12 @@ class InputZscalerHecMaximumTLSVersion(str, Enum):
 
 class InputZscalerHecTLSSettingsServerSideTypedDict(TypedDict):
     disabled: NotRequired[bool]
+    request_cert: NotRequired[bool]
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+    reject_unauthorized: NotRequired[bool]
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+    common_name_regex: NotRequired[str]
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
     certificate_name: NotRequired[str]
     r"""The name of the predefined certificate"""
     priv_key_path: NotRequired[str]
@@ -165,10 +231,6 @@ class InputZscalerHecTLSSettingsServerSideTypedDict(TypedDict):
     r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
     ca_path: NotRequired[str]
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
-    request_cert: NotRequired[bool]
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-    reject_unauthorized: NotRequired[Any]
-    common_name_regex: NotRequired[Any]
     min_version: NotRequired[InputZscalerHecMinimumTLSVersion]
     max_version: NotRequired[InputZscalerHecMaximumTLSVersion]
 
@@ -176,6 +238,19 @@ class InputZscalerHecTLSSettingsServerSideTypedDict(TypedDict):
 class InputZscalerHecTLSSettingsServerSide(BaseModel):
     disabled: Optional[bool] = True
 
+    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+
+    reject_unauthorized: Annotated[
+        Optional[bool], pydantic.Field(alias="rejectUnauthorized")
+    ] = True
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+
+    common_name_regex: Annotated[
+        Optional[str], pydantic.Field(alias="commonNameRegex")
+    ] = "/.*/"
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
+
     certificate_name: Annotated[
         Optional[str], pydantic.Field(alias="certificateName")
     ] = None
@@ -193,25 +268,40 @@ class InputZscalerHecTLSSettingsServerSide(BaseModel):
     ca_path: Annotated[Optional[str], pydantic.Field(alias="caPath")] = None
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
 
-    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-
-    reject_unauthorized: Annotated[
-        Optional[Any], pydantic.Field(alias="rejectUnauthorized")
-    ] = None
-
-    common_name_regex: Annotated[
-        Optional[Any], pydantic.Field(alias="commonNameRegex")
-    ] = None
-
     min_version: Annotated[
-        Optional[InputZscalerHecMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputZscalerHecMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputZscalerHecMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputZscalerHecMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputZscalerHecMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputZscalerHecMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputZscalerHecMetadatumTypedDict(TypedDict):
     name: str

cribl_control_plane/models/jobinfo.py

@@ -0,0 +1,34 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .jobstatus import JobStatus, JobStatusTypedDict
+from .runnablejob import RunnableJob, RunnableJobTypedDict
+from cribl_control_plane.types import BaseModel
+from typing import Dict, Optional, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+StatsTypedDict = TypeAliasType("StatsTypedDict", Union[float, Dict[str, float]])
+
+
+Stats = TypeAliasType("Stats", Union[float, Dict[str, float]])
+
+
+class JobInfoTypedDict(TypedDict):
+    args: RunnableJobTypedDict
+    id: str
+    stats: Dict[str, StatsTypedDict]
+    status: JobStatusTypedDict
+    keep: NotRequired[bool]
+
+
+class JobInfo(BaseModel):
+    args: RunnableJob
+
+    id: str
+
+    stats: Dict[str, Stats]
+
+    status: JobStatus
+
+    keep: Optional[bool] = None

cribl_control_plane/models/jobstatus.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane import models, utils
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
+from enum import Enum
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class State(int, Enum, metaclass=utils.OpenEnumMeta):
+    r"""State of the Job"""
+
+    INITIALIZING = 0
+    PENDING = 1
+    RUNNING = 2
+    PAUSED = 3
+    CANCELLED = 4
+    FINISHED = 5
+    FAILED = 6
+    ORPHANED = 7
+    UNKNOWN = 8
+    LENGTH = 9
+
+
+class JobStatusTypedDict(TypedDict):
+    state: State
+    r"""State of the Job"""
+    reason: NotRequired[Dict[str, Any]]
+
+
+class JobStatus(BaseModel):
+    state: Annotated[State, PlainValidator(validate_open_enum(True))]
+    r"""State of the Job"""
+
+    reason: Optional[Dict[str, Any]] = None
+
+    @field_serializer("state")
+    def serialize_state(self, value):
+        if isinstance(value, str):
+            try:
+                return models.State(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/lakedatasetmetrics.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class LakeDatasetMetricsTypedDict(TypedDict):
+    current_size_bytes: float
+    metrics_date: str
+
+
+class LakeDatasetMetrics(BaseModel):
+    current_size_bytes: Annotated[float, pydantic.Field(alias="currentSizeBytes")]
+
+    metrics_date: Annotated[str, pydantic.Field(alias="metricsDate")]

cribl_control_plane/models/lakehouseconnectiontype.py

@@ -1,9 +1,10 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from cribl_control_plane import utils
 from enum import Enum
 
 
-class LakehouseConnectionType(str, Enum):
+class LakehouseConnectionType(str, Enum, metaclass=utils.OpenEnumMeta):
     CACHE = "cache"
     ZERO_POINT = "zeroPoint"

cribl_control_plane/models/listconfiggroupbyproductop.py

@@ -1,15 +1,18 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .configgroup import ConfigGroup, ConfigGroupTypedDict
 from .productscore import ProductsCore
+from cribl_control_plane import models
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import (
     FieldMetadata,
     PathParamMetadata,
     QueryParamMetadata,
+    validate_open_enum,
 )
-from typing import List, Optional
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -22,7 +25,7 @@ class ListConfigGroupByProductRequestTypedDict(TypedDict):
 
 class ListConfigGroupByProductRequest(BaseModel):
     product: Annotated[
-        ProductsCore,
+        Annotated[ProductsCore, PlainValidator(validate_open_enum(False))],
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
     r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
@@ -33,19 +36,11 @@ class ListConfigGroupByProductRequest(BaseModel):
     ] = None
     r"""Comma-separated list of additional properties to include in the response. Available values are <code>git.commit</code>, <code>git.localChanges</code>, and <code>git.log</code>."""
 
-
-class ListConfigGroupByProductResponseTypedDict(TypedDict):
-    r"""a list of ConfigGroup objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[ConfigGroupTypedDict]]
-
-
-class ListConfigGroupByProductResponse(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
+    @field_serializer("product")
+    def serialize_product(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ProductsCore(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/listmasterworkerentryop.py

@@ -1,11 +1,10 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .masterworkerentry import MasterWorkerEntry, MasterWorkerEntryTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
 import pydantic
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -63,20 +62,3 @@ class ListMasterWorkerEntryRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
     r"""Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches."""
-
-
-class ListMasterWorkerEntryResponseTypedDict(TypedDict):
-    r"""a list of MasterWorkerEntry objects"""
-
-    count: NotRequired[int]
-    r"""number of items present in the items array"""
-    items: NotRequired[List[MasterWorkerEntryTypedDict]]
-
-
-class ListMasterWorkerEntryResponse(BaseModel):
-    r"""a list of MasterWorkerEntry objects"""
-
-    count: Optional[int] = None
-    r"""number of items present in the items array"""
-
-    items: Optional[List[MasterWorkerEntry]] = 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/masterworkerentry.py

@@ -4,22 +4,18 @@ from __future__ import annotations
 from .heartbeatmetadata import HeartbeatMetadata, HeartbeatMetadataTypedDict
 from .nodeprovidedinfo import NodeProvidedInfo, NodeProvidedInfoTypedDict
 from .nodeupgradestatus import NodeUpgradeStatus, NodeUpgradeStatusTypedDict
+from cribl_control_plane import models, utils
 from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
 from enum import Enum
 import pydantic
-from typing import Optional
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Any, Dict, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class LastMetricsTypedDict(TypedDict):
-    pass
-
-
-class LastMetrics(BaseModel):
-    pass
-
-
-class MasterWorkerEntryType(str, Enum):
+class MasterWorkerEntryType(str, Enum, metaclass=utils.OpenEnumMeta):
     INFO = "info"
     REQ = "req"
     RESP = "resp"
@@ -42,7 +38,7 @@ class MasterWorkerEntryTypedDict(TypedDict):
     worker_processes: float
     deployable: NotRequired[bool]
     disconnected: NotRequired[bool]
-    last_metrics: NotRequired[LastMetricsTypedDict]
+    last_metrics: NotRequired[Dict[str, Any]]
     metadata: NotRequired[HeartbeatMetadataTypedDict]
     node_upgrade_status: NotRequired[NodeUpgradeStatusTypedDict]
     status: NotRequired[str]
@@ -68,7 +64,7 @@ class MasterWorkerEntry(BaseModel):
     disconnected: Optional[bool] = None
 
     last_metrics: Annotated[
-        Optional[LastMetrics], pydantic.Field(alias="lastMetrics")
+        Optional[Dict[str, Any]], pydantic.Field(alias="lastMetrics")
     ] = None
 
     metadata: Optional[HeartbeatMetadata] = None
@@ -79,6 +75,17 @@ class MasterWorkerEntry(BaseModel):
 
     status: Optional[str] = None
 
-    type: Optional[MasterWorkerEntryType] = None
+    type: Annotated[
+        Optional[MasterWorkerEntryType], PlainValidator(validate_open_enum(False))
+    ] = None
 
     workers: Optional[MasterWorkerEntryWorkers] = None
+
+    @field_serializer("type")
+    def serialize_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.MasterWorkerEntryType(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/nodeactiveupgradestatus.py

@@ -1,10 +1,11 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from cribl_control_plane import utils
 from enum import Enum
 
 
-class NodeActiveUpgradeStatus(int, Enum):
+class NodeActiveUpgradeStatus(int, Enum, metaclass=utils.OpenEnumMeta):
     ZERO = 0
     ONE = 1
     TWO = 2

cribl_control_plane/models/nodefailedupgradestatus.py

@@ -1,9 +1,10 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from cribl_control_plane import utils
 from enum import Enum
 
 
-class NodeFailedUpgradeStatus(int, Enum):
+class NodeFailedUpgradeStatus(int, Enum, metaclass=utils.OpenEnumMeta):
     ZERO = 0
     ONE = 1