cribl-control-plane 0.2.1rc7__py3-none-any.whl → 0.3.0a1__py3-none-any.whl

cribl_control_plane/models/outputfilesystem.py

@@ -1,12 +1,11 @@
 """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 import 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
@@ -19,29 +18,22 @@ class OutputFilesystemType(str, Enum):
 class OutputFilesystemDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
-    # JSON
     JSON = "json"
-    # Raw
     RAW = "raw"
-    # Parquet
     PARQUET = "parquet"
 
 
 class OutputFilesystemBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
 
 
 class OutputFilesystemDiskSpaceProtection(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"
 
 
@@ -55,31 +47,23 @@ class OutputFilesystemCompression(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputFilesystemCompressionLevel(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 OutputFilesystemParquetVersion(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 OutputFilesystemDataPageVersion(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"
 
 
@@ -147,8 +131,6 @@ class OutputFilesystemTypedDict(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[OutputFilesystemParquetVersion]
     r"""Determines which data types are supported and how they are represented"""
     parquet_data_page_version: NotRequired[OutputFilesystemDataPageVersion]
@@ -307,11 +289,6 @@ class OutputFilesystem(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[
         Annotated[
             Optional[OutputFilesystemParquetVersion],
@@ -378,66 +355,3 @@ class OutputFilesystem(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("format_")
-    def serialize_format_(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputFilesystemDataFormat(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_backpressure")
-    def serialize_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputFilesystemBackpressureBehavior(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.OutputFilesystemDiskSpaceProtection(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("compress")
-    def serialize_compress(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputFilesystemCompression(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("compression_level")
-    def serialize_compression_level(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputFilesystemCompressionLevel(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("parquet_version")
-    def serialize_parquet_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputFilesystemParquetVersion(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.OutputFilesystemDataPageVersion(value)
-            except ValueError:
-                return value
-        return value

cribl_control_plane/models/outputgooglechronicle.py

@@ -1,12 +1,11 @@
 """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 import 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
@@ -17,22 +16,16 @@ class OutputGoogleChronicleType(str, Enum):
 
 
 class OutputGoogleChronicleAPIVersion(str, Enum, metaclass=utils.OpenEnumMeta):
-    # V1
     V1 = "v1"
-    # V2
     V2 = "v2"
 
 
 class OutputGoogleChronicleAuthenticationMethod(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
-    # API key
     MANUAL = "manual"
-    # API key secret
     SECRET = "secret"
-    # Service account credentials
     SERVICE_ACCOUNT = "serviceAccount"
-    # Service account credentials secret
     SERVICE_ACCOUNT_SECRET = "serviceAccountSecret"
 
 
@@ -91,9 +84,7 @@ class OutputGoogleChronicleTimeoutRetrySettings(BaseModel):
 
 
 class SendEventsAs(str, Enum, metaclass=utils.OpenEnumMeta):
-    # Unstructured
     UNSTRUCTURED = "unstructured"
-    # UDM
     UDM = "udm"
 
 
@@ -113,11 +104,8 @@ class OutputGoogleChronicleFailedRequestLoggingMode(
 ):
     r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
 
-    # Payload
     PAYLOAD = "payload"
-    # Payload + Headers
     PAYLOAD_AND_HEADERS = "payloadAndHeaders"
-    # None
     NONE = "none"
 
 
@@ -126,11 +114,8 @@ class OutputGoogleChronicleBackpressureBehavior(
 ):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
-    # Persistent Queue
     QUEUE = "queue"
 
 
@@ -156,42 +141,28 @@ class OutputGoogleChronicleCustomLabel(BaseModel):
     value: str
 
 
-class UDMType(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""Defines the specific format for UDM events sent to Google SecOps. This must match the type of UDM data being sent."""
-
-    ENTITIES = "entities"
-    LOGS = "logs"
-
-
-class OutputGoogleChronicleMode(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
-
-    # Error
-    ERROR = "error"
-    # Backpressure
-    ALWAYS = "always"
-    # Always On
-    BACKPRESSURE = "backpressure"
-
-
 class OutputGoogleChronicleCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputGoogleChronicleQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
-    # Block
     BLOCK = "block"
-    # Drop new data
     DROP = "drop"
 
 
+class OutputGoogleChronicleMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
+
+    ERROR = "error"
+    BACKPRESSURE = "backpressure"
+    ALWAYS = "always"
+
+
 class OutputGoogleChroniclePqControlsTypedDict(TypedDict):
     pass
 
@@ -270,8 +241,6 @@ class OutputGoogleChronicleTypedDict(TypedDict):
     r"""User-configured environment namespace to identify the data domain the logs originated from. Use namespace as a tag to identify the appropriate data domain for indexing and enrichment functionality. Can be overwritten by event field __namespace."""
     custom_labels: NotRequired[List[OutputGoogleChronicleCustomLabelTypedDict]]
     r"""Custom labels to be added to every batch"""
-    udm_type: NotRequired[UDMType]
-    r"""Defines the specific format for UDM events sent to Google SecOps. This must match the type of UDM data being sent."""
     api_key: NotRequired[str]
     r"""Organization's API key in Google SecOps"""
     api_key_secret: NotRequired[str]
@@ -280,16 +249,6 @@ class OutputGoogleChronicleTypedDict(TypedDict):
     r"""Contents of service account credentials (JSON keys) file downloaded from Google Cloud. To upload a file, click the upload button at this field's upper right."""
     service_account_credentials_secret: NotRequired[str]
     r"""Select or create a stored text secret"""
-    pq_strict_ordering: NotRequired[bool]
-    r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
-    pq_rate_per_sec: NotRequired[float]
-    r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
-    pq_mode: NotRequired[OutputGoogleChronicleMode]
-    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
-    pq_max_buffer_size: NotRequired[float]
-    r"""The maximum number of events to hold in memory before writing the events to disk"""
-    pq_max_backpressure_sec: NotRequired[float]
-    r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
     pq_max_file_size: NotRequired[str]
     r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
     pq_max_size: NotRequired[str]
@@ -300,6 +259,8 @@ class OutputGoogleChronicleTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputGoogleChronicleQueueFullBehavior]
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
+    pq_mode: NotRequired[OutputGoogleChronicleMode]
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
     pq_controls: NotRequired[OutputGoogleChroniclePqControlsTypedDict]
 
 
@@ -461,12 +422,6 @@ class OutputGoogleChronicle(BaseModel):
     ] = None
     r"""Custom labels to be added to every batch"""
 
-    udm_type: Annotated[
-        Annotated[Optional[UDMType], PlainValidator(validate_open_enum(False))],
-        pydantic.Field(alias="udmType"),
-    ] = UDMType.LOGS
-    r"""Defines the specific format for UDM events sent to Google SecOps. This must match the type of UDM data being sent."""
-
     api_key: Annotated[Optional[str], pydantic.Field(alias="apiKey")] = None
     r"""Organization's API key in Google SecOps"""
 
@@ -485,35 +440,6 @@ class OutputGoogleChronicle(BaseModel):
     ] = None
     r"""Select or create a stored text secret"""
 
-    pq_strict_ordering: Annotated[
-        Optional[bool], pydantic.Field(alias="pqStrictOrdering")
-    ] = True
-    r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
-
-    pq_rate_per_sec: Annotated[
-        Optional[float], pydantic.Field(alias="pqRatePerSec")
-    ] = 0
-    r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
-
-    pq_mode: Annotated[
-        Annotated[
-            Optional[OutputGoogleChronicleMode],
-            PlainValidator(validate_open_enum(False)),
-        ],
-        pydantic.Field(alias="pqMode"),
-    ] = OutputGoogleChronicleMode.ERROR
-    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
-
-    pq_max_buffer_size: Annotated[
-        Optional[float], pydantic.Field(alias="pqMaxBufferSize")
-    ] = 42
-    r"""The maximum number of events to hold in memory before writing the events to disk"""
-
-    pq_max_backpressure_sec: Annotated[
-        Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
-    ] = 30
-    r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
-
     pq_max_file_size: Annotated[
         Optional[str], pydantic.Field(alias="pqMaxFileSize")
     ] = "1 MB"
@@ -545,87 +471,15 @@ class OutputGoogleChronicle(BaseModel):
     ] = OutputGoogleChronicleQueueFullBehavior.BLOCK
     r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
 
+    pq_mode: Annotated[
+        Annotated[
+            Optional[OutputGoogleChronicleMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputGoogleChronicleMode.ERROR
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
+
     pq_controls: Annotated[
         Optional[OutputGoogleChroniclePqControls], pydantic.Field(alias="pqControls")
     ] = None
-
-    @field_serializer("api_version")
-    def serialize_api_version(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGoogleChronicleAPIVersion(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("authentication_method")
-    def serialize_authentication_method(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGoogleChronicleAuthenticationMethod(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("log_format_type")
-    def serialize_log_format_type(self, value):
-        if isinstance(value, str):
-            try:
-                return models.SendEventsAs(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("failed_request_logging_mode")
-    def serialize_failed_request_logging_mode(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGoogleChronicleFailedRequestLoggingMode(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_backpressure")
-    def serialize_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGoogleChronicleBackpressureBehavior(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("udm_type")
-    def serialize_udm_type(self, value):
-        if isinstance(value, str):
-            try:
-                return models.UDMType(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_mode")
-    def serialize_pq_mode(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGoogleChronicleMode(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_compress")
-    def serialize_pq_compress(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGoogleChronicleCompression(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_on_backpressure")
-    def serialize_pq_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGoogleChronicleQueueFullBehavior(value)
-            except ValueError:
-                return value
-        return value