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

cribl_control_plane/models/inputkinesis.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
 
@@ -23,20 +27,32 @@ class InputKinesisConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputKinesisMode(str, Enum):
+class InputKinesisMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
-class InputKinesisCompression(str, Enum):
+class InputKinesisCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputKinesisPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputKinesisPqControls(BaseModel):
+    pass
+
+
 class InputKinesisPqTypedDict(TypedDict):
     mode: NotRequired[InputKinesisMode]
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
@@ -52,10 +68,13 @@ class InputKinesisPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputKinesisCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputKinesisPqControlsTypedDict]
 
 
 class InputKinesisPq(BaseModel):
-    mode: Optional[InputKinesisMode] = InputKinesisMode.ALWAYS
+    mode: Annotated[
+        Optional[InputKinesisMode], PlainValidator(validate_open_enum(False))
+    ] = InputKinesisMode.ALWAYS
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
     max_buffer_size: Annotated[
@@ -79,42 +98,77 @@ class InputKinesisPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputKinesisCompression] = InputKinesisCompression.NONE
+    compress: Annotated[
+        Optional[InputKinesisCompression], PlainValidator(validate_open_enum(False))
+    ] = InputKinesisCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputKinesisPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class ShardIteratorStart(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKinesisMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKinesisCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class ShardIteratorStart(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Location at which to start reading a shard for the first time"""
 
+    # Earliest record
     TRIM_HORIZON = "TRIM_HORIZON"
+    # Latest record
     LATEST = "LATEST"
 
 
-class InputKinesisRecordDataFormat(str, Enum):
+class InputKinesisRecordDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of data inside the Kinesis Stream records. Gzip compression is automatically detected."""
 
+    # Cribl
     CRIBL = "cribl"
+    # Newline JSON
     NDJSON = "ndjson"
+    # Cloudwatch Logs
     CLOUDWATCH = "cloudwatch"
+    # Event per line
     LINE = "line"
 
 
-class ShardLoadBalancing(str, Enum):
+class ShardLoadBalancing(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The load-balancing algorithm to use for spreading out shards across Workers and Worker Processes"""
 
+    # Consistent Hashing
     CONSISTENT_HASHING = "ConsistentHashing"
+    # Round Robin
     ROUND_ROBIN = "RoundRobin"
 
 
-class InputKinesisAuthenticationMethod(str, Enum):
+class InputKinesisAuthenticationMethod(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 InputKinesisSignatureVersion(str, Enum):
+class InputKinesisSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing Kinesis stream requests"""
 
     V2 = "v2"
@@ -135,13 +189,13 @@ class InputKinesisMetadatum(BaseModel):
 
 
 class InputKinesisTypedDict(TypedDict):
+    type: InputKinesisType
     stream_name: str
     r"""Kinesis Data Stream to read data from"""
     region: str
     r"""Region where the Kinesis stream is located"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputKinesisType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -202,6 +256,8 @@ class InputKinesisTypedDict(TypedDict):
 
 
 class InputKinesis(BaseModel):
+    type: InputKinesisType
+
     stream_name: Annotated[str, pydantic.Field(alias="streamName")]
     r"""Kinesis Data Stream to read data from"""
 
@@ -211,8 +267,6 @@ class InputKinesis(BaseModel):
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputKinesisType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -246,12 +300,19 @@ class InputKinesis(BaseModel):
     r"""A JavaScript expression to be called with each shardId for the stream. If the expression evaluates to a truthy value, the shard will be processed."""
 
     shard_iterator_type: Annotated[
-        Optional[ShardIteratorStart], pydantic.Field(alias="shardIteratorType")
+        Annotated[
+            Optional[ShardIteratorStart], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="shardIteratorType"),
     ] = ShardIteratorStart.TRIM_HORIZON
     r"""Location at which to start reading a shard for the first time"""
 
     payload_format: Annotated[
-        Optional[InputKinesisRecordDataFormat], pydantic.Field(alias="payloadFormat")
+        Annotated[
+            Optional[InputKinesisRecordDataFormat],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="payloadFormat"),
     ] = InputKinesisRecordDataFormat.CRIBL
     r"""Format of data inside the Kinesis Stream records. Gzip compression is automatically detected."""
 
@@ -266,12 +327,18 @@ class InputKinesis(BaseModel):
     r"""Maximum number of records, across all shards, to pull down at once per Worker Process"""
 
     load_balancing_algorithm: Annotated[
-        Optional[ShardLoadBalancing], pydantic.Field(alias="loadBalancingAlgorithm")
+        Annotated[
+            Optional[ShardLoadBalancing], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="loadBalancingAlgorithm"),
     ] = ShardLoadBalancing.CONSISTENT_HASHING
     r"""The load-balancing algorithm to use for spreading out shards across Workers and Worker Processes"""
 
     aws_authentication_method: Annotated[
-        Optional[InputKinesisAuthenticationMethod],
+        Annotated[
+            Optional[InputKinesisAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = InputKinesisAuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -284,7 +351,11 @@ class InputKinesis(BaseModel):
     r"""Kinesis stream service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to Kinesis stream-compatible endpoint."""
 
     signature_version: Annotated[
-        Optional[InputKinesisSignatureVersion], pydantic.Field(alias="signatureVersion")
+        Annotated[
+            Optional[InputKinesisSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="signatureVersion"),
     ] = InputKinesisSignatureVersion.V4
     r"""Signature version to use for signing Kinesis stream requests"""
 
@@ -337,3 +408,48 @@ class InputKinesis(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("shard_iterator_type")
+    def serialize_shard_iterator_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ShardIteratorStart(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("payload_format")
+    def serialize_payload_format(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKinesisRecordDataFormat(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("load_balancing_algorithm")
+    def serialize_load_balancing_algorithm(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ShardLoadBalancing(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.InputKinesisAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKinesisSignatureVersion(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputkubeevents.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
 
@@ -23,20 +27,32 @@ class InputKubeEventsConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputKubeEventsMode(str, Enum):
+class InputKubeEventsMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
-class InputKubeEventsCompression(str, Enum):
+class InputKubeEventsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputKubeEventsPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputKubeEventsPqControls(BaseModel):
+    pass
+
+
 class InputKubeEventsPqTypedDict(TypedDict):
     mode: NotRequired[InputKubeEventsMode]
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
@@ -52,10 +68,13 @@ class InputKubeEventsPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputKubeEventsCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputKubeEventsPqControlsTypedDict]
 
 
 class InputKubeEventsPq(BaseModel):
-    mode: Optional[InputKubeEventsMode] = InputKubeEventsMode.ALWAYS
+    mode: Annotated[
+        Optional[InputKubeEventsMode], PlainValidator(validate_open_enum(False))
+    ] = InputKubeEventsMode.ALWAYS
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
     max_buffer_size: Annotated[
@@ -79,9 +98,33 @@ class InputKubeEventsPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputKubeEventsCompression] = InputKubeEventsCompression.NONE
+    compress: Annotated[
+        Optional[InputKubeEventsCompression], PlainValidator(validate_open_enum(False))
+    ] = InputKubeEventsCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputKubeEventsPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKubeEventsMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKubeEventsCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputKubeEventsRuleTypedDict(TypedDict):
     filter_: str
@@ -112,9 +155,9 @@ class InputKubeEventsMetadatum(BaseModel):
 
 
 class InputKubeEventsTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this input"""
     type: InputKubeEventsType
+    id: NotRequired[str]
+    r"""Unique ID for this input"""
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -137,11 +180,11 @@ class InputKubeEventsTypedDict(TypedDict):
 
 
 class InputKubeEvents(BaseModel):
-    id: str
-    r"""Unique ID for this input"""
-
     type: InputKubeEventsType
 
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None

cribl_control_plane/models/inputkubelogs.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
 
@@ -23,20 +27,32 @@ class InputKubeLogsConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputKubeLogsMode(str, Enum):
+class InputKubeLogsMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
-class InputKubeLogsPqCompression(str, Enum):
+class InputKubeLogsPqCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputKubeLogsPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputKubeLogsPqControls(BaseModel):
+    pass
+
+
 class InputKubeLogsPqTypedDict(TypedDict):
     mode: NotRequired[InputKubeLogsMode]
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
@@ -52,10 +68,13 @@ class InputKubeLogsPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputKubeLogsPqCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputKubeLogsPqControlsTypedDict]
 
 
 class InputKubeLogsPq(BaseModel):
-    mode: Optional[InputKubeLogsMode] = InputKubeLogsMode.ALWAYS
+    mode: Annotated[
+        Optional[InputKubeLogsMode], PlainValidator(validate_open_enum(False))
+    ] = InputKubeLogsMode.ALWAYS
     r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
 
     max_buffer_size: Annotated[
@@ -79,9 +98,33 @@ class InputKubeLogsPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputKubeLogsPqCompression] = InputKubeLogsPqCompression.NONE
+    compress: Annotated[
+        Optional[InputKubeLogsPqCompression], PlainValidator(validate_open_enum(False))
+    ] = InputKubeLogsPqCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputKubeLogsPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKubeLogsMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKubeLogsPqCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputKubeLogsRuleTypedDict(TypedDict):
     filter_: str
@@ -111,7 +154,7 @@ class InputKubeLogsMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputKubeLogsPersistenceCompression(str, Enum):
+class InputKubeLogsPersistenceCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Data compression format. Default is gzip."""
 
     NONE = "none"
@@ -144,16 +187,26 @@ class InputKubeLogsDiskSpooling(BaseModel):
     max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
     r"""Maximum amount of time to retain data before older buckets are deleted. Examples: 2h, 4d. Default is 24h."""
 
-    compress: Optional[InputKubeLogsPersistenceCompression] = (
-        InputKubeLogsPersistenceCompression.GZIP
-    )
+    compress: Annotated[
+        Optional[InputKubeLogsPersistenceCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputKubeLogsPersistenceCompression.GZIP
     r"""Data compression format. Default is gzip."""
 
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputKubeLogsPersistenceCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputKubeLogsTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this input"""
     type: InputKubeLogsType
+    id: NotRequired[str]
+    r"""Unique ID for this input"""
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -187,11 +240,11 @@ class InputKubeLogsTypedDict(TypedDict):
 
 
 class InputKubeLogs(BaseModel):
-    id: str
-    r"""Unique ID for this input"""
-
     type: InputKubeLogsType
 
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None