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

cribl_control_plane/models/inputsplunksearch.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 InputSplunkSearchConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSplunkSearchMode(str, Enum):
+class InputSplunkSearchMode(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 InputSplunkSearchCompression(str, Enum):
+class InputSplunkSearchCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSplunkSearchPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSplunkSearchPqControls(BaseModel):
+    pass
+
+
 class InputSplunkSearchPqTypedDict(TypedDict):
     mode: NotRequired[InputSplunkSearchMode]
     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 InputSplunkSearchPqTypedDict(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[InputSplunkSearchCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSplunkSearchPqControlsTypedDict]
 
 
 class InputSplunkSearchPq(BaseModel):
-    mode: Optional[InputSplunkSearchMode] = InputSplunkSearchMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSplunkSearchMode], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkSearchMode.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,11 +98,36 @@ class InputSplunkSearchPq(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[InputSplunkSearchCompression] = InputSplunkSearchCompression.NONE
+    compress: Annotated[
+        Optional[InputSplunkSearchCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputSplunkSearchCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSplunkSearchPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class OutputMode(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSplunkSearchOutputMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the returned output"""
 
     CSV = "csv"
@@ -116,7 +160,7 @@ class EndpointHeader(BaseModel):
     r"""JavaScript expression to compute the header's value, normally enclosed in backticks (e.g., `${earliest}`). If a constant, use single quotes (e.g., 'earliest'). Values without delimiters (e.g., earliest) are evaluated as strings."""
 
 
-class InputSplunkSearchLogLevel(str, Enum):
+class InputSplunkSearchLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Collector runtime log level (verbosity)"""
 
     ERROR = "error"
@@ -138,11 +182,14 @@ class InputSplunkSearchMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputSplunkSearchRetryType(str, Enum):
+class InputSplunkSearchRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 
@@ -166,7 +213,9 @@ class InputSplunkSearchRetryRulesTypedDict(TypedDict):
 
 
 class InputSplunkSearchRetryRules(BaseModel):
-    type: Optional[InputSplunkSearchRetryType] = InputSplunkSearchRetryType.BACKOFF
+    type: Annotated[
+        Optional[InputSplunkSearchRetryType], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkSearchRetryType.BACKOFF
     r"""The algorithm to use when performing HTTP retries"""
 
     interval: Optional[float] = 1000
@@ -196,8 +245,17 @@ class InputSplunkSearchRetryRules(BaseModel):
     ] = False
     r"""Retry request when a connection reset (ECONNRESET) error occurs"""
 
+    @field_serializer("type")
+    def serialize_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchRetryType(value)
+            except ValueError:
+                return value
+        return value
 
-class InputSplunkSearchAuthenticationType(str, Enum):
+
+class InputSplunkSearchAuthenticationType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Splunk Search authentication type"""
 
     NONE = "none"
@@ -239,11 +297,11 @@ class InputSplunkSearchOauthHeader(BaseModel):
 
 
 class InputSplunkSearchTypedDict(TypedDict):
+    type: InputSplunkSearchType
     search: str
     r"""Enter Splunk search here. Examples: 'index=myAppLogs level=error channel=myApp' OR '| mstats avg(myStat) as myStat WHERE index=myStatsIndex.'"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputSplunkSearchType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -268,7 +326,7 @@ class InputSplunkSearchTypedDict(TypedDict):
     r"""A cron schedule on which to run this job"""
     endpoint: NotRequired[str]
     r"""REST API used to create a search"""
-    output_mode: NotRequired[OutputMode]
+    output_mode: NotRequired[InputSplunkSearchOutputMode]
     r"""Format of the returned output"""
     endpoint_params: NotRequired[List[EndpointParamTypedDict]]
     r"""Optional request parameters to send to the endpoint"""
@@ -331,14 +389,14 @@ class InputSplunkSearchTypedDict(TypedDict):
 
 
 class InputSplunkSearch(BaseModel):
+    type: InputSplunkSearchType
+
     search: str
     r"""Enter Splunk search here. Examples: 'index=myAppLogs level=error channel=myApp' OR '| mstats avg(myStat) as myStat WHERE index=myStatsIndex.'"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputSplunkSearchType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -382,9 +440,13 @@ class InputSplunkSearch(BaseModel):
     endpoint: Optional[str] = "/services/search/v2/jobs/export"
     r"""REST API used to create a search"""
 
-    output_mode: Annotated[Optional[OutputMode], pydantic.Field(alias="outputMode")] = (
-        OutputMode.JSON
-    )
+    output_mode: Annotated[
+        Annotated[
+            Optional[InputSplunkSearchOutputMode],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="outputMode"),
+    ] = InputSplunkSearchOutputMode.JSON
     r"""Format of the returned output"""
 
     endpoint_params: Annotated[
@@ -398,7 +460,11 @@ class InputSplunkSearch(BaseModel):
     r"""Optional request headers to send to the endpoint"""
 
     log_level: Annotated[
-        Optional[InputSplunkSearchLogLevel], pydantic.Field(alias="logLevel")
+        Annotated[
+            Optional[InputSplunkSearchLogLevel],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="logLevel"),
     ] = None
     r"""Collector runtime log level (verbosity)"""
 
@@ -459,7 +525,11 @@ class InputSplunkSearch(BaseModel):
     r"""How long (in milliseconds) the Event Breaker will wait for new data to be sent to a specific channel before flushing the data stream out, as is, to the Pipelines"""
 
     auth_type: Annotated[
-        Optional[InputSplunkSearchAuthenticationType], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputSplunkSearchAuthenticationType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputSplunkSearchAuthenticationType.BASIC
     r"""Splunk Search authentication type"""
 
@@ -516,3 +586,30 @@ class InputSplunkSearch(BaseModel):
         pydantic.Field(alias="oauthHeaders"),
     ] = None
     r"""Additional headers to send in the OAuth login request. @{product} will automatically add the content-type header 'application/x-www-form-urlencoded' when sending this request."""
+
+    @field_serializer("output_mode")
+    def serialize_output_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchOutputMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("log_level")
+    def serialize_log_level(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchLogLevel(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkSearchAuthenticationType(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputsqs.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 InputSqsConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSqsMode(str, Enum):
+class InputSqsMode(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 InputSqsCompression(str, Enum):
+class InputSqsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSqsPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSqsPqControls(BaseModel):
+    pass
+
+
 class InputSqsPqTypedDict(TypedDict):
     mode: NotRequired[InputSqsMode]
     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 InputSqsPqTypedDict(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[InputSqsCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSqsPqControlsTypedDict]
 
 
 class InputSqsPq(BaseModel):
-    mode: Optional[InputSqsMode] = InputSqsMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSqsMode], PlainValidator(validate_open_enum(False))
+    ] = InputSqsMode.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,26 +98,55 @@ class InputSqsPq(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[InputSqsCompression] = InputSqsCompression.NONE
+    compress: Annotated[
+        Optional[InputSqsCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSqsCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSqsPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSqsQueueType(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSqsMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSqsCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSqsQueueType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The queue type used (or created)"""
 
+    # Standard
     STANDARD = "standard"
+    # FIFO
     FIFO = "fifo"
 
 
-class InputSqsAuthenticationMethod(str, Enum):
+class InputSqsAuthenticationMethod(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 InputSqsSignatureVersion(str, Enum):
+class InputSqsSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing SQS requests"""
 
     V2 = "v2"
@@ -119,11 +167,13 @@ class InputSqsMetadatum(BaseModel):
 
 
 class InputSqsTypedDict(TypedDict):
+    type: InputSqsType
     queue_name: str
     r"""The name, URL, or ARN of the SQS queue to read events from. When a non-AWS URL is specified, format must be: '{url}/myQueueName'. Example: 'https://host:port/myQueueName'. Value must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can only be evaluated at init time. Example referencing a Global Variable: `https://host:port/myQueue-${C.vars.myVar}`."""
+    queue_type: InputSqsQueueType
+    r"""The queue type used (or created)"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputSqsType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -138,8 +188,6 @@ class InputSqsTypedDict(TypedDict):
     connections: NotRequired[List[InputSqsConnectionTypedDict]]
     r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
     pq: NotRequired[InputSqsPqTypedDict]
-    queue_type: NotRequired[InputSqsQueueType]
-    r"""The queue type used (or created)"""
     aws_account_id: NotRequired[str]
     r"""SQS queue owner's AWS account ID. Leave empty if SQS queue is in same AWS account."""
     create_queue: NotRequired[bool]
@@ -182,14 +230,20 @@ class InputSqsTypedDict(TypedDict):
 
 
 class InputSqs(BaseModel):
+    type: InputSqsType
+
     queue_name: Annotated[str, pydantic.Field(alias="queueName")]
     r"""The name, URL, or ARN of the SQS queue to read events from. When a non-AWS URL is specified, format must be: '{url}/myQueueName'. Example: 'https://host:port/myQueueName'. Value must be a JavaScript expression (which can evaluate to a constant value), enclosed in quotes or backticks. Can only be evaluated at init time. Example referencing a Global Variable: `https://host:port/myQueue-${C.vars.myVar}`."""
 
+    queue_type: Annotated[
+        Annotated[InputSqsQueueType, PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="queueType"),
+    ]
+    r"""The queue type used (or created)"""
+
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputSqsType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -214,11 +268,6 @@ class InputSqs(BaseModel):
 
     pq: Optional[InputSqsPq] = None
 
-    queue_type: Annotated[
-        Optional[InputSqsQueueType], pydantic.Field(alias="queueType")
-    ] = InputSqsQueueType.STANDARD
-    r"""The queue type used (or created)"""
-
     aws_account_id: Annotated[Optional[str], pydantic.Field(alias="awsAccountId")] = (
         None
     )
@@ -228,7 +277,10 @@ class InputSqs(BaseModel):
     r"""Create queue if it does not exist"""
 
     aws_authentication_method: Annotated[
-        Optional[InputSqsAuthenticationMethod],
+        Annotated[
+            Optional[InputSqsAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="awsAuthenticationMethod"),
     ] = InputSqsAuthenticationMethod.AUTO
     r"""AWS authentication method. Choose Auto to use IAM roles."""
@@ -244,7 +296,11 @@ class InputSqs(BaseModel):
     r"""SQS service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to SQS-compatible endpoint."""
 
     signature_version: Annotated[
-        Optional[InputSqsSignatureVersion], pydantic.Field(alias="signatureVersion")
+        Annotated[
+            Optional[InputSqsSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="signatureVersion"),
     ] = InputSqsSignatureVersion.V4
     r"""Signature version to use for signing SQS requests"""
 
@@ -301,3 +357,30 @@ class InputSqs(BaseModel):
 
     num_receivers: Annotated[Optional[float], pydantic.Field(alias="numReceivers")] = 3
     r"""How many receiver processes to run. The higher the number, the better the throughput - at the expense of CPU overhead."""
+
+    @field_serializer("queue_type")
+    def serialize_queue_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSqsQueueType(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.InputSqsAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSqsSignatureVersion(value)
+            except ValueError:
+                return value
+        return value