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

cribl_control_plane/models/inputrawudp.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 InputRawUDPConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputRawUDPMode(str, Enum):
+class InputRawUDPMode(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 InputRawUDPCompression(str, Enum):
+class InputRawUDPCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputRawUDPPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputRawUDPPqControls(BaseModel):
+    pass
+
+
 class InputRawUDPPqTypedDict(TypedDict):
     mode: NotRequired[InputRawUDPMode]
     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 InputRawUDPPqTypedDict(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[InputRawUDPCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputRawUDPPqControlsTypedDict]
 
 
 class InputRawUDPPq(BaseModel):
-    mode: Optional[InputRawUDPMode] = InputRawUDPMode.ALWAYS
+    mode: Annotated[
+        Optional[InputRawUDPMode], PlainValidator(validate_open_enum(False))
+    ] = InputRawUDPMode.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,9 +98,33 @@ class InputRawUDPPq(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[InputRawUDPCompression] = InputRawUDPCompression.NONE
+    compress: Annotated[
+        Optional[InputRawUDPCompression], PlainValidator(validate_open_enum(False))
+    ] = InputRawUDPCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputRawUDPPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputRawUDPMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputRawUDPCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputRawUDPMetadatumTypedDict(TypedDict):
     name: str
@@ -97,11 +140,11 @@ class InputRawUDPMetadatum(BaseModel):
 
 
 class InputRawUDPTypedDict(TypedDict):
+    type: InputRawUDPType
     port: float
     r"""Port to listen on"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputRawUDPType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -134,14 +177,14 @@ class InputRawUDPTypedDict(TypedDict):
 
 
 class InputRawUDP(BaseModel):
+    type: InputRawUDPType
+
     port: float
     r"""Port to listen on"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputRawUDPType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/inputs3.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 InputS3Connection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputS3Mode(str, Enum):
+class InputS3Mode(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 InputS3Compression(str, Enum):
+class InputS3Compression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputS3PqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputS3PqControls(BaseModel):
+    pass
+
+
 class InputS3PqTypedDict(TypedDict):
     mode: NotRequired[InputS3Mode]
     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 InputS3PqTypedDict(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[InputS3Compression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputS3PqControlsTypedDict]
 
 
 class InputS3Pq(BaseModel):
-    mode: Optional[InputS3Mode] = InputS3Mode.ALWAYS
+    mode: Annotated[
+        Optional[InputS3Mode], PlainValidator(validate_open_enum(False))
+    ] = InputS3Mode.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,46 @@ class InputS3Pq(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[InputS3Compression] = InputS3Compression.NONE
+    compress: Annotated[
+        Optional[InputS3Compression], PlainValidator(validate_open_enum(False))
+    ] = InputS3Compression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputS3PqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputS3AuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputS3Mode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputS3Compression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputS3AuthenticationMethod(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 InputS3SignatureVersion(str, Enum):
+class InputS3SignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing S3 requests"""
 
     V2 = "v2"
@@ -195,6 +241,8 @@ class InputS3TypedDict(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]
@@ -271,7 +319,10 @@ class InputS3(BaseModel):
     r"""SQS queue owner's AWS account ID. Leave empty if SQS queue is in same AWS account."""
 
     aws_authentication_method: Annotated[
-        Optional[InputS3AuthenticationMethod],
+        Annotated[
+            Optional[InputS3AuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = InputS3AuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -287,7 +338,10 @@ class InputS3(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[InputS3SignatureVersion], pydantic.Field(alias="signatureVersion")
+        Annotated[
+            Optional[InputS3SignatureVersion], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="signatureVersion"),
     ] = InputS3SignatureVersion.V4
     r"""Signature version to use for signing S3 requests"""
 
@@ -332,6 +386,11 @@ class InputS3(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
@@ -401,3 +460,21 @@ class InputS3(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.InputS3AuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputS3SignatureVersion(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputs3inventory.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 InputS3InventoryConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputS3InventoryMode(str, Enum):
+class InputS3InventoryMode(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 InputS3InventoryCompression(str, Enum):
+class InputS3InventoryCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputS3InventoryPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputS3InventoryPqControls(BaseModel):
+    pass
+
+
 class InputS3InventoryPqTypedDict(TypedDict):
     mode: NotRequired[InputS3InventoryMode]
     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 InputS3InventoryPqTypedDict(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[InputS3InventoryCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputS3InventoryPqControlsTypedDict]
 
 
 class InputS3InventoryPq(BaseModel):
-    mode: Optional[InputS3InventoryMode] = InputS3InventoryMode.ALWAYS
+    mode: Annotated[
+        Optional[InputS3InventoryMode], PlainValidator(validate_open_enum(False))
+    ] = InputS3InventoryMode.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,46 @@ class InputS3InventoryPq(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[InputS3InventoryCompression] = InputS3InventoryCompression.NONE
+    compress: Annotated[
+        Optional[InputS3InventoryCompression], PlainValidator(validate_open_enum(False))
+    ] = InputS3InventoryCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputS3InventoryPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputS3InventoryAuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputS3InventoryMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputS3InventoryCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputS3InventoryAuthenticationMethod(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 InputS3InventorySignatureVersion(str, Enum):
+class InputS3InventorySignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing S3 requests"""
 
     V2 = "v2"
@@ -144,7 +190,7 @@ class InputS3InventoryCheckpointing(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 InputS3InventoryTagAfterProcessing(str, Enum):
+class InputS3InventoryTagAfterProcessing(str, Enum, metaclass=utils.OpenEnumMeta):
     FALSE = "false"
     TRUE = "true"
 
@@ -200,6 +246,8 @@ class InputS3InventoryTypedDict(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]
@@ -279,7 +327,10 @@ class InputS3Inventory(BaseModel):
     r"""SQS queue owner's AWS account ID. Leave empty if SQS queue is in same AWS account."""
 
     aws_authentication_method: Annotated[
-        Optional[InputS3InventoryAuthenticationMethod],
+        Annotated[
+            Optional[InputS3InventoryAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = InputS3InventoryAuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -295,7 +346,10 @@ class InputS3Inventory(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[InputS3InventorySignatureVersion],
+        Annotated[
+            Optional[InputS3InventorySignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="signatureVersion"),
     ] = InputS3InventorySignatureVersion.V4
     r"""Signature version to use for signing S3 requests"""
@@ -341,6 +395,11 @@ class InputS3Inventory(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
@@ -409,7 +468,10 @@ class InputS3Inventory(BaseModel):
     r"""Select or create a stored secret that references your access key and secret key"""
 
     tag_after_processing: Annotated[
-        Optional[InputS3InventoryTagAfterProcessing],
+        Annotated[
+            Optional[InputS3InventoryTagAfterProcessing],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="tagAfterProcessing"),
     ] = None
 
@@ -422,3 +484,30 @@ class InputS3Inventory(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.InputS3InventoryAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputS3InventorySignatureVersion(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.InputS3InventoryTagAfterProcessing(value)
+            except ValueError:
+                return value
+        return value