cribl-control-plane 0.0.21__py3-none-any.whl → 0.4.0b23__py3-none-any.whl

cribl_control_plane/models/inputsystemmetrics.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 List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -23,20 +27,32 @@ class InputSystemMetricsConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSystemMetricsPqMode(str, Enum):
+class InputSystemMetricsPqMode(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 InputSystemMetricsCompression(str, Enum):
+class InputSystemMetricsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSystemMetricsPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSystemMetricsPqControls(BaseModel):
+    pass
+
+
 class InputSystemMetricsPqTypedDict(TypedDict):
     mode: NotRequired[InputSystemMetricsPqMode]
     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 InputSystemMetricsPqTypedDict(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[InputSystemMetricsCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSystemMetricsPqControlsTypedDict]
 
 
 class InputSystemMetricsPq(BaseModel):
-    mode: Optional[InputSystemMetricsPqMode] = InputSystemMetricsPqMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSystemMetricsPqMode], PlainValidator(validate_open_enum(False))
+    ] = InputSystemMetricsPqMode.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,27 +98,58 @@ class InputSystemMetricsPq(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[InputSystemMetricsCompression] = (
-        InputSystemMetricsCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputSystemMetricsCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSystemMetricsCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSystemMetricsPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSystemMetricsHostMode(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsPqMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSystemMetricsHostMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select level of detail for host metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
-class InputSystemMetricsSystemMode(str, Enum):
+class InputSystemMetricsSystemMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for system metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -111,19 +161,35 @@ class InputSystemMetricsSystemTypedDict(TypedDict):
 
 
 class InputSystemMetricsSystem(BaseModel):
-    mode: Optional[InputSystemMetricsSystemMode] = InputSystemMetricsSystemMode.BASIC
+    mode: Annotated[
+        Optional[InputSystemMetricsSystemMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSystemMetricsSystemMode.BASIC
     r"""Select the level of detail for system metrics"""
 
     processes: Optional[bool] = False
     r"""Generate metrics for the numbers of processes in various states"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsSystemMode(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputSystemMetricsCPUMode(str, Enum):
+class InputSystemMetricsCPUMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for CPU metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -139,7 +205,9 @@ class InputSystemMetricsCPUTypedDict(TypedDict):
 
 
 class InputSystemMetricsCPU(BaseModel):
-    mode: Optional[InputSystemMetricsCPUMode] = InputSystemMetricsCPUMode.BASIC
+    mode: Annotated[
+        Optional[InputSystemMetricsCPUMode], PlainValidator(validate_open_enum(False))
+    ] = InputSystemMetricsCPUMode.BASIC
     r"""Select the level of detail for CPU metrics"""
 
     per_cpu: Annotated[Optional[bool], pydantic.Field(alias="perCpu")] = False
@@ -151,13 +219,26 @@ class InputSystemMetricsCPU(BaseModel):
     time: Optional[bool] = False
     r"""Generate raw, monotonic CPU time counters"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsCPUMode(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputSystemMetricsMemoryMode(str, Enum):
+class InputSystemMetricsMemoryMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for memory metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -169,37 +250,64 @@ class InputSystemMetricsMemoryTypedDict(TypedDict):
 
 
 class InputSystemMetricsMemory(BaseModel):
-    mode: Optional[InputSystemMetricsMemoryMode] = InputSystemMetricsMemoryMode.BASIC
+    mode: Annotated[
+        Optional[InputSystemMetricsMemoryMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSystemMetricsMemoryMode.BASIC
     r"""Select the level of detail for memory metrics"""
 
     detail: Optional[bool] = False
     r"""Generate metrics for all memory states"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsMemoryMode(value)
+            except ValueError:
+                return value
+        return value
 
-class InputSystemMetricsNetworkMode(str, Enum):
+
+class InputSystemMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for network metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
 class InputSystemMetricsNetworkTypedDict(TypedDict):
     mode: NotRequired[InputSystemMetricsNetworkMode]
     r"""Select the level of detail for network metrics"""
+    detail: NotRequired[bool]
+    r"""Generate full network metrics"""
+    protocols: NotRequired[bool]
+    r"""Generate protocol metrics for ICMP, ICMPMsg, IP, TCP, UDP and UDPLite"""
     devices: NotRequired[List[str]]
     r"""Network interfaces to include/exclude. Examples: eth0, !lo. All interfaces are included if this list is empty."""
     per_interface: NotRequired[bool]
     r"""Generate separate metrics for each interface"""
-    detail: NotRequired[bool]
-    r"""Generate full network metrics"""
 
 
 class InputSystemMetricsNetwork(BaseModel):
-    mode: Optional[InputSystemMetricsNetworkMode] = InputSystemMetricsNetworkMode.BASIC
+    mode: Annotated[
+        Optional[InputSystemMetricsNetworkMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSystemMetricsNetworkMode.BASIC
     r"""Select the level of detail for network metrics"""
 
+    detail: Optional[bool] = False
+    r"""Generate full network metrics"""
+
+    protocols: Optional[bool] = False
+    r"""Generate protocol metrics for ICMP, ICMPMsg, IP, TCP, UDP and UDPLite"""
+
     devices: Optional[List[str]] = None
     r"""Network interfaces to include/exclude. Examples: eth0, !lo. All interfaces are included if this list is empty."""
 
@@ -208,22 +316,36 @@ class InputSystemMetricsNetwork(BaseModel):
     )
     r"""Generate separate metrics for each interface"""
 
-    detail: Optional[bool] = False
-    r"""Generate full network metrics"""
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsNetworkMode(value)
+            except ValueError:
+                return value
+        return value
 
 
-class InputSystemMetricsDiskMode(str, Enum):
+class InputSystemMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for disk metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
 class InputSystemMetricsDiskTypedDict(TypedDict):
     mode: NotRequired[InputSystemMetricsDiskMode]
     r"""Select the level of detail for disk metrics"""
+    detail: NotRequired[bool]
+    r"""Generate full disk metrics"""
+    inodes: NotRequired[bool]
+    r"""Generate filesystem inode metrics"""
     devices: NotRequired[List[str]]
     r"""Block devices to include/exclude. Examples: sda*, !loop*. Wildcards and ! (not) operators are supported. All devices are included if this list is empty."""
     mountpoints: NotRequired[List[str]]
@@ -232,14 +354,20 @@ class InputSystemMetricsDiskTypedDict(TypedDict):
     r"""Filesystem types to include/exclude. Examples: ext4, !*tmpfs, !squashfs. Wildcards and ! (not) operators are supported. All types are included if this list is empty."""
     per_device: NotRequired[bool]
     r"""Generate separate metrics for each device"""
-    detail: NotRequired[bool]
-    r"""Generate full disk metrics"""
 
 
 class InputSystemMetricsDisk(BaseModel):
-    mode: Optional[InputSystemMetricsDiskMode] = InputSystemMetricsDiskMode.BASIC
+    mode: Annotated[
+        Optional[InputSystemMetricsDiskMode], PlainValidator(validate_open_enum(False))
+    ] = InputSystemMetricsDiskMode.BASIC
     r"""Select the level of detail for disk metrics"""
 
+    detail: Optional[bool] = False
+    r"""Generate full disk metrics"""
+
+    inodes: Optional[bool] = False
+    r"""Generate filesystem inode metrics"""
+
     devices: Optional[List[str]] = None
     r"""Block devices to include/exclude. Examples: sda*, !loop*. Wildcards and ! (not) operators are supported. All devices are included if this list is empty."""
 
@@ -252,8 +380,14 @@ class InputSystemMetricsDisk(BaseModel):
     per_device: Annotated[Optional[bool], pydantic.Field(alias="perDevice")] = False
     r"""Generate separate metrics for each device"""
 
-    detail: Optional[bool] = False
-    r"""Generate full disk metrics"""
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsDiskMode(value)
+            except ValueError:
+                return value
+        return value
 
 
 class InputSystemMetricsCustomTypedDict(TypedDict):
@@ -283,11 +417,22 @@ class InputSystemMetricsHostTypedDict(TypedDict):
 
 
 class InputSystemMetricsHost(BaseModel):
-    mode: Optional[InputSystemMetricsHostMode] = InputSystemMetricsHostMode.BASIC
+    mode: Annotated[
+        Optional[InputSystemMetricsHostMode], PlainValidator(validate_open_enum(False))
+    ] = InputSystemMetricsHostMode.BASIC
     r"""Select level of detail for host metrics"""
 
     custom: Optional[InputSystemMetricsCustom] = None
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsHostMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSystemMetricsSetTypedDict(TypedDict):
     name: str
@@ -315,12 +460,16 @@ class InputSystemMetricsProcess(BaseModel):
     r"""Configure sets to collect process metrics"""
 
 
-class ContainerMode(str, Enum):
+class ContainerMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for container metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -350,7 +499,9 @@ class ContainerTypedDict(TypedDict):
 
 
 class Container(BaseModel):
-    mode: Optional[ContainerMode] = ContainerMode.BASIC
+    mode: Annotated[
+        Optional[ContainerMode], PlainValidator(validate_open_enum(False))
+    ] = ContainerMode.BASIC
     r"""Select the level of detail for container metrics"""
 
     docker_socket: Annotated[
@@ -377,6 +528,15 @@ class Container(BaseModel):
     detail: Optional[bool] = False
     r"""Generate full container metrics"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ContainerMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSystemMetricsMetadatumTypedDict(TypedDict):
     name: str
@@ -391,7 +551,7 @@ class InputSystemMetricsMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputSystemMetricsDataCompressionFormat(str, Enum):
+class InputSystemMetricsDataCompressionFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     NONE = "none"
     GZIP = "gzip"
 
@@ -423,20 +583,30 @@ class InputSystemMetricsPersistence(BaseModel):
     max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
     r"""Maximum amount of time to retain data (examples: 2h, 4d). When limit is reached, older data will be deleted."""
 
-    compress: Optional[InputSystemMetricsDataCompressionFormat] = (
-        InputSystemMetricsDataCompressionFormat.GZIP
-    )
+    compress: Annotated[
+        Optional[InputSystemMetricsDataCompressionFormat],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSystemMetricsDataCompressionFormat.GZIP
 
     dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = (
         "$CRIBL_HOME/state/system_metrics"
     )
     r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/system_metrics"""
 
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemMetricsDataCompressionFormat(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSystemMetricsTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this input"""
     type: InputSystemMetricsType
+    id: NotRequired[str]
+    r"""Unique ID for this input"""
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -463,11 +633,11 @@ class InputSystemMetricsTypedDict(TypedDict):
 
 
 class InputSystemMetrics(BaseModel):
-    id: str
-    r"""Unique ID for this input"""
-
     type: InputSystemMetricsType
 
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/inputsystemstate.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 List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -23,20 +27,32 @@ class InputSystemStateConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSystemStateMode(str, Enum):
+class InputSystemStateMode(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 InputSystemStateCompression(str, Enum):
+class InputSystemStateCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSystemStatePqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSystemStatePqControls(BaseModel):
+    pass
+
+
 class InputSystemStatePqTypedDict(TypedDict):
     mode: NotRequired[InputSystemStateMode]
     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 InputSystemStatePqTypedDict(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[InputSystemStateCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSystemStatePqControlsTypedDict]
 
 
 class InputSystemStatePq(BaseModel):
-    mode: Optional[InputSystemStateMode] = InputSystemStateMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSystemStateMode], PlainValidator(validate_open_enum(False))
+    ] = InputSystemStateMode.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,9 +98,33 @@ class InputSystemStatePq(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[InputSystemStateCompression] = InputSystemStateCompression.NONE
+    compress: Annotated[
+        Optional[InputSystemStateCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSystemStateCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSystemStatePqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemStateMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemStateCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSystemStateMetadatumTypedDict(TypedDict):
     name: str
@@ -290,7 +333,7 @@ class Collectors(BaseModel):
     r"""Creates events from list of logged-in users"""
 
 
-class InputSystemStateDataCompressionFormat(str, Enum):
+class InputSystemStateDataCompressionFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     NONE = "none"
     GZIP = "gzip"
 
@@ -322,20 +365,30 @@ class InputSystemStatePersistence(BaseModel):
     max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
     r"""Maximum amount of time to retain data (examples: 2h, 4d). When limit is reached, older data will be deleted."""
 
-    compress: Optional[InputSystemStateDataCompressionFormat] = (
-        InputSystemStateDataCompressionFormat.NONE
-    )
+    compress: Annotated[
+        Optional[InputSystemStateDataCompressionFormat],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSystemStateDataCompressionFormat.NONE
 
     dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = (
         "$CRIBL_HOME/state/system_state"
     )
     r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/system_state"""
 
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSystemStateDataCompressionFormat(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSystemStateTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this input"""
     type: InputSystemStateType
+    id: NotRequired[str]
+    r"""Unique ID for this input"""
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -362,11 +415,11 @@ class InputSystemStateTypedDict(TypedDict):
 
 
 class InputSystemState(BaseModel):
-    id: str
-    r"""Unique ID for this input"""
-
     type: InputSystemStateType
 
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None