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

cribl_control_plane/models/outputgooglecloudstorage.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,88 +16,122 @@ class OutputGoogleCloudStorageType(str, Enum):
     GOOGLE_CLOUD_STORAGE = "google_cloud_storage"
 
 
-class OutputGoogleCloudStorageSignatureVersion(str, Enum):
+class OutputGoogleCloudStorageSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing Google Cloud Storage requests"""
 
     V2 = "v2"
     V4 = "v4"
 
 
-class OutputGoogleCloudStorageAuthenticationMethod(str, Enum):
+class OutputGoogleCloudStorageAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    # auto
     AUTO = "auto"
+    # manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 
-class OutputGoogleCloudStorageObjectACL(str, Enum):
+class OutputGoogleCloudStorageObjectACL(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Object ACL to assign to uploaded objects"""
 
+    # private
     PRIVATE = "private"
+    # bucket-owner-read
     BUCKET_OWNER_READ = "bucket-owner-read"
+    # bucket-owner-full-control
     BUCKET_OWNER_FULL_CONTROL = "bucket-owner-full-control"
+    # project-private
     PROJECT_PRIVATE = "project-private"
+    # authenticated-read
     AUTHENTICATED_READ = "authenticated-read"
+    # public-read
     PUBLIC_READ = "public-read"
 
 
-class OutputGoogleCloudStorageStorageClass(str, Enum):
+class OutputGoogleCloudStorageStorageClass(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Storage class to select for uploaded objects"""
 
+    # Standard Storage
     STANDARD = "STANDARD"
+    # Nearline Storage
     NEARLINE = "NEARLINE"
+    # Coldline Storage
     COLDLINE = "COLDLINE"
+    # Archive Storage
     ARCHIVE = "ARCHIVE"
 
 
-class OutputGoogleCloudStorageDataFormat(str, Enum):
+class OutputGoogleCloudStorageDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
+    # JSON
     JSON = "json"
+    # Raw
     RAW = "raw"
+    # Parquet
     PARQUET = "parquet"
 
 
-class OutputGoogleCloudStorageBackpressureBehavior(str, Enum):
+class OutputGoogleCloudStorageBackpressureBehavior(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
-class OutputGoogleCloudStorageDiskSpaceProtection(str, Enum):
+class OutputGoogleCloudStorageDiskSpaceProtection(
+    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 OutputGoogleCloudStorageCompression(str, Enum):
+class OutputGoogleCloudStorageCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data compression format to apply to HTTP content before it is delivered"""
 
     NONE = "none"
     GZIP = "gzip"
 
 
-class OutputGoogleCloudStorageCompressionLevel(str, Enum):
+class OutputGoogleCloudStorageCompressionLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Compression level to apply before moving files to final destination"""
 
+    # Best Speed
     BEST_SPEED = "best_speed"
+    # Normal
     NORMAL = "normal"
+    # Best Compression
     BEST_COMPRESSION = "best_compression"
 
 
-class OutputGoogleCloudStorageParquetVersion(str, Enum):
+class OutputGoogleCloudStorageParquetVersion(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 OutputGoogleCloudStorageDataPageVersion(str, Enum):
+class OutputGoogleCloudStorageDataPageVersion(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"
 
 
@@ -109,13 +147,13 @@ class OutputGoogleCloudStorageKeyValueMetadatum(BaseModel):
 
 
 class OutputGoogleCloudStorageTypedDict(TypedDict):
+    type: OutputGoogleCloudStorageType
     bucket: str
     r"""Name of the destination bucket. This value can be a constant or a JavaScript expression that can only be evaluated at init time. Example of referencing a Global Variable: `myBucket-${C.vars.myVar}`."""
     region: str
     r"""Region where the bucket is located"""
     id: NotRequired[str]
     r"""Unique ID for this output"""
-    type: NotRequired[OutputGoogleCloudStorageType]
     pipeline: NotRequired[str]
     r"""Pipeline to process data before sending out to this output"""
     system_fields: NotRequired[List[str]]
@@ -132,7 +170,7 @@ class OutputGoogleCloudStorageTypedDict(TypedDict):
     stage_path: NotRequired[str]
     r"""Filesystem location in which to buffer files, before compressing and moving to final destination. Use performant and stable storage."""
     dest_path: NotRequired[str]
-    r"""Prefix to append to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
+    r"""Prefix to prepend to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
     verify_permissions: NotRequired[bool]
     r"""Disable if you can access files within the bucket but not the bucket itself"""
     object_acl: NotRequired[OutputGoogleCloudStorageObjectACL]
@@ -173,6 +211,8 @@ class OutputGoogleCloudStorageTypedDict(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[OutputGoogleCloudStorageDiskSpaceProtection]
     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."""
     description: NotRequired[str]
     compress: NotRequired[OutputGoogleCloudStorageCompression]
     r"""Data compression format to apply to HTTP content before it is delivered"""
@@ -180,6 +220,8 @@ class OutputGoogleCloudStorageTypedDict(TypedDict):
     r"""Compression level to apply before moving files to final destination"""
     automatic_schema: NotRequired[bool]
     r"""Automatically calculate the schema based on the events of each Parquet file generated"""
+    parquet_schema: NotRequired[str]
+    r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
     parquet_version: NotRequired[OutputGoogleCloudStorageParquetVersion]
     r"""Determines which data types are supported and how they are represented"""
     parquet_data_page_version: NotRequired[OutputGoogleCloudStorageDataPageVersion]
@@ -202,6 +244,8 @@ class OutputGoogleCloudStorageTypedDict(TypedDict):
     r"""Parquet tools can use the checksum of a Parquet page to verify data integrity"""
     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."""
     deadletter_path: NotRequired[str]
     r"""Storage location for files that fail to reach their final destination after maximum retries are exceeded"""
     max_retry_num: NotRequired[float]
@@ -215,6 +259,8 @@ class OutputGoogleCloudStorageTypedDict(TypedDict):
 
 
 class OutputGoogleCloudStorage(BaseModel):
+    type: OutputGoogleCloudStorageType
+
     bucket: str
     r"""Name of the destination bucket. This value can be a constant or a JavaScript expression that can only be evaluated at init time. Example of referencing a Global Variable: `myBucket-${C.vars.myVar}`."""
 
@@ -224,8 +270,6 @@ class OutputGoogleCloudStorage(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this output"""
 
-    type: Optional[OutputGoogleCloudStorageType] = None
-
     pipeline: Optional[str] = None
     r"""Pipeline to process data before sending out to this output"""
 
@@ -244,13 +288,19 @@ class OutputGoogleCloudStorage(BaseModel):
     r"""Google Cloud Storage service endpoint"""
 
     signature_version: Annotated[
-        Optional[OutputGoogleCloudStorageSignatureVersion],
+        Annotated[
+            Optional[OutputGoogleCloudStorageSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="signatureVersion"),
     ] = OutputGoogleCloudStorageSignatureVersion.V4
     r"""Signature version to use for signing Google Cloud Storage requests"""
 
     aws_authentication_method: Annotated[
-        Optional[OutputGoogleCloudStorageAuthenticationMethod],
+        Annotated[
+            Optional[OutputGoogleCloudStorageAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = OutputGoogleCloudStorageAuthenticationMethod.MANUAL
 
@@ -260,7 +310,7 @@ class OutputGoogleCloudStorage(BaseModel):
     r"""Filesystem location in which to buffer files, before compressing and moving to final destination. Use performant and stable storage."""
 
     dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = ""
-    r"""Prefix to append to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
+    r"""Prefix to prepend to files before uploading. Must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can be evaluated only at init time. Example referencing a Global Variable: `myKeyPrefix-${C.vars.myVar}`"""
 
     verify_permissions: Annotated[
         Optional[bool], pydantic.Field(alias="verifyPermissions")
@@ -268,12 +318,19 @@ class OutputGoogleCloudStorage(BaseModel):
     r"""Disable if you can access files within the bucket but not the bucket itself"""
 
     object_acl: Annotated[
-        Optional[OutputGoogleCloudStorageObjectACL], pydantic.Field(alias="objectACL")
+        Annotated[
+            Optional[OutputGoogleCloudStorageObjectACL],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="objectACL"),
     ] = OutputGoogleCloudStorageObjectACL.PRIVATE
     r"""Object ACL to assign to uploaded objects"""
 
     storage_class: Annotated[
-        Optional[OutputGoogleCloudStorageStorageClass],
+        Annotated[
+            Optional[OutputGoogleCloudStorageStorageClass],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="storageClass"),
     ] = None
     r"""Storage class to select for uploaded objects"""
@@ -304,7 +361,11 @@ class OutputGoogleCloudStorage(BaseModel):
     r"""JavaScript expression defining how files are partitioned and organized. Default is date-based. If blank, Stream will fall back to the event's __partition field value – if present – otherwise to each location's root directory."""
 
     format_: Annotated[
-        Optional[OutputGoogleCloudStorageDataFormat], pydantic.Field(alias="format")
+        Annotated[
+            Optional[OutputGoogleCloudStorageDataFormat],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="format"),
     ] = OutputGoogleCloudStorageDataFormat.JSON
     r"""Format of the output data"""
 
@@ -347,7 +408,10 @@ class OutputGoogleCloudStorage(BaseModel):
     r"""Buffer size used to write to a file"""
 
     on_backpressure: Annotated[
-        Optional[OutputGoogleCloudStorageBackpressureBehavior],
+        Annotated[
+            Optional[OutputGoogleCloudStorageBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputGoogleCloudStorageBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
@@ -358,20 +422,32 @@ class OutputGoogleCloudStorage(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[OutputGoogleCloudStorageDiskSpaceProtection],
+        Annotated[
+            Optional[OutputGoogleCloudStorageDiskSpaceProtection],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onDiskFullBackpressure"),
     ] = OutputGoogleCloudStorageDiskSpaceProtection.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."""
+
     description: Optional[str] = None
 
-    compress: Optional[OutputGoogleCloudStorageCompression] = (
-        OutputGoogleCloudStorageCompression.GZIP
-    )
+    compress: Annotated[
+        Optional[OutputGoogleCloudStorageCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = OutputGoogleCloudStorageCompression.GZIP
     r"""Data compression format to apply to HTTP content before it is delivered"""
 
     compression_level: Annotated[
-        Optional[OutputGoogleCloudStorageCompressionLevel],
+        Annotated[
+            Optional[OutputGoogleCloudStorageCompressionLevel],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="compressionLevel"),
     ] = OutputGoogleCloudStorageCompressionLevel.BEST_SPEED
     r"""Compression level to apply before moving files to final destination"""
@@ -381,14 +457,25 @@ class OutputGoogleCloudStorage(BaseModel):
     ] = False
     r"""Automatically calculate the schema based on the events of each Parquet file generated"""
 
+    parquet_schema: Annotated[Optional[str], pydantic.Field(alias="parquetSchema")] = (
+        None
+    )
+    r"""To add a new schema, navigate to Processing > Knowledge > Parquet Schemas"""
+
     parquet_version: Annotated[
-        Optional[OutputGoogleCloudStorageParquetVersion],
+        Annotated[
+            Optional[OutputGoogleCloudStorageParquetVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="parquetVersion"),
     ] = OutputGoogleCloudStorageParquetVersion.PARQUET_2_6
     r"""Determines which data types are supported and how they are represented"""
 
     parquet_data_page_version: Annotated[
-        Optional[OutputGoogleCloudStorageDataPageVersion],
+        Annotated[
+            Optional[OutputGoogleCloudStorageDataPageVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="parquetDataPageVersion"),
     ] = OutputGoogleCloudStorageDataPageVersion.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."""
@@ -434,6 +521,11 @@ class OutputGoogleCloudStorage(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."""
+
     deadletter_path: Annotated[
         Optional[str], pydantic.Field(alias="deadletterPath")
     ] = "$CRIBL_HOME/state/outputs/dead-letter"
@@ -452,3 +544,102 @@ class OutputGoogleCloudStorage(BaseModel):
 
     aws_secret: Annotated[Optional[str], pydantic.Field(alias="awsSecret")] = None
     r"""Select or create a stored secret that references your access key and secret key"""
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageSignatureVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("aws_authentication_method")
+    def serialize_aws_authentication_method(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("object_acl")
+    def serialize_object_acl(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageObjectACL(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("storage_class")
+    def serialize_storage_class(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageStorageClass(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("format_")
+    def serialize_format_(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageDataFormat(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageBackpressureBehavior(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.OutputGoogleCloudStorageDiskSpaceProtection(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageCompression(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compression_level")
+    def serialize_compression_level(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageCompressionLevel(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("parquet_version")
+    def serialize_parquet_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputGoogleCloudStorageParquetVersion(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.OutputGoogleCloudStorageDataPageVersion(value)
+            except ValueError:
+                return value
+        return value