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

cribl_control_plane/models/outputgrafanacloud.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, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
@@ -19,9 +18,7 @@ class OutputGrafanaCloudType2(str, Enum):
 class OutputGrafanaCloudMessageFormat2(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
 
-    # Protobuf
     PROTOBUF = "protobuf"
-    # JSON
     JSON = "json"
 
 
@@ -39,15 +36,10 @@ class OutputGrafanaCloudLabel2(BaseModel):
 class OutputGrafanaCloudPrometheusAuthAuthenticationType2(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
-    # None
     NONE = "none"
-    # Auth token
     TOKEN = "token"
-    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
-    # Basic
     BASIC = "basic"
-    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -91,28 +83,14 @@ class OutputGrafanaCloudPrometheusAuth2(BaseModel):
     ] = None
     r"""Select or create a secret that references your credentials"""
 
-    @field_serializer("auth_type")
-    def serialize_auth_type(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudPrometheusAuthAuthenticationType2(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputGrafanaCloudLokiAuthAuthenticationType2(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
-    # None
     NONE = "none"
-    # Auth token
     TOKEN = "token"
-    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
-    # Basic
     BASIC = "basic"
-    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -156,15 +134,6 @@ class OutputGrafanaCloudLokiAuth2(BaseModel):
     ] = None
     r"""Select or create a secret that references your credentials"""
 
-    @field_serializer("auth_type")
-    def serialize_auth_type(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudLokiAuthAuthenticationType2(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputGrafanaCloudExtraHTTPHeader2TypedDict(TypedDict):
     value: str
@@ -182,11 +151,8 @@ class OutputGrafanaCloudFailedRequestLoggingMode2(
 ):
     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"
 
 
@@ -247,43 +213,33 @@ class OutputGrafanaCloudTimeoutRetrySettings2(BaseModel):
 class OutputGrafanaCloudBackpressureBehavior2(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
-    # Persistent Queue
     QUEUE = "queue"
 
 
-class OutputGrafanaCloudMode2(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 OutputGrafanaCloudCompression2(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputGrafanaCloudQueueFullBehavior2(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 OutputGrafanaCloudMode2(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 OutputGrafanaCloudPqControls2TypedDict(TypedDict):
     pass
 
@@ -357,16 +313,6 @@ class OutputGrafanaCloudGrafanaCloud2TypedDict(TypedDict):
     description: NotRequired[str]
     compress: NotRequired[bool]
     r"""Compress the payload body before sending. Applies only to JSON payloads; the Protobuf variant for both Prometheus and Loki are snappy-compressed by default."""
-    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[OutputGrafanaCloudMode2]
-    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]
@@ -377,6 +323,8 @@ class OutputGrafanaCloudGrafanaCloud2TypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputGrafanaCloudQueueFullBehavior2]
     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[OutputGrafanaCloudMode2]
+    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[OutputGrafanaCloudPqControls2TypedDict]
 
 
@@ -519,34 +467,6 @@ class OutputGrafanaCloudGrafanaCloud2(BaseModel):
     compress: Optional[bool] = True
     r"""Compress the payload body before sending. Applies only to JSON payloads; the Protobuf variant for both Prometheus and Loki are snappy-compressed by default."""
 
-    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[OutputGrafanaCloudMode2], PlainValidator(validate_open_enum(False))
-        ],
-        pydantic.Field(alias="pqMode"),
-    ] = OutputGrafanaCloudMode2.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"
@@ -578,64 +498,18 @@ class OutputGrafanaCloudGrafanaCloud2(BaseModel):
     ] = OutputGrafanaCloudQueueFullBehavior2.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[OutputGrafanaCloudMode2], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputGrafanaCloudMode2.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[OutputGrafanaCloudPqControls2], pydantic.Field(alias="pqControls")
     ] = None
 
-    @field_serializer("message_format")
-    def serialize_message_format(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudMessageFormat2(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.OutputGrafanaCloudFailedRequestLoggingMode2(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_backpressure")
-    def serialize_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudBackpressureBehavior2(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_mode")
-    def serialize_pq_mode(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudMode2(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_compress")
-    def serialize_pq_compress(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudCompression2(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.OutputGrafanaCloudQueueFullBehavior2(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputGrafanaCloudType1(str, Enum):
     GRAFANA_CLOUD = "grafana_cloud"
@@ -644,9 +518,7 @@ class OutputGrafanaCloudType1(str, Enum):
 class OutputGrafanaCloudMessageFormat1(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
 
-    # Protobuf
     PROTOBUF = "protobuf"
-    # JSON
     JSON = "json"
 
 
@@ -664,15 +536,10 @@ class OutputGrafanaCloudLabel1(BaseModel):
 class OutputGrafanaCloudPrometheusAuthAuthenticationType1(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
-    # None
     NONE = "none"
-    # Auth token
     TOKEN = "token"
-    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
-    # Basic
     BASIC = "basic"
-    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -716,28 +583,14 @@ class OutputGrafanaCloudPrometheusAuth1(BaseModel):
     ] = None
     r"""Select or create a secret that references your credentials"""
 
-    @field_serializer("auth_type")
-    def serialize_auth_type(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudPrometheusAuthAuthenticationType1(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputGrafanaCloudLokiAuthAuthenticationType1(
     str, Enum, metaclass=utils.OpenEnumMeta
 ):
-    # None
     NONE = "none"
-    # Auth token
     TOKEN = "token"
-    # Auth token (text secret)
     TEXT_SECRET = "textSecret"
-    # Basic
     BASIC = "basic"
-    # Basic (credentials secret)
     CREDENTIALS_SECRET = "credentialsSecret"
 
 
@@ -781,15 +634,6 @@ class OutputGrafanaCloudLokiAuth1(BaseModel):
     ] = None
     r"""Select or create a secret that references your credentials"""
 
-    @field_serializer("auth_type")
-    def serialize_auth_type(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudLokiAuthAuthenticationType1(value)
-            except ValueError:
-                return value
-        return value
-
 
 class OutputGrafanaCloudExtraHTTPHeader1TypedDict(TypedDict):
     value: str
@@ -807,11 +651,8 @@ class OutputGrafanaCloudFailedRequestLoggingMode1(
 ):
     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"
 
 
@@ -872,43 +713,33 @@ class OutputGrafanaCloudTimeoutRetrySettings1(BaseModel):
 class OutputGrafanaCloudBackpressureBehavior1(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    # Block
     BLOCK = "block"
-    # Drop
     DROP = "drop"
-    # Persistent Queue
     QUEUE = "queue"
 
 
-class OutputGrafanaCloudMode1(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 OutputGrafanaCloudCompression1(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
-    # None
     NONE = "none"
-    # Gzip
     GZIP = "gzip"
 
 
 class OutputGrafanaCloudQueueFullBehavior1(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 OutputGrafanaCloudMode1(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 OutputGrafanaCloudPqControls1TypedDict(TypedDict):
     pass
 
@@ -982,16 +813,6 @@ class OutputGrafanaCloudGrafanaCloud1TypedDict(TypedDict):
     description: NotRequired[str]
     compress: NotRequired[bool]
     r"""Compress the payload body before sending. Applies only to JSON payloads; the Protobuf variant for both Prometheus and Loki are snappy-compressed by default."""
-    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[OutputGrafanaCloudMode1]
-    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]
@@ -1002,6 +823,8 @@ class OutputGrafanaCloudGrafanaCloud1TypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputGrafanaCloudQueueFullBehavior1]
     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[OutputGrafanaCloudMode1]
+    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[OutputGrafanaCloudPqControls1TypedDict]
 
 
@@ -1146,34 +969,6 @@ class OutputGrafanaCloudGrafanaCloud1(BaseModel):
     compress: Optional[bool] = True
     r"""Compress the payload body before sending. Applies only to JSON payloads; the Protobuf variant for both Prometheus and Loki are snappy-compressed by default."""
 
-    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[OutputGrafanaCloudMode1], PlainValidator(validate_open_enum(False))
-        ],
-        pydantic.Field(alias="pqMode"),
-    ] = OutputGrafanaCloudMode1.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"
@@ -1205,64 +1000,18 @@ class OutputGrafanaCloudGrafanaCloud1(BaseModel):
     ] = OutputGrafanaCloudQueueFullBehavior1.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[OutputGrafanaCloudMode1], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputGrafanaCloudMode1.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[OutputGrafanaCloudPqControls1], pydantic.Field(alias="pqControls")
     ] = None
 
-    @field_serializer("message_format")
-    def serialize_message_format(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudMessageFormat1(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.OutputGrafanaCloudFailedRequestLoggingMode1(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("on_backpressure")
-    def serialize_on_backpressure(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudBackpressureBehavior1(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_mode")
-    def serialize_pq_mode(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudMode1(value)
-            except ValueError:
-                return value
-        return value
-
-    @field_serializer("pq_compress")
-    def serialize_pq_compress(self, value):
-        if isinstance(value, str):
-            try:
-                return models.OutputGrafanaCloudCompression1(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.OutputGrafanaCloudQueueFullBehavior1(value)
-            except ValueError:
-                return value
-        return value
-
 
 OutputGrafanaCloudTypedDict = TypeAliasType(
     "OutputGrafanaCloudTypedDict",