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

cribl_control_plane/models/inputwindowsmetrics.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 InputWindowsMetricsConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputWindowsMetricsPqMode(str, Enum):
+class InputWindowsMetricsPqMode(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 InputWindowsMetricsCompression(str, Enum):
+class InputWindowsMetricsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputWindowsMetricsPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputWindowsMetricsPqControls(BaseModel):
+    pass
+
+
 class InputWindowsMetricsPqTypedDict(TypedDict):
     mode: NotRequired[InputWindowsMetricsPqMode]
     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 InputWindowsMetricsPqTypedDict(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[InputWindowsMetricsCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputWindowsMetricsPqControlsTypedDict]
 
 
 class InputWindowsMetricsPq(BaseModel):
-    mode: Optional[InputWindowsMetricsPqMode] = InputWindowsMetricsPqMode.ALWAYS
+    mode: Annotated[
+        Optional[InputWindowsMetricsPqMode], PlainValidator(validate_open_enum(False))
+    ] = InputWindowsMetricsPqMode.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 InputWindowsMetricsPq(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[InputWindowsMetricsCompression] = (
-        InputWindowsMetricsCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputWindowsMetricsCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputWindowsMetricsCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
-
-class InputWindowsMetricsHostMode(str, Enum):
+    pq_controls: Annotated[
+        Optional[InputWindowsMetricsPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsPqMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputWindowsMetricsHostMode(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 InputWindowsMetricsSystemMode(str, Enum):
+class InputWindowsMetricsSystemMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for system metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -111,19 +161,35 @@ class InputWindowsMetricsSystemTypedDict(TypedDict):
 
 
 class InputWindowsMetricsSystem(BaseModel):
-    mode: Optional[InputWindowsMetricsSystemMode] = InputWindowsMetricsSystemMode.BASIC
+    mode: Annotated[
+        Optional[InputWindowsMetricsSystemMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputWindowsMetricsSystemMode.BASIC
     r"""Select the level of details for system metrics"""
 
     detail: Optional[bool] = False
     r"""Generate metrics for all system information"""
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsSystemMode(value)
+            except ValueError:
+                return value
+        return value
 
-class InputWindowsMetricsCPUMode(str, Enum):
+
+class InputWindowsMetricsCPUMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for CPU metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -139,7 +205,9 @@ class InputWindowsMetricsCPUTypedDict(TypedDict):
 
 
 class InputWindowsMetricsCPU(BaseModel):
-    mode: Optional[InputWindowsMetricsCPUMode] = InputWindowsMetricsCPUMode.BASIC
+    mode: Annotated[
+        Optional[InputWindowsMetricsCPUMode], PlainValidator(validate_open_enum(False))
+    ] = InputWindowsMetricsCPUMode.BASIC
     r"""Select the level of details for CPU metrics"""
 
     per_cpu: Annotated[Optional[bool], pydantic.Field(alias="perCpu")] = False
@@ -151,13 +219,26 @@ class InputWindowsMetricsCPU(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.InputWindowsMetricsCPUMode(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputWindowsMetricsMemoryMode(str, Enum):
+class InputWindowsMetricsMemoryMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for memory metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -169,39 +250,64 @@ class InputWindowsMetricsMemoryTypedDict(TypedDict):
 
 
 class InputWindowsMetricsMemory(BaseModel):
-    mode: Optional[InputWindowsMetricsMemoryMode] = InputWindowsMetricsMemoryMode.BASIC
+    mode: Annotated[
+        Optional[InputWindowsMetricsMemoryMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputWindowsMetricsMemoryMode.BASIC
     r"""Select the level of details 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.InputWindowsMetricsMemoryMode(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputWindowsMetricsNetworkMode(str, Enum):
+class InputWindowsMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for network metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
 class InputWindowsMetricsNetworkTypedDict(TypedDict):
     mode: NotRequired[InputWindowsMetricsNetworkMode]
     r"""Select the level of details 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. 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 InputWindowsMetricsNetwork(BaseModel):
-    mode: Optional[InputWindowsMetricsNetworkMode] = (
-        InputWindowsMetricsNetworkMode.BASIC
-    )
+    mode: Annotated[
+        Optional[InputWindowsMetricsNetworkMode],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputWindowsMetricsNetworkMode.BASIC
     r"""Select the level of details 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. All interfaces are included if this list is empty."""
 
@@ -210,37 +316,63 @@ class InputWindowsMetricsNetwork(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.InputWindowsMetricsNetworkMode(value)
+            except ValueError:
+                return value
+        return value
 
 
-class InputWindowsMetricsDiskMode(str, Enum):
+class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for disk metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
 class InputWindowsMetricsDiskTypedDict(TypedDict):
     mode: NotRequired[InputWindowsMetricsDiskMode]
     r"""Select the level of details for disk metrics"""
-    volumes: NotRequired[List[str]]
-    r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
     per_volume: NotRequired[bool]
     r"""Generate separate metrics for each volume"""
+    detail: NotRequired[bool]
+    r"""Generate full disk metrics"""
+    volumes: NotRequired[List[str]]
+    r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
 
 
 class InputWindowsMetricsDisk(BaseModel):
-    mode: Optional[InputWindowsMetricsDiskMode] = InputWindowsMetricsDiskMode.BASIC
+    mode: Annotated[
+        Optional[InputWindowsMetricsDiskMode], PlainValidator(validate_open_enum(False))
+    ] = InputWindowsMetricsDiskMode.BASIC
     r"""Select the level of details for disk metrics"""
 
+    per_volume: Annotated[Optional[bool], pydantic.Field(alias="perVolume")] = False
+    r"""Generate separate metrics for each volume"""
+
+    detail: Optional[bool] = False
+    r"""Generate full disk metrics"""
+
     volumes: Optional[List[str]] = None
     r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
 
-    per_volume: Annotated[Optional[bool], pydantic.Field(alias="perVolume")] = False
-    r"""Generate separate metrics for each volume"""
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsDiskMode(value)
+            except ValueError:
+                return value
+        return value
 
 
 class InputWindowsMetricsCustomTypedDict(TypedDict):
@@ -270,11 +402,22 @@ class InputWindowsMetricsHostTypedDict(TypedDict):
 
 
 class InputWindowsMetricsHost(BaseModel):
-    mode: Optional[InputWindowsMetricsHostMode] = InputWindowsMetricsHostMode.BASIC
+    mode: Annotated[
+        Optional[InputWindowsMetricsHostMode], PlainValidator(validate_open_enum(False))
+    ] = InputWindowsMetricsHostMode.BASIC
     r"""Select level of detail for host metrics"""
 
     custom: Optional[InputWindowsMetricsCustom] = None
 
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsHostMode(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsSetTypedDict(TypedDict):
     name: str
@@ -315,7 +458,7 @@ class InputWindowsMetricsMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputWindowsMetricsDataCompressionFormat(str, Enum):
+class InputWindowsMetricsDataCompressionFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     NONE = "none"
     GZIP = "gzip"
 
@@ -347,20 +490,30 @@ class InputWindowsMetricsPersistence(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[InputWindowsMetricsDataCompressionFormat] = (
-        InputWindowsMetricsDataCompressionFormat.GZIP
-    )
+    compress: Annotated[
+        Optional[InputWindowsMetricsDataCompressionFormat],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputWindowsMetricsDataCompressionFormat.GZIP
 
     dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = (
         "$CRIBL_HOME/state/windows_metrics"
     )
     r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/windows_metrics"""
 
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWindowsMetricsDataCompressionFormat(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputWindowsMetricsTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this input"""
     type: InputWindowsMetricsType
+    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"""
@@ -388,11 +541,11 @@ class InputWindowsMetricsTypedDict(TypedDict):
 
 
 class InputWindowsMetrics(BaseModel):
-    id: str
-    r"""Unique ID for this input"""
-
     type: InputWindowsMetricsType
 
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/inputwineventlogs.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 InputWinEventLogsConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputWinEventLogsMode(str, Enum):
+class InputWinEventLogsMode(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 InputWinEventLogsCompression(str, Enum):
+class InputWinEventLogsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputWinEventLogsPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputWinEventLogsPqControls(BaseModel):
+    pass
+
+
 class InputWinEventLogsPqTypedDict(TypedDict):
     mode: NotRequired[InputWinEventLogsMode]
     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 InputWinEventLogsPqTypedDict(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[InputWinEventLogsCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputWinEventLogsPqControlsTypedDict]
 
 
 class InputWinEventLogsPq(BaseModel):
-    mode: Optional[InputWinEventLogsMode] = InputWinEventLogsMode.ALWAYS
+    mode: Annotated[
+        Optional[InputWinEventLogsMode], PlainValidator(validate_open_enum(False))
+    ] = InputWinEventLogsMode.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,21 +98,50 @@ class InputWinEventLogsPq(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[InputWinEventLogsCompression] = InputWinEventLogsCompression.NONE
+    compress: Annotated[
+        Optional[InputWinEventLogsCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputWinEventLogsCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
-
-class ReadMode(str, Enum):
+    pq_controls: Annotated[
+        Optional[InputWinEventLogsPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWinEventLogsMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputWinEventLogsCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class ReadMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Read all stored and future event logs, or only future events"""
 
+    # Entire log
     OLDEST = "oldest"
+    # From last entry
     NEWEST = "newest"
 
 
-class EventFormat(str, Enum):
+class EventFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of individual events"""
 
+    # JSON
     JSON = "json"
+    # XML
     XML = "xml"
 
 
@@ -145,6 +193,10 @@ class InputWinEventLogsTypedDict(TypedDict):
     max_event_bytes: NotRequired[float]
     r"""The maximum number of bytes in an event before it is flushed to the pipelines"""
     description: NotRequired[str]
+    disable_json_rendering: NotRequired[bool]
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
+    disable_xml_rendering: NotRequired[bool]
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
 
 
 class InputWinEventLogs(BaseModel):
@@ -180,13 +232,15 @@ class InputWinEventLogs(BaseModel):
 
     pq: Optional[InputWinEventLogsPq] = None
 
-    read_mode: Annotated[Optional[ReadMode], pydantic.Field(alias="readMode")] = (
-        ReadMode.OLDEST
-    )
+    read_mode: Annotated[
+        Annotated[Optional[ReadMode], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="readMode"),
+    ] = ReadMode.NEWEST
     r"""Read all stored and future event logs, or only future events"""
 
     event_format: Annotated[
-        Optional[EventFormat], pydantic.Field(alias="eventFormat")
+        Annotated[Optional[EventFormat], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="eventFormat"),
     ] = EventFormat.JSON
     r"""Format of individual events"""
 
@@ -210,3 +264,31 @@ class InputWinEventLogs(BaseModel):
     r"""The maximum number of bytes in an event before it is flushed to the pipelines"""
 
     description: Optional[str] = None
+
+    disable_json_rendering: Annotated[
+        Optional[bool], pydantic.Field(alias="disableJsonRendering")
+    ] = False
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
+
+    disable_xml_rendering: Annotated[
+        Optional[bool], pydantic.Field(alias="disableXmlRendering")
+    ] = True
+    r"""Enable/disable the rendering of localized event message strings (Applicable for 4.8.0 nodes and newer that use the Native API)"""
+
+    @field_serializer("read_mode")
+    def serialize_read_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ReadMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("event_format")
+    def serialize_event_format(self, value):
+        if isinstance(value, str):
+            try:
+                return models.EventFormat(value)
+            except ValueError:
+                return value
+        return value