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

cribl_control_plane/models/outputsplunklb.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,21 +16,23 @@ class OutputSplunkLbType(str, Enum):
     SPLUNK_LB = "splunk_lb"
 
 
-class OutputSplunkLbNestedFieldSerialization(str, Enum):
+class OutputSplunkLbNestedFieldSerialization(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to serialize nested fields into index-time fields"""
 
+    # JSON
     JSON = "json"
+    # None
     NONE = "none"
 
 
-class OutputSplunkLbMinimumTLSVersion(str, Enum):
+class OutputSplunkLbMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class OutputSplunkLbMaximumTLSVersion(str, Enum):
+class OutputSplunkLbMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -86,45 +92,79 @@ class OutputSplunkLbTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[OutputSplunkLbMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[OutputSplunkLbMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[OutputSplunkLbMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[OutputSplunkLbMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
-
-class OutputSplunkLbMaxS2SVersion(str, Enum):
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class OutputSplunkLbMaxS2SVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The highest S2S protocol version to advertise during handshake"""
 
     V3 = "v3"
     V4 = "v4"
 
 
-class OutputSplunkLbBackpressureBehavior(str, Enum):
+class OutputSplunkLbBackpressureBehavior(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 OutputSplunkLbAuthenticationMethod(str, Enum):
+class OutputSplunkLbAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
     SECRET = "secret"
 
 
-class OutputSplunkLbCompressCompression(str, Enum):
+class OutputSplunkLbCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Controls whether the sender should send compressed data to the server. Select 'Disabled' to reject compressed connections or 'Always' to ignore server's configuration and send compressed data."""
 
+    # Disabled
     DISABLED = "disabled"
+    # Automatic
     AUTO = "auto"
+    # Always
     ALWAYS = "always"
 
 
-class IndexerDiscoveryConfigsAuthTokenAuthenticationMethod(str, Enum):
+class IndexerDiscoveryConfigsAuthTokenAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
@@ -134,17 +174,43 @@ class IndexerDiscoveryConfigsAuthTokenAuthenticationMethod(str, Enum):
 class OutputSplunkLbAuthTokenTypedDict(TypedDict):
     auth_type: NotRequired[IndexerDiscoveryConfigsAuthTokenAuthenticationMethod]
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
+    auth_token: NotRequired[str]
+    r"""Shared secret to be provided by any client (in authToken header field). If empty, unauthorized access is permitted."""
+    text_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
 
 
 class OutputSplunkLbAuthToken(BaseModel):
     auth_type: Annotated[
-        Optional[IndexerDiscoveryConfigsAuthTokenAuthenticationMethod],
+        Annotated[
+            Optional[IndexerDiscoveryConfigsAuthTokenAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="authType"),
     ] = IndexerDiscoveryConfigsAuthTokenAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
+    auth_token: Annotated[Optional[str], pydantic.Field(alias="authToken")] = ""
+    r"""Shared secret to be provided by any client (in authToken header field). If empty, unauthorized access is permitted."""
 
-class IndexerDiscoveryConfigsAuthenticationMethod(str, Enum):
+    text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
+    r"""Select or create a stored text secret"""
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.IndexerDiscoveryConfigsAuthTokenAuthenticationMethod(
+                    value
+                )
+            except ValueError:
+                return value
+        return value
+
+
+class IndexerDiscoveryConfigsAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
@@ -197,7 +263,10 @@ class IndexerDiscoveryConfigs(BaseModel):
     r"""Tokens required to authenticate to cluster manager for indexer discovery"""
 
     auth_type: Annotated[
-        Optional[IndexerDiscoveryConfigsAuthenticationMethod],
+        Annotated[
+            Optional[IndexerDiscoveryConfigsAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="authType"),
     ] = IndexerDiscoveryConfigsAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
@@ -208,8 +277,17 @@ class IndexerDiscoveryConfigs(BaseModel):
     text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
     r"""Select or create a stored text secret"""
 
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.IndexerDiscoveryConfigsAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
 
-class OutputSplunkLbTLS(str, Enum):
+class OutputSplunkLbTLS(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Whether to inherit TLS configs from group setting or disable TLS"""
 
     INHERIT = "inherit"
@@ -236,7 +314,9 @@ class OutputSplunkLbHost(BaseModel):
     port: Optional[float] = 9997
     r"""The port to connect to on the provided host"""
 
-    tls: Optional[OutputSplunkLbTLS] = OutputSplunkLbTLS.INHERIT
+    tls: Annotated[
+        Optional[OutputSplunkLbTLS], PlainValidator(validate_open_enum(False))
+    ] = OutputSplunkLbTLS.INHERIT
     r"""Whether to inherit TLS configs from group setting or disable TLS"""
 
     servername: Optional[str] = None
@@ -245,29 +325,45 @@ class OutputSplunkLbHost(BaseModel):
     weight: Optional[float] = 1
     r"""Assign a weight (>0) to each endpoint to indicate its traffic-handling capability"""
 
+    @field_serializer("tls")
+    def serialize_tls(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbTLS(value)
+            except ValueError:
+                return value
+        return value
 
-class OutputSplunkLbPqCompressCompression(str, Enum):
+
+class OutputSplunkLbMode(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 OutputSplunkLbPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
-class OutputSplunkLbQueueFullBehavior(str, Enum):
+class OutputSplunkLbQueueFullBehavior(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 OutputSplunkLbMode(str, Enum):
-    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 OutputSplunkLbPqControlsTypedDict(TypedDict):
     pass
 
@@ -330,6 +426,16 @@ class OutputSplunkLbTypedDict(TypedDict):
     r"""List of configurations to set up indexer discovery in Splunk Indexer clustering environment."""
     exclude_self: NotRequired[bool]
     r"""Exclude all IPs of the current host from the list of any resolved hostnames"""
+    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[OutputSplunkLbMode]
+    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]
@@ -340,8 +446,6 @@ class OutputSplunkLbTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputSplunkLbQueueFullBehavior]
     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[OutputSplunkLbMode]
-    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[OutputSplunkLbPqControlsTypedDict]
     auth_token: NotRequired[str]
     r"""Shared secret token to use when establishing a connection to a Splunk indexer."""
@@ -388,7 +492,10 @@ class OutputSplunkLb(BaseModel):
     r"""Maximum number of concurrent connections (per Worker Process). A random set of IPs will be picked on every DNS resolution period. Use 0 for unlimited."""
 
     nested_fields: Annotated[
-        Optional[OutputSplunkLbNestedFieldSerialization],
+        Annotated[
+            Optional[OutputSplunkLbNestedFieldSerialization],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="nestedFields"),
     ] = OutputSplunkLbNestedFieldSerialization.NONE
     r"""How to serialize nested fields into index-time fields"""
@@ -424,12 +531,19 @@ class OutputSplunkLb(BaseModel):
     r"""Use to troubleshoot issues with sending data"""
 
     max_s2_sversion: Annotated[
-        Optional[OutputSplunkLbMaxS2SVersion], pydantic.Field(alias="maxS2Sversion")
+        Annotated[
+            Optional[OutputSplunkLbMaxS2SVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxS2Sversion"),
     ] = OutputSplunkLbMaxS2SVersion.V3
     r"""The highest S2S protocol version to advertise during handshake"""
 
     on_backpressure: Annotated[
-        Optional[OutputSplunkLbBackpressureBehavior],
+        Annotated[
+            Optional[OutputSplunkLbBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputSplunkLbBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
@@ -445,7 +559,11 @@ class OutputSplunkLb(BaseModel):
     r"""How long (in milliseconds) each LB endpoint can report blocked before the Destination reports unhealthy, blocking the sender. (Grace period for fluctuations.) Use 0 to disable; max 1 minute."""
 
     auth_type: Annotated[
-        Optional[OutputSplunkLbAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[OutputSplunkLbAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = OutputSplunkLbAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
@@ -456,9 +574,10 @@ class OutputSplunkLb(BaseModel):
     ] = 1
     r"""Maximum number of times healthcheck can fail before we close connection. If set to 0 (disabled), and the connection to Splunk is forcibly closed, some data loss might occur."""
 
-    compress: Optional[OutputSplunkLbCompressCompression] = (
-        OutputSplunkLbCompressCompression.DISABLED
-    )
+    compress: Annotated[
+        Optional[OutputSplunkLbCompressCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = OutputSplunkLbCompressCompression.DISABLED
     r"""Controls whether the sender should send compressed data to the server. Select 'Disabled' to reject compressed connections or 'Always' to ignore server's configuration and send compressed data."""
 
     indexer_discovery_configs: Annotated[
@@ -470,6 +589,34 @@ class OutputSplunkLb(BaseModel):
     exclude_self: Annotated[Optional[bool], pydantic.Field(alias="excludeSelf")] = False
     r"""Exclude all IPs of the current host from the list of any resolved hostnames"""
 
+    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[OutputSplunkLbMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputSplunkLbMode.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"
@@ -484,22 +631,23 @@ class OutputSplunkLb(BaseModel):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
 
     pq_compress: Annotated[
-        Optional[OutputSplunkLbPqCompressCompression],
+        Annotated[
+            Optional[OutputSplunkLbPqCompressCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqCompress"),
     ] = OutputSplunkLbPqCompressCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputSplunkLbQueueFullBehavior],
+        Annotated[
+            Optional[OutputSplunkLbQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputSplunkLbQueueFullBehavior.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[Optional[OutputSplunkLbMode], pydantic.Field(alias="pqMode")] = (
-        OutputSplunkLbMode.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[OutputSplunkLbPqControls], pydantic.Field(alias="pqControls")
     ] = None
@@ -509,3 +657,75 @@ class OutputSplunkLb(BaseModel):
 
     text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
     r"""Select or create a stored text secret"""
+
+    @field_serializer("nested_fields")
+    def serialize_nested_fields(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbNestedFieldSerialization(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_s2_sversion")
+    def serialize_max_s2_sversion(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbMaxS2SVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbCompressCompression(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_mode")
+    def serialize_pq_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_compress")
+    def serialize_pq_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSplunkLbPqCompressCompression(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.OutputSplunkLbQueueFullBehavior(value)
+            except ValueError:
+                return value
+        return value