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

cribl_control_plane/models/inputoffice365service.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 InputOffice365ServiceConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputOffice365ServiceMode(str, Enum):
+class InputOffice365ServiceMode(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 InputOffice365ServiceCompression(str, Enum):
+class InputOffice365ServiceCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputOffice365ServicePqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputOffice365ServicePqControls(BaseModel):
+    pass
+
+
 class InputOffice365ServicePqTypedDict(TypedDict):
     mode: NotRequired[InputOffice365ServiceMode]
     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 InputOffice365ServicePqTypedDict(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[InputOffice365ServiceCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputOffice365ServicePqControlsTypedDict]
 
 
 class InputOffice365ServicePq(BaseModel):
-    mode: Optional[InputOffice365ServiceMode] = InputOffice365ServiceMode.ALWAYS
+    mode: Annotated[
+        Optional[InputOffice365ServiceMode], PlainValidator(validate_open_enum(False))
+    ] = InputOffice365ServiceMode.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,18 +98,45 @@ class InputOffice365ServicePq(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[InputOffice365ServiceCompression] = (
-        InputOffice365ServiceCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputOffice365ServiceCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOffice365ServiceCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputOffice365ServicePqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputOffice365ServiceSubscriptionPlan(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOffice365ServiceMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOffice365ServiceCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputOffice365ServiceSubscriptionPlan(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
 
+    # Office 365 Enterprise
     ENTERPRISE_GCC = "enterprise_gcc"
+    # Office 365 GCC
     GCC = "gcc"
+    # Office 365 GCC High
     GCC_HIGH = "gcc_high"
+    # Office 365 DoD
     DOD = "dod"
 
 
@@ -107,7 +153,7 @@ class InputOffice365ServiceMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputOffice365ServiceLogLevel(str, Enum):
+class InputOffice365ServiceLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Collector runtime Log Level"""
 
     ERROR = "error"
@@ -137,18 +183,34 @@ class InputOffice365ServiceContentConfig(BaseModel):
     interval: Optional[float] = None
 
     log_level: Annotated[
-        Optional[InputOffice365ServiceLogLevel], pydantic.Field(alias="logLevel")
+        Annotated[
+            Optional[InputOffice365ServiceLogLevel],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="logLevel"),
     ] = None
     r"""Collector runtime Log Level"""
 
     enabled: Optional[bool] = None
 
+    @field_serializer("log_level")
+    def serialize_log_level(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOffice365ServiceLogLevel(value)
+            except ValueError:
+                return value
+        return value
 
-class InputOffice365ServiceRetryType(str, Enum):
+
+class InputOffice365ServiceRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 
@@ -172,9 +234,10 @@ class InputOffice365ServiceRetryRulesTypedDict(TypedDict):
 
 
 class InputOffice365ServiceRetryRules(BaseModel):
-    type: Optional[InputOffice365ServiceRetryType] = (
-        InputOffice365ServiceRetryType.BACKOFF
-    )
+    type: Annotated[
+        Optional[InputOffice365ServiceRetryType],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOffice365ServiceRetryType.BACKOFF
     r"""The algorithm to use when performing HTTP retries"""
 
     interval: Optional[float] = 1000
@@ -204,8 +267,19 @@ class InputOffice365ServiceRetryRules(BaseModel):
     ] = False
     r"""Retry request when a connection reset (ECONNRESET) error occurs"""
 
+    @field_serializer("type")
+    def serialize_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOffice365ServiceRetryType(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputOffice365ServiceAuthenticationMethod(str, Enum):
+class InputOffice365ServiceAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Enter client secret directly, or select a stored secret"""
 
     MANUAL = "manual"
@@ -213,13 +287,13 @@ class InputOffice365ServiceAuthenticationMethod(str, Enum):
 
 
 class InputOffice365ServiceTypedDict(TypedDict):
+    type: InputOffice365ServiceType
     tenant_id: str
     r"""Office 365 Azure Tenant ID"""
     app_id: str
     r"""Office 365 Azure Application ID"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputOffice365ServiceType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -263,6 +337,8 @@ class InputOffice365ServiceTypedDict(TypedDict):
 
 
 class InputOffice365Service(BaseModel):
+    type: InputOffice365ServiceType
+
     tenant_id: Annotated[str, pydantic.Field(alias="tenantId")]
     r"""Office 365 Azure Tenant ID"""
 
@@ -272,8 +348,6 @@ class InputOffice365Service(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputOffice365ServiceType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -299,7 +373,10 @@ class InputOffice365Service(BaseModel):
     pq: Optional[InputOffice365ServicePq] = None
 
     plan_type: Annotated[
-        Optional[InputOffice365ServiceSubscriptionPlan],
+        Annotated[
+            Optional[InputOffice365ServiceSubscriptionPlan],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="planType"),
     ] = InputOffice365ServiceSubscriptionPlan.ENTERPRISE_GCC
     r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
@@ -342,7 +419,10 @@ class InputOffice365Service(BaseModel):
     ] = None
 
     auth_type: Annotated[
-        Optional[InputOffice365ServiceAuthenticationMethod],
+        Annotated[
+            Optional[InputOffice365ServiceAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="authType"),
     ] = InputOffice365ServiceAuthenticationMethod.MANUAL
     r"""Enter client secret directly, or select a stored secret"""
@@ -354,3 +434,21 @@ class InputOffice365Service(BaseModel):
 
     text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
     r"""Select or create a stored text secret"""
+
+    @field_serializer("plan_type")
+    def serialize_plan_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOffice365ServiceSubscriptionPlan(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOffice365ServiceAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputopentelemetry.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 InputOpenTelemetryConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputOpenTelemetryMode(str, Enum):
+class InputOpenTelemetryMode(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 InputOpenTelemetryCompression(str, Enum):
+class InputOpenTelemetryCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputOpenTelemetryPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputOpenTelemetryPqControls(BaseModel):
+    pass
+
+
 class InputOpenTelemetryPqTypedDict(TypedDict):
     mode: NotRequired[InputOpenTelemetryMode]
     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 InputOpenTelemetryPqTypedDict(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[InputOpenTelemetryCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputOpenTelemetryPqControlsTypedDict]
 
 
 class InputOpenTelemetryPq(BaseModel):
-    mode: Optional[InputOpenTelemetryMode] = InputOpenTelemetryMode.ALWAYS
+    mode: Annotated[
+        Optional[InputOpenTelemetryMode], PlainValidator(validate_open_enum(False))
+    ] = InputOpenTelemetryMode.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,20 +98,43 @@ class InputOpenTelemetryPq(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[InputOpenTelemetryCompression] = (
-        InputOpenTelemetryCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputOpenTelemetryCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOpenTelemetryCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputOpenTelemetryPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputOpenTelemetryMinimumTLSVersion(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputOpenTelemetryMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputOpenTelemetryMaximumTLSVersion(str, Enum):
+class InputOpenTelemetryMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -101,6 +143,12 @@ class InputOpenTelemetryMaximumTLSVersion(str, Enum):
 
 class InputOpenTelemetryTLSSettingsServerSideTypedDict(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]
@@ -111,10 +159,6 @@ class InputOpenTelemetryTLSSettingsServerSideTypedDict(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[InputOpenTelemetryMinimumTLSVersion]
     max_version: NotRequired[InputOpenTelemetryMaximumTLSVersion]
 
@@ -122,6 +166,19 @@ class InputOpenTelemetryTLSSettingsServerSideTypedDict(TypedDict):
 class InputOpenTelemetryTLSSettingsServerSide(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
@@ -139,43 +196,60 @@ class InputOpenTelemetryTLSSettingsServerSide(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[InputOpenTelemetryMinimumTLSVersion],
+        Annotated[
+            Optional[InputOpenTelemetryMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputOpenTelemetryMaximumTLSVersion],
+        Annotated[
+            Optional[InputOpenTelemetryMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="maxVersion"),
     ] = None
 
-
-class InputOpenTelemetryProtocol(str, Enum):
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputOpenTelemetryProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select whether to leverage gRPC or HTTP for OpenTelemetry"""
 
+    # gRPC
     GRPC = "grpc"
+    # HTTP
     HTTP = "http"
 
 
-class InputOpenTelemetryOTLPVersion(str, Enum):
+class InputOpenTelemetryOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The version of OTLP Protobuf definitions to use when interpreting received data"""
 
+    # 0.10.0
     ZERO_DOT_10_DOT_0 = "0.10.0"
+    # 1.3.1
     ONE_DOT_3_DOT_1 = "1.3.1"
 
 
-class InputOpenTelemetryAuthenticationType(str, Enum):
+class InputOpenTelemetryAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""OpenTelemetry authentication type"""
 
     NONE = "none"
@@ -230,9 +304,9 @@ class InputOpenTelemetryOauthHeader(BaseModel):
 
 
 class InputOpenTelemetryTypedDict(TypedDict):
+    type: InputOpenTelemetryType
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputOpenTelemetryType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -315,11 +389,11 @@ class InputOpenTelemetryTypedDict(TypedDict):
 
 
 class InputOpenTelemetry(BaseModel):
+    type: InputOpenTelemetryType
+
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputOpenTelemetryType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -404,7 +478,9 @@ class InputOpenTelemetry(BaseModel):
     ] = "/^$/"
     r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
 
-    protocol: Optional[InputOpenTelemetryProtocol] = InputOpenTelemetryProtocol.GRPC
+    protocol: Annotated[
+        Optional[InputOpenTelemetryProtocol], PlainValidator(validate_open_enum(False))
+    ] = InputOpenTelemetryProtocol.GRPC
     r"""Select whether to leverage gRPC or HTTP for OpenTelemetry"""
 
     extract_spans: Annotated[Optional[bool], pydantic.Field(alias="extractSpans")] = (
@@ -418,12 +494,20 @@ class InputOpenTelemetry(BaseModel):
     r"""Enable to extract each incoming Gauge or IntGauge metric to multiple events, one per data point"""
 
     otlp_version: Annotated[
-        Optional[InputOpenTelemetryOTLPVersion], pydantic.Field(alias="otlpVersion")
+        Annotated[
+            Optional[InputOpenTelemetryOTLPVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="otlpVersion"),
     ] = InputOpenTelemetryOTLPVersion.ZERO_DOT_10_DOT_0
     r"""The version of OTLP Protobuf definitions to use when interpreting received data"""
 
     auth_type: Annotated[
-        Optional[InputOpenTelemetryAuthenticationType], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputOpenTelemetryAuthenticationType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputOpenTelemetryAuthenticationType.NONE
     r"""OpenTelemetry authentication type"""
 
@@ -492,3 +576,30 @@ class InputOpenTelemetry(BaseModel):
 
     extract_logs: Annotated[Optional[bool], pydantic.Field(alias="extractLogs")] = False
     r"""Enable to extract each incoming log record to a separate event"""
+
+    @field_serializer("protocol")
+    def serialize_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryProtocol(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("otlp_version")
+    def serialize_otlp_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryOTLPVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputOpenTelemetryAuthenticationType(value)
+            except ValueError:
+                return value
+        return value