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

cribl_control_plane/models/inputsplunkhec.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 InputSplunkHecConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSplunkHecMode(str, Enum):
+class InputSplunkHecMode(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 InputSplunkHecCompression(str, Enum):
+class InputSplunkHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSplunkHecPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSplunkHecPqControls(BaseModel):
+    pass
+
+
 class InputSplunkHecPqTypedDict(TypedDict):
     mode: NotRequired[InputSplunkHecMode]
     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 InputSplunkHecPqTypedDict(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[InputSplunkHecCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSplunkHecPqControlsTypedDict]
 
 
 class InputSplunkHecPq(BaseModel):
-    mode: Optional[InputSplunkHecMode] = InputSplunkHecMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSplunkHecMode], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkHecMode.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 InputSplunkHecPq(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[InputSplunkHecCompression] = InputSplunkHecCompression.NONE
+    compress: Annotated[
+        Optional[InputSplunkHecCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkHecCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSplunkHecPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSplunkHecAuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSplunkHecAuthenticationMethod(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 InputSplunkHecAuthTokenMetadatum(BaseModel):
 
 
 class InputSplunkHecAuthTokenTypedDict(TypedDict):
-    token: Any
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
     auth_type: NotRequired[InputSplunkHecAuthenticationMethod]
     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]
     r"""Optional token description"""
@@ -118,14 +163,20 @@ class InputSplunkHecAuthTokenTypedDict(TypedDict):
 
 
 class InputSplunkHecAuthToken(BaseModel):
-    token: Any
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
 
     auth_type: Annotated[
-        Optional[InputSplunkHecAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputSplunkHecAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputSplunkHecAuthenticationMethod.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
 
@@ -140,15 +191,24 @@ class InputSplunkHecAuthToken(BaseModel):
     metadata: Optional[List[InputSplunkHecAuthTokenMetadatum]] = 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.InputSplunkHecAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputSplunkHecMinimumTLSVersion(str, Enum):
+class InputSplunkHecMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputSplunkHecMaximumTLSVersion(str, Enum):
+class InputSplunkHecMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -157,6 +217,12 @@ class InputSplunkHecMaximumTLSVersion(str, Enum):
 
 class InputSplunkHecTLSSettingsServerSideTypedDict(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]
@@ -167,10 +233,6 @@ class InputSplunkHecTLSSettingsServerSideTypedDict(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[InputSplunkHecMinimumTLSVersion]
     max_version: NotRequired[InputSplunkHecMaximumTLSVersion]
 
@@ -178,6 +240,19 @@ class InputSplunkHecTLSSettingsServerSideTypedDict(TypedDict):
 class InputSplunkHecTLSSettingsServerSide(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
@@ -195,25 +270,40 @@ class InputSplunkHecTLSSettingsServerSide(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[InputSplunkHecMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputSplunkHecMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputSplunkHecMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputSplunkHecMaximumTLSVersion],
+            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.InputSplunkHecMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSplunkHecMetadatumTypedDict(TypedDict):
     name: str

cribl_control_plane/models/inputsplunksearch.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 InputSplunkSearchConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSplunkSearchMode(str, Enum):
+class InputSplunkSearchMode(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 InputSplunkSearchCompression(str, Enum):
+class InputSplunkSearchCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSplunkSearchPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSplunkSearchPqControls(BaseModel):
+    pass
+
+
 class InputSplunkSearchPqTypedDict(TypedDict):
     mode: NotRequired[InputSplunkSearchMode]
     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 InputSplunkSearchPqTypedDict(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[InputSplunkSearchCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSplunkSearchPqControlsTypedDict]
 
 
 class InputSplunkSearchPq(BaseModel):
-    mode: Optional[InputSplunkSearchMode] = InputSplunkSearchMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSplunkSearchMode], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkSearchMode.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,36 @@ class InputSplunkSearchPq(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[InputSplunkSearchCompression] = InputSplunkSearchCompression.NONE
+    compress: Annotated[
+        Optional[InputSplunkSearchCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSplunkSearchCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSplunkSearchPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class OutputMode(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSplunkSearchOutputMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the returned output"""
 
     CSV = "csv"
@@ -116,7 +160,7 @@ class EndpointHeader(BaseModel):
     r"""JavaScript expression to compute the header's value, normally enclosed in backticks (e.g., `${earliest}`). If a constant, use single quotes (e.g., 'earliest'). Values without delimiters (e.g., earliest) are evaluated as strings."""
 
 
-class InputSplunkSearchLogLevel(str, Enum):
+class InputSplunkSearchLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Collector runtime log level (verbosity)"""
 
     ERROR = "error"
@@ -138,11 +182,14 @@ class InputSplunkSearchMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputSplunkSearchRetryType(str, Enum):
+class InputSplunkSearchRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 
@@ -166,7 +213,9 @@ class InputSplunkSearchRetryRulesTypedDict(TypedDict):
 
 
 class InputSplunkSearchRetryRules(BaseModel):
-    type: Optional[InputSplunkSearchRetryType] = InputSplunkSearchRetryType.BACKOFF
+    type: Annotated[
+        Optional[InputSplunkSearchRetryType], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkSearchRetryType.BACKOFF
     r"""The algorithm to use when performing HTTP retries"""
 
     interval: Optional[float] = 1000
@@ -196,8 +245,17 @@ class InputSplunkSearchRetryRules(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.InputSplunkSearchRetryType(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputSplunkSearchAuthenticationType(str, Enum):
+class InputSplunkSearchAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Splunk Search authentication type"""
 
     NONE = "none"
@@ -268,7 +326,7 @@ class InputSplunkSearchTypedDict(TypedDict):
     r"""A cron schedule on which to run this job"""
     endpoint: NotRequired[str]
     r"""REST API used to create a search"""
-    output_mode: NotRequired[OutputMode]
+    output_mode: NotRequired[InputSplunkSearchOutputMode]
     r"""Format of the returned output"""
     endpoint_params: NotRequired[List[EndpointParamTypedDict]]
     r"""Optional request parameters to send to the endpoint"""
@@ -382,9 +440,13 @@ class InputSplunkSearch(BaseModel):
     endpoint: Optional[str] = "/services/search/v2/jobs/export"
     r"""REST API used to create a search"""
 
-    output_mode: Annotated[Optional[OutputMode], pydantic.Field(alias="outputMode")] = (
-        OutputMode.JSON
-    )
+    output_mode: Annotated[
+        Annotated[
+            Optional[InputSplunkSearchOutputMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="outputMode"),
+    ] = InputSplunkSearchOutputMode.JSON
     r"""Format of the returned output"""
 
     endpoint_params: Annotated[
@@ -398,7 +460,11 @@ class InputSplunkSearch(BaseModel):
     r"""Optional request headers to send to the endpoint"""
 
     log_level: Annotated[
-        Optional[InputSplunkSearchLogLevel], pydantic.Field(alias="logLevel")
+        Annotated[
+            Optional[InputSplunkSearchLogLevel],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="logLevel"),
     ] = None
     r"""Collector runtime log level (verbosity)"""
 
@@ -459,7 +525,11 @@ class InputSplunkSearch(BaseModel):
     r"""How long (in milliseconds) the Event Breaker will wait for new data to be sent to a specific channel before flushing the data stream out, as is, to the Pipelines"""
 
     auth_type: Annotated[
-        Optional[InputSplunkSearchAuthenticationType], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputSplunkSearchAuthenticationType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputSplunkSearchAuthenticationType.BASIC
     r"""Splunk Search authentication type"""
 
@@ -516,3 +586,30 @@ class InputSplunkSearch(BaseModel):
         pydantic.Field(alias="oauthHeaders"),
     ] = None
     r"""Additional headers to send in the OAuth login request. @{product} will automatically add the content-type header 'application/x-www-form-urlencoded' when sending this request."""
+
+    @field_serializer("output_mode")
+    def serialize_output_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchOutputMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("log_level")
+    def serialize_log_level(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchLogLevel(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchAuthenticationType(value)
+            except ValueError:
+                return value
+        return value