cribl-control-plane 0.2.1rc6__py3-none-any.whl → 0.2.1rc8__py3-none-any.whl

cribl_control_plane/models/inputtcpjson.py

@@ -7,7 +7,7 @@ from cribl_control_plane.utils import validate_open_enum
 from enum import Enum
 import pydantic
 from pydantic.functional_validators import PlainValidator
-from typing import Any, List, Optional
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -123,6 +123,12 @@ class InputTcpjsonMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
 
 class InputTcpjsonTLSSettingsServerSideTypedDict(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]
@@ -133,10 +139,6 @@ class InputTcpjsonTLSSettingsServerSideTypedDict(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[InputTcpjsonMinimumTLSVersion]
     max_version: NotRequired[InputTcpjsonMaximumTLSVersion]
 
@@ -144,6 +146,19 @@ class InputTcpjsonTLSSettingsServerSideTypedDict(TypedDict):
 class InputTcpjsonTLSSettingsServerSide(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
@@ -161,17 +176,6 @@ class InputTcpjsonTLSSettingsServerSide(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[
         Annotated[
             Optional[InputTcpjsonMinimumTLSVersion],

cribl_control_plane/models/inputwindowsmetrics.py

@@ -239,12 +239,14 @@ class InputWindowsMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
 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):
@@ -254,6 +256,12 @@ class InputWindowsMetricsNetwork(BaseModel):
     ] = 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."""
 
@@ -262,9 +270,6 @@ class InputWindowsMetricsNetwork(BaseModel):
     )
     r"""Generate separate metrics for each interface"""
 
-    detail: Optional[bool] = False
-    r"""Generate full network metrics"""
-
 
 class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for disk metrics"""
@@ -282,10 +287,12 @@ class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
 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):
@@ -294,12 +301,15 @@ class InputWindowsMetricsDisk(BaseModel):
     ] = InputWindowsMetricsDiskMode.BASIC
     r"""Select the level of details for 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"""
 
+    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."""
+
 
 class InputWindowsMetricsCustomTypedDict(TypedDict):
     system: NotRequired[InputWindowsMetricsSystemTypedDict]

cribl_control_plane/models/inputwineventlogs.py

@@ -174,6 +174,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):
@@ -241,3 +245,13 @@ 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)"""

cribl_control_plane/models/inputwizwebhook.py

@@ -7,7 +7,7 @@ from cribl_control_plane.utils import validate_open_enum
 from enum import Enum
 import pydantic
 from pydantic.functional_validators import PlainValidator
-from typing import Any, List, Optional
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -123,6 +123,12 @@ class InputWizWebhookMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
 
 class InputWizWebhookTLSSettingsServerSideTypedDict(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]
@@ -133,10 +139,6 @@ class InputWizWebhookTLSSettingsServerSideTypedDict(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[InputWizWebhookMinimumTLSVersion]
     max_version: NotRequired[InputWizWebhookMaximumTLSVersion]
 
@@ -144,6 +146,19 @@ class InputWizWebhookTLSSettingsServerSideTypedDict(TypedDict):
 class InputWizWebhookTLSSettingsServerSide(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
@@ -161,17 +176,6 @@ class InputWizWebhookTLSSettingsServerSide(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[
         Annotated[
             Optional[InputWizWebhookMinimumTLSVersion],

cribl_control_plane/models/inputzscalerhec.py

@@ -183,6 +183,12 @@ class InputZscalerHecMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
 
 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]
@@ -193,10 +199,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]
 
@@ -204,6 +206,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
@@ -221,17 +236,6 @@ 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[
         Annotated[
             Optional[InputZscalerHecMinimumTLSVersion],

cribl_control_plane/models/jobinfo.py

@@ -4,14 +4,20 @@ 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
-from typing_extensions import NotRequired, TypedDict
+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, float]
+    stats: Dict[str, StatsTypedDict]
     status: JobStatusTypedDict
     keep: NotRequired[bool]
 
@@ -21,7 +27,7 @@ class JobInfo(BaseModel):
 
     id: str
 
-    stats: Dict[str, float]
+    stats: Dict[str, Stats]
 
     status: JobStatus
 

cribl_control_plane/models/jobstatus.py

@@ -1,17 +1,38 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+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
+from pydantic.functional_validators import PlainValidator
 from typing import Any, Dict, Optional
-from typing_extensions import NotRequired, TypedDict
+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: Dict[str, Any]
+    state: State
+    r"""State of the Job"""
     reason: NotRequired[Dict[str, Any]]
 
 
 class JobStatus(BaseModel):
-    state: Dict[str, Any]
+    state: Annotated[State, PlainValidator(validate_open_enum(True))]
+    r"""State of the Job"""
 
     reason: Optional[Dict[str, Any]] = None

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/output.py

@@ -98,64 +98,64 @@ OutputTypedDict = TypeAliasType(
         OutputNetflowTypedDict,
         OutputDiskSpoolTypedDict,
         OutputRingTypedDict,
-        OutputStatsdExtTypedDict,
         OutputGraphiteTypedDict,
+        OutputStatsdExtTypedDict,
         OutputStatsdTypedDict,
         OutputGooglePubsubTypedDict,
-        OutputCriblTCPTypedDict,
+        OutputExabeamTypedDict,
         OutputSplunkTypedDict,
         OutputSnsTypedDict,
-        OutputCloudwatchTypedDict,
+        OutputCriblTCPTypedDict,
         OutputAzureEventhubTypedDict,
-        OutputWavefrontTypedDict,
+        OutputCloudwatchTypedDict,
         OutputSignalfxTypedDict,
         OutputHoneycombTypedDict,
+        OutputWavefrontTypedDict,
+        OutputHumioHecTypedDict,
         OutputSumoLogicTypedDict,
         OutputCrowdstrikeNextGenSiemTypedDict,
-        OutputHumioHecTypedDict,
         OutputTcpjsonTypedDict,
         OutputElasticCloudTypedDict,
-        OutputKinesisTypedDict,
+        OutputNewrelicEventsTypedDict,
+        OutputFilesystemTypedDict,
         OutputConfluentCloudTypedDict,
         OutputKafkaTypedDict,
-        OutputExabeamTypedDict,
-        OutputNewrelicEventsTypedDict,
         OutputAzureLogsTypedDict,
+        OutputKinesisTypedDict,
         OutputSplunkLbTypedDict,
         OutputSyslogTypedDict,
         OutputSqsTypedDict,
-        OutputNewrelicTypedDict,
         OutputCriblHTTPTypedDict,
+        OutputNewrelicTypedDict,
         OutputXsiamTypedDict,
-        OutputFilesystemTypedDict,
         OutputDatasetTypedDict,
         OutputLokiTypedDict,
-        OutputSplunkHecTypedDict,
+        OutputCriblLakeTypedDict,
         OutputDynatraceHTTPTypedDict,
         OutputServiceNowTypedDict,
+        OutputSplunkHecTypedDict,
         OutputChronicleTypedDict,
         OutputDynatraceOtlpTypedDict,
-        OutputGoogleChronicleTypedDict,
+        OutputDatabricksTypedDict,
         OutputElasticTypedDict,
         OutputDatadogTypedDict,
-        OutputCriblLakeTypedDict,
-        OutputDatabricksTypedDict,
+        OutputGoogleChronicleTypedDict,
         OutputPrometheusTypedDict,
-        OutputMskTypedDict,
         OutputSentinelOneAiSiemTypedDict,
-        OutputSentinelTypedDict,
-        OutputInfluxdbTypedDict,
+        OutputMskTypedDict,
         OutputGoogleCloudStorageTypedDict,
+        OutputSentinelTypedDict,
         OutputAzureBlobTypedDict,
-        OutputOpenTelemetryTypedDict,
+        OutputInfluxdbTypedDict,
         OutputMinioTypedDict,
-        OutputClickHouseTypedDict,
         OutputSecurityLakeTypedDict,
-        OutputS3TypedDict,
+        OutputOpenTelemetryTypedDict,
+        OutputClickHouseTypedDict,
         OutputDlS3TypedDict,
+        OutputS3TypedDict,
         OutputWebhookTypedDict,
-        OutputAzureDataExplorerTypedDict,
         OutputGoogleCloudLoggingTypedDict,
+        OutputAzureDataExplorerTypedDict,
         OutputGrafanaCloudTypedDict,
     ],
 )

cribl_control_plane/models/outputazureblob.py

@@ -184,6 +184,8 @@ class OutputAzureBlobTypedDict(TypedDict):
     r"""Compression level to apply before moving files to final destination"""
     automatic_schema: NotRequired[bool]
     r"""Automatically calculate the schema based on the events of each Parquet file generated"""
+    parquet_schema: NotRequired[str]
+    r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
     parquet_version: NotRequired[OutputAzureBlobParquetVersion]
     r"""Determines which data types are supported and how they are represented"""
     parquet_data_page_version: NotRequired[OutputAzureBlobDataPageVersion]
@@ -387,6 +389,11 @@ class OutputAzureBlob(BaseModel):
     ] = False
     r"""Automatically calculate the schema based on the events of each Parquet file generated"""
 
+    parquet_schema: Annotated[Optional[str], pydantic.Field(alias="parquetSchema")] = (
+        None
+    )
+    r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
+
     parquet_version: Annotated[
         Annotated[
             Optional[OutputAzureBlobParquetVersion],