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

cribl_control_plane/models/inputsecuritylake.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 InputSecurityLakeConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSecurityLakeMode(str, Enum):
+class InputSecurityLakeMode(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 InputSecurityLakeCompression(str, Enum):
+class InputSecurityLakeCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSecurityLakePqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSecurityLakePqControls(BaseModel):
+    pass
+
+
 class InputSecurityLakePqTypedDict(TypedDict):
     mode: NotRequired[InputSecurityLakeMode]
     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 InputSecurityLakePqTypedDict(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[InputSecurityLakeCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSecurityLakePqControlsTypedDict]
 
 
 class InputSecurityLakePq(BaseModel):
-    mode: Optional[InputSecurityLakeMode] = InputSecurityLakeMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSecurityLakeMode], PlainValidator(validate_open_enum(False))
+    ] = InputSecurityLakeMode.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,19 +98,47 @@ class InputSecurityLakePq(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[InputSecurityLakeCompression] = InputSecurityLakeCompression.NONE
+    compress: Annotated[
+        Optional[InputSecurityLakeCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSecurityLakeCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSecurityLakePqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSecurityLakeAuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSecurityLakeMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSecurityLakeCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSecurityLakeAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 
-class InputSecurityLakeSignatureVersion(str, Enum):
+class InputSecurityLakeSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing S3 requests"""
 
     V2 = "v2"
@@ -144,7 +191,7 @@ class InputSecurityLakeCheckpointing(BaseModel):
     r"""The number of times to retry processing when a processing error occurs. If Skip file on error is enabled, this setting is ignored."""
 
 
-class InputSecurityLakeTagAfterProcessing(str, Enum):
+class InputSecurityLakeTagAfterProcessing(str, Enum, metaclass=utils.OpenEnumMeta):
     FALSE = "false"
     TRUE = "true"
 
@@ -200,6 +247,8 @@ class InputSecurityLakeTypedDict(TypedDict):
     r"""Socket inactivity timeout (in seconds). Increase this value if timeouts occur due to backpressure."""
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
+    include_sqs_metadata: NotRequired[bool]
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -275,7 +324,10 @@ class InputSecurityLake(BaseModel):
     r"""SQS queue owner's AWS account ID. Leave empty if SQS queue is in same AWS account."""
 
     aws_authentication_method: Annotated[
-        Optional[InputSecurityLakeAuthenticationMethod],
+        Annotated[
+            Optional[InputSecurityLakeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = InputSecurityLakeAuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -291,7 +343,10 @@ class InputSecurityLake(BaseModel):
     r"""S3 service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to S3-compatible endpoint."""
 
     signature_version: Annotated[
-        Optional[InputSecurityLakeSignatureVersion],
+        Annotated[
+            Optional[InputSecurityLakeSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="signatureVersion"),
     ] = InputSecurityLakeSignatureVersion.V4
     r"""Signature version to use for signing S3 requests"""
@@ -337,6 +392,11 @@ class InputSecurityLake(BaseModel):
     )
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
 
+    include_sqs_metadata: Annotated[
+        Optional[bool], pydantic.Field(alias="includeSqsMetadata")
+    ] = False
+    r"""Attach SQS notification metadata to a __sqsMetadata field on each event"""
+
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")
     ] = True
@@ -393,7 +453,10 @@ class InputSecurityLake(BaseModel):
     r"""Select or create a stored secret that references your access key and secret key"""
 
     tag_after_processing: Annotated[
-        Optional[InputSecurityLakeTagAfterProcessing],
+        Annotated[
+            Optional[InputSecurityLakeTagAfterProcessing],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="tagAfterProcessing"),
     ] = None
 
@@ -406,3 +469,30 @@ class InputSecurityLake(BaseModel):
         Optional[str], pydantic.Field(alias="processedTagValue")
     ] = None
     r"""The value for the S3 object tag applied after processing. This field accepts an expression for dynamic generation."""
+
+    @field_serializer("aws_authentication_method")
+    def serialize_aws_authentication_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSecurityLakeAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSecurityLakeSignatureVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("tag_after_processing")
+    def serialize_tag_after_processing(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSecurityLakeTagAfterProcessing(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputsnmp.py

@@ -1,10 +1,14 @@
 """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 typing import Any, List, Optional
+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 InputSnmpConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSnmpMode(str, Enum):
+class InputSnmpMode(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 InputSnmpCompression(str, Enum):
+class InputSnmpCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSnmpPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSnmpPqControls(BaseModel):
+    pass
+
+
 class InputSnmpPqTypedDict(TypedDict):
     mode: NotRequired[InputSnmpMode]
     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 InputSnmpPqTypedDict(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[InputSnmpCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSnmpPqControlsTypedDict]
 
 
 class InputSnmpPq(BaseModel):
-    mode: Optional[InputSnmpMode] = InputSnmpMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSnmpMode], PlainValidator(validate_open_enum(False))
+    ] = InputSnmpMode.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,39 +98,109 @@ class InputSnmpPq(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[InputSnmpCompression] = InputSnmpCompression.NONE
+    compress: Annotated[
+        Optional[InputSnmpCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSnmpCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSnmpPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class AuthenticationProtocol(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSnmpMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSnmpCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSnmpAuthenticationProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
+    # None
     NONE = "none"
+    # MD5
     MD5 = "md5"
+    # SHA1
     SHA = "sha"
+    # SHA224
     SHA224 = "sha224"
+    # SHA256
     SHA256 = "sha256"
+    # SHA384
     SHA384 = "sha384"
+    # SHA512
     SHA512 = "sha512"
 
 
-class V3UserTypedDict(TypedDict):
-    name: str
-    auth_protocol: NotRequired[AuthenticationProtocol]
-    auth_key: NotRequired[Any]
-    priv_protocol: NotRequired[str]
+class PrivacyProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
+    # None
+    NONE = "none"
+    # DES
+    DES = "des"
+    # AES128
+    AES = "aes"
+    # AES256b (Blumenthal)
+    AES256B = "aes256b"
+    # AES256r (Reeder)
+    AES256R = "aes256r"
 
 
-class V3User(BaseModel):
+class InputSnmpV3UserTypedDict(TypedDict):
     name: str
+    auth_protocol: NotRequired[InputSnmpAuthenticationProtocol]
+    auth_key: NotRequired[str]
+    priv_protocol: NotRequired[PrivacyProtocol]
+    priv_key: NotRequired[str]
 
-    auth_protocol: Annotated[
-        Optional[AuthenticationProtocol], pydantic.Field(alias="authProtocol")
-    ] = AuthenticationProtocol.NONE
 
-    auth_key: Annotated[Optional[Any], pydantic.Field(alias="authKey")] = None
+class InputSnmpV3User(BaseModel):
+    name: str
 
-    priv_protocol: Annotated[Optional[str], pydantic.Field(alias="privProtocol")] = (
-        "none"
-    )
+    auth_protocol: Annotated[
+        Annotated[
+            Optional[InputSnmpAuthenticationProtocol],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authProtocol"),
+    ] = InputSnmpAuthenticationProtocol.NONE
+
+    auth_key: Annotated[Optional[str], pydantic.Field(alias="authKey")] = None
+
+    priv_protocol: Annotated[
+        Annotated[Optional[PrivacyProtocol], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="privProtocol"),
+    ] = PrivacyProtocol.NONE
+
+    priv_key: Annotated[Optional[str], pydantic.Field(alias="privKey")] = None
+
+    @field_serializer("auth_protocol")
+    def serialize_auth_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSnmpAuthenticationProtocol(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("priv_protocol")
+    def serialize_priv_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PrivacyProtocol(value)
+            except ValueError:
+                return value
+        return value
 
 
 class SNMPv3AuthenticationTypedDict(TypedDict):
@@ -120,7 +209,7 @@ class SNMPv3AuthenticationTypedDict(TypedDict):
     v3_auth_enabled: NotRequired[bool]
     allow_unmatched_trap: NotRequired[bool]
     r"""Pass through traps that don't match any of the configured users. @{product} will not attempt to decrypt these traps."""
-    v3_users: NotRequired[List[V3UserTypedDict]]
+    v3_users: NotRequired[List[InputSnmpV3UserTypedDict]]
     r"""User credentials for receiving v3 traps"""
 
 
@@ -136,7 +225,9 @@ class SNMPv3Authentication(BaseModel):
     ] = False
     r"""Pass through traps that don't match any of the configured users. @{product} will not attempt to decrypt these traps."""
 
-    v3_users: Annotated[Optional[List[V3User]], pydantic.Field(alias="v3Users")] = None
+    v3_users: Annotated[
+        Optional[List[InputSnmpV3User]], pydantic.Field(alias="v3Users")
+    ] = None
     r"""User credentials for receiving v3 traps"""
 
 
@@ -154,9 +245,9 @@ class InputSnmpMetadatum(BaseModel):
 
 
 class InputSnmpTypedDict(TypedDict):
+    type: InputSnmpType
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputSnmpType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -193,11 +284,11 @@ class InputSnmpTypedDict(TypedDict):
 
 
 class InputSnmp(BaseModel):
+    type: InputSnmpType
+
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputSnmpType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None