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

cribl_control_plane/models/outputsecuritylake.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
 
@@ -12,77 +16,108 @@ class OutputSecurityLakeType(str, Enum):
     SECURITY_LAKE = "security_lake"
 
 
-class OutputSecurityLakeAuthenticationMethod(str, Enum):
+class OutputSecurityLakeAuthenticationMethod(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 OutputSecurityLakeSignatureVersion(str, Enum):
+class OutputSecurityLakeSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing Amazon Security Lake requests"""
 
     V2 = "v2"
     V4 = "v4"
 
 
-class OutputSecurityLakeObjectACL(str, Enum):
+class OutputSecurityLakeObjectACL(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Object ACL to assign to uploaded objects"""
 
+    # Private
     PRIVATE = "private"
+    # Public Read Only
     PUBLIC_READ = "public-read"
+    # Public Read/Write
     PUBLIC_READ_WRITE = "public-read-write"
+    # Authenticated Read Only
     AUTHENTICATED_READ = "authenticated-read"
+    # AWS EC2 AMI Read Only
     AWS_EXEC_READ = "aws-exec-read"
+    # Bucket Owner Read Only
     BUCKET_OWNER_READ = "bucket-owner-read"
+    # Bucket Owner Full Control
     BUCKET_OWNER_FULL_CONTROL = "bucket-owner-full-control"
 
 
-class OutputSecurityLakeStorageClass(str, Enum):
+class OutputSecurityLakeStorageClass(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Storage class to select for uploaded objects"""
 
+    # Standard
     STANDARD = "STANDARD"
+    # Reduced Redundancy Storage
     REDUCED_REDUNDANCY = "REDUCED_REDUNDANCY"
+    # Standard, Infrequent Access
     STANDARD_IA = "STANDARD_IA"
+    # One Zone, Infrequent Access
     ONEZONE_IA = "ONEZONE_IA"
+    # Intelligent Tiering
     INTELLIGENT_TIERING = "INTELLIGENT_TIERING"
+    # Glacier Flexible Retrieval
     GLACIER = "GLACIER"
+    # Glacier Instant Retrieval
     GLACIER_IR = "GLACIER_IR"
+    # Glacier Deep Archive
     DEEP_ARCHIVE = "DEEP_ARCHIVE"
 
 
-class OutputSecurityLakeServerSideEncryptionForUploadedObjects(str, Enum):
+class OutputSecurityLakeServerSideEncryptionForUploadedObjects(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    # Amazon S3 Managed Key
     AES256 = "AES256"
+    # AWS KMS Managed Key
     AWS_KMS = "aws:kms"
 
 
-class OutputSecurityLakeBackpressureBehavior(str, Enum):
+class OutputSecurityLakeBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
-class OutputSecurityLakeDiskSpaceProtection(str, Enum):
+class OutputSecurityLakeDiskSpaceProtection(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
-class OutputSecurityLakeParquetVersion(str, Enum):
+class OutputSecurityLakeParquetVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Determines which data types are supported and how they are represented"""
 
+    # 1.0
     PARQUET_1_0 = "PARQUET_1_0"
+    # 2.4
     PARQUET_2_4 = "PARQUET_2_4"
+    # 2.6
     PARQUET_2_6 = "PARQUET_2_6"
 
 
-class OutputSecurityLakeDataPageVersion(str, Enum):
+class OutputSecurityLakeDataPageVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
 
+    # V1
     DATA_PAGE_V1 = "DATA_PAGE_V1"
+    # V2
     DATA_PAGE_V2 = "DATA_PAGE_V2"
 
 
@@ -98,6 +133,7 @@ class OutputSecurityLakeKeyValueMetadatum(BaseModel):
 
 
 class OutputSecurityLakeTypedDict(TypedDict):
+    type: OutputSecurityLakeType
     bucket: str
     r"""Name of the destination S3 bucket. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at initialization time. Example referencing a Global Variable: `myBucket-${C.vars.myVar}`"""
     region: str
@@ -110,7 +146,6 @@ class OutputSecurityLakeTypedDict(TypedDict):
     r"""Name of the custom source configured in Amazon Security Lake"""
     id: NotRequired[str]
     r"""Unique ID for this output"""
-    type: NotRequired[OutputSecurityLakeType]
     pipeline: NotRequired[str]
     r"""Pipeline to process data before sending out to this output"""
     system_fields: NotRequired[List[str]]
@@ -167,6 +202,8 @@ class OutputSecurityLakeTypedDict(TypedDict):
     r"""If a file fails to move to its final destination after the maximum number of retries, move it to a designated directory to prevent further errors"""
     on_disk_full_backpressure: NotRequired[OutputSecurityLakeDiskSpaceProtection]
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
+    force_close_on_shutdown: NotRequired[bool]
+    r"""Force all staged files to close during an orderly Node shutdown. This triggers immediate upload of in-progress data — regardless of idle time, file age, or size thresholds — to minimize data loss."""
     max_file_open_time_sec: NotRequired[float]
     r"""Maximum amount of time to write to a file. Files open for longer than this will be closed and moved to final output location."""
     max_file_idle_time_sec: NotRequired[float]
@@ -204,6 +241,8 @@ class OutputSecurityLakeTypedDict(TypedDict):
     r"""Select or create a stored secret that references your access key and secret key"""
     empty_dir_cleanup_sec: NotRequired[float]
     r"""How frequently, in seconds, to clean up empty directories"""
+    directory_batch_size: NotRequired[float]
+    r"""Number of directories to process in each batch during cleanup of empty directories. Minimum is 10, maximum is 10000. Higher values may require more memory."""
     parquet_schema: NotRequired[str]
     r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
     deadletter_path: NotRequired[str]
@@ -213,6 +252,8 @@ class OutputSecurityLakeTypedDict(TypedDict):
 
 
 class OutputSecurityLake(BaseModel):
+    type: OutputSecurityLakeType
+
     bucket: str
     r"""Name of the destination S3 bucket. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at initialization time. Example referencing a Global Variable: `myBucket-${C.vars.myVar}`"""
 
@@ -231,8 +272,6 @@ class OutputSecurityLake(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this output"""
 
-    type: Optional[OutputSecurityLakeType] = None
-
     pipeline: Optional[str] = None
     r"""Pipeline to process data before sending out to this output"""
 
@@ -252,7 +291,10 @@ class OutputSecurityLake(BaseModel):
     )
 
     aws_authentication_method: Annotated[
-        Optional[OutputSecurityLakeAuthenticationMethod],
+        Annotated[
+            Optional[OutputSecurityLakeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = OutputSecurityLakeAuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -261,7 +303,10 @@ class OutputSecurityLake(BaseModel):
     r"""Amazon Security Lake service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to Amazon Security Lake-compatible endpoint."""
 
     signature_version: Annotated[
-        Optional[OutputSecurityLakeSignatureVersion],
+        Annotated[
+            Optional[OutputSecurityLakeSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="signatureVersion"),
     ] = OutputSecurityLakeSignatureVersion.V4
     r"""Signature version to use for signing Amazon Security Lake requests"""
@@ -302,17 +347,28 @@ class OutputSecurityLake(BaseModel):
     r"""Add the Output ID value to staging location"""
 
     object_acl: Annotated[
-        Optional[OutputSecurityLakeObjectACL], pydantic.Field(alias="objectACL")
+        Annotated[
+            Optional[OutputSecurityLakeObjectACL],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="objectACL"),
     ] = OutputSecurityLakeObjectACL.PRIVATE
     r"""Object ACL to assign to uploaded objects"""
 
     storage_class: Annotated[
-        Optional[OutputSecurityLakeStorageClass], pydantic.Field(alias="storageClass")
+        Annotated[
+            Optional[OutputSecurityLakeStorageClass],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="storageClass"),
     ] = None
     r"""Storage class to select for uploaded objects"""
 
     server_side_encryption: Annotated[
-        Optional[OutputSecurityLakeServerSideEncryptionForUploadedObjects],
+        Annotated[
+            Optional[OutputSecurityLakeServerSideEncryptionForUploadedObjects],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="serverSideEncryption"),
     ] = None
 
@@ -348,7 +404,10 @@ class OutputSecurityLake(BaseModel):
     r"""Buffer size used to write to a file"""
 
     on_backpressure: Annotated[
-        Optional[OutputSecurityLakeBackpressureBehavior],
+        Annotated[
+            Optional[OutputSecurityLakeBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputSecurityLakeBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
@@ -359,11 +418,19 @@ class OutputSecurityLake(BaseModel):
     r"""If a file fails to move to its final destination after the maximum number of retries, move it to a designated directory to prevent further errors"""
 
     on_disk_full_backpressure: Annotated[
-        Optional[OutputSecurityLakeDiskSpaceProtection],
+        Annotated[
+            Optional[OutputSecurityLakeDiskSpaceProtection],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onDiskFullBackpressure"),
     ] = OutputSecurityLakeDiskSpaceProtection.BLOCK
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    force_close_on_shutdown: Annotated[
+        Optional[bool], pydantic.Field(alias="forceCloseOnShutdown")
+    ] = False
+    r"""Force all staged files to close during an orderly Node shutdown. This triggers immediate upload of in-progress data — regardless of idle time, file age, or size thresholds — to minimize data loss."""
+
     max_file_open_time_sec: Annotated[
         Optional[float], pydantic.Field(alias="maxFileOpenTimeSec")
     ] = 300
@@ -395,13 +462,19 @@ class OutputSecurityLake(BaseModel):
     r"""Automatically calculate the schema based on the events of each Parquet file generated"""
 
     parquet_version: Annotated[
-        Optional[OutputSecurityLakeParquetVersion],
+        Annotated[
+            Optional[OutputSecurityLakeParquetVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="parquetVersion"),
     ] = OutputSecurityLakeParquetVersion.PARQUET_2_6
     r"""Determines which data types are supported and how they are represented"""
 
     parquet_data_page_version: Annotated[
-        Optional[OutputSecurityLakeDataPageVersion],
+        Annotated[
+            Optional[OutputSecurityLakeDataPageVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="parquetDataPageVersion"),
     ] = OutputSecurityLakeDataPageVersion.DATA_PAGE_V2
     r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
@@ -455,6 +528,11 @@ class OutputSecurityLake(BaseModel):
     ] = 300
     r"""How frequently, in seconds, to clean up empty directories"""
 
+    directory_batch_size: Annotated[
+        Optional[float], pydantic.Field(alias="directoryBatchSize")
+    ] = 1000
+    r"""Number of directories to process in each batch during cleanup of empty directories. Minimum is 10, maximum is 10000. Higher values may require more memory."""
+
     parquet_schema: Annotated[Optional[str], pydantic.Field(alias="parquetSchema")] = (
         None
     )
@@ -467,3 +545,86 @@ class OutputSecurityLake(BaseModel):
 
     max_retry_num: Annotated[Optional[float], pydantic.Field(alias="maxRetryNum")] = 20
     r"""The maximum number of times a file will attempt to move to its final destination before being dead-lettered"""
+
+    @field_serializer("aws_authentication_method")
+    def serialize_aws_authentication_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeSignatureVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("object_acl")
+    def serialize_object_acl(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeObjectACL(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("storage_class")
+    def serialize_storage_class(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeStorageClass(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("server_side_encryption")
+    def serialize_server_side_encryption(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeServerSideEncryptionForUploadedObjects(
+                    value
+                )
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_disk_full_backpressure")
+    def serialize_on_disk_full_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeDiskSpaceProtection(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("parquet_version")
+    def serialize_parquet_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeParquetVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("parquet_data_page_version")
+    def serialize_parquet_data_page_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSecurityLakeDataPageVersion(value)
+            except ValueError:
+                return value
+        return value