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

cribl_control_plane/models/inputedgeprometheus.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 InputEdgePrometheusConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputEdgePrometheusMode(str, Enum):
+class InputEdgePrometheusMode(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 InputEdgePrometheusPqCompression(str, Enum):
+class InputEdgePrometheusPqCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputEdgePrometheusPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputEdgePrometheusPqControls(BaseModel):
+    pass
+
+
 class InputEdgePrometheusPqTypedDict(TypedDict):
     mode: NotRequired[InputEdgePrometheusMode]
     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 InputEdgePrometheusPqTypedDict(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[InputEdgePrometheusPqCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputEdgePrometheusPqControlsTypedDict]
 
 
 class InputEdgePrometheusPq(BaseModel):
-    mode: Optional[InputEdgePrometheusMode] = InputEdgePrometheusMode.ALWAYS
+    mode: Annotated[
+        Optional[InputEdgePrometheusMode], PlainValidator(validate_open_enum(False))
+    ] = InputEdgePrometheusMode.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,23 +98,53 @@ class InputEdgePrometheusPq(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[InputEdgePrometheusPqCompression] = (
-        InputEdgePrometheusPqCompression.NONE
-    )
+    compress: Annotated[
+        Optional[InputEdgePrometheusPqCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputEdgePrometheusPqCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputEdgePrometheusPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputEdgePrometheusDiscoveryType(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputEdgePrometheusMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputEdgePrometheusPqCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputEdgePrometheusDiscoveryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Target discovery mechanism. Use static to manually enter a list of targets."""
 
+    # Static
     STATIC = "static"
+    # DNS
     DNS = "dns"
+    # AWS EC2
     EC2 = "ec2"
+    # Kubernetes Node
     K8S_NODE = "k8s-node"
+    # Kubernetes Pods
     K8S_PODS = "k8s-pods"
 
 
-class InputEdgePrometheusPersistenceCompression(str, Enum):
+class InputEdgePrometheusPersistenceCompression(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Data compression format. Default is gzip."""
 
     NONE = "none"
@@ -128,11 +177,21 @@ class InputEdgePrometheusDiskSpooling(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[InputEdgePrometheusPersistenceCompression] = (
-        InputEdgePrometheusPersistenceCompression.GZIP
-    )
+    compress: Annotated[
+        Optional[InputEdgePrometheusPersistenceCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputEdgePrometheusPersistenceCompression.GZIP
     r"""Data compression format. Default is gzip."""
 
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputEdgePrometheusPersistenceCompression(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputEdgePrometheusMetadatumTypedDict(TypedDict):
     name: str
@@ -147,7 +206,9 @@ class InputEdgePrometheusMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputEdgePrometheusAuthTypeAuthenticationMethod(str, Enum):
+class InputEdgePrometheusAuthTypeAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Enter credentials directly, or select a stored secret"""
 
     MANUAL = "manual"
@@ -155,7 +216,7 @@ class InputEdgePrometheusAuthTypeAuthenticationMethod(str, Enum):
     KUBERNETES = "kubernetes"
 
 
-class InputEdgePrometheusTargetProtocol(str, Enum):
+class TargetProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Protocol to use when collecting metrics"""
 
     HTTP = "http"
@@ -165,7 +226,7 @@ class InputEdgePrometheusTargetProtocol(str, Enum):
 class TargetTypedDict(TypedDict):
     host: str
     r"""Name of host from which to pull metrics."""
-    protocol: NotRequired[InputEdgePrometheusTargetProtocol]
+    protocol: NotRequired[TargetProtocol]
     r"""Protocol to use when collecting metrics"""
     port: NotRequired[float]
     r"""The port number in the metrics URL for discovered targets."""
@@ -177,9 +238,9 @@ class Target(BaseModel):
     host: str
     r"""Name of host from which to pull metrics."""
 
-    protocol: Optional[InputEdgePrometheusTargetProtocol] = (
-        InputEdgePrometheusTargetProtocol.HTTP
-    )
+    protocol: Annotated[
+        Optional[TargetProtocol], PlainValidator(validate_open_enum(False))
+    ] = TargetProtocol.HTTP
     r"""Protocol to use when collecting metrics"""
 
     port: Optional[float] = 9090
@@ -188,8 +249,17 @@ class Target(BaseModel):
     path: Optional[str] = "/metrics"
     r"""Path to use when collecting metrics from discovered targets"""
 
+    @field_serializer("protocol")
+    def serialize_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.TargetProtocol(value)
+            except ValueError:
+                return value
+        return value
 
-class InputEdgePrometheusRecordType(str, Enum):
+
+class InputEdgePrometheusRecordType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""DNS Record type to resolve"""
 
     SRV = "SRV"
@@ -197,13 +267,26 @@ class InputEdgePrometheusRecordType(str, Enum):
     AAAA = "AAAA"
 
 
-class InputEdgePrometheusScrapeProtocolProtocol(str, Enum):
+class ScrapeProtocolProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Protocol to use when collecting metrics"""
 
     HTTP = "http"
     HTTPS = "https"
 
 
+class InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod(
+    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 InputEdgePrometheusSearchFilterTypedDict(TypedDict):
     name: str
     r"""Search filter attribute name, see: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for more information. Attributes can be manually entered if not present in the drop down list"""
@@ -219,15 +302,7 @@ class InputEdgePrometheusSearchFilter(BaseModel):
     r"""Search Filter Values, if empty only \"running\" EC2 instances will be returned"""
 
 
-class InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod(str, Enum):
-    r"""AWS authentication method. Choose Auto to use IAM roles."""
-
-    AUTO = "auto"
-    MANUAL = "manual"
-    SECRET = "secret"
-
-
-class InputEdgePrometheusSignatureVersion(str, Enum):
+class InputEdgePrometheusSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing EC2 requests"""
 
     V2 = "v2"
@@ -250,9 +325,9 @@ class PodFilter(BaseModel):
 
 
 class InputEdgePrometheusTypedDict(TypedDict):
+    type: InputEdgePrometheusType
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputEdgePrometheusType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -282,24 +357,27 @@ class InputEdgePrometheusTypedDict(TypedDict):
     r"""Enter credentials directly, or select a stored secret"""
     description: NotRequired[str]
     targets: NotRequired[List[TargetTypedDict]]
-    name_list: NotRequired[List[str]]
-    r"""List of DNS names to resolve"""
     record_type: NotRequired[InputEdgePrometheusRecordType]
     r"""DNS Record type to resolve"""
-    scrape_protocol: NotRequired[InputEdgePrometheusScrapeProtocolProtocol]
+    scrape_port: NotRequired[float]
+    r"""The port number in the metrics URL for discovered targets."""
+    name_list: NotRequired[List[str]]
+    r"""List of DNS names to resolve"""
+    scrape_protocol: NotRequired[ScrapeProtocolProtocol]
     r"""Protocol to use when collecting metrics"""
     scrape_path: NotRequired[str]
     r"""Path to use when collecting metrics from discovered targets"""
-    use_public_ip: NotRequired[bool]
-    r"""Use public IP address for discovered targets. Set to false if the private IP address should be used."""
-    scrape_port: NotRequired[float]
-    r"""The port number in the metrics URL for discovered targets."""
-    search_filter: NotRequired[List[InputEdgePrometheusSearchFilterTypedDict]]
-    r"""EC2 Instance Search Filter"""
     aws_authentication_method: NotRequired[
         InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod
     ]
     r"""AWS authentication method. Choose Auto to use IAM roles."""
+    aws_api_key: NotRequired[str]
+    aws_secret: NotRequired[str]
+    r"""Select or create a stored secret that references your access key and secret key"""
+    use_public_ip: NotRequired[bool]
+    r"""Use public IP address for discovered targets. Set to false if the private IP address should be used."""
+    search_filter: NotRequired[List[InputEdgePrometheusSearchFilterTypedDict]]
+    r"""EC2 Instance Search Filter"""
     aws_secret_key: NotRequired[str]
     region: NotRequired[str]
     r"""Region where the EC2 is located"""
@@ -340,11 +418,11 @@ class InputEdgePrometheusTypedDict(TypedDict):
 
 
 class InputEdgePrometheus(BaseModel):
+    type: InputEdgePrometheusType
+
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputEdgePrometheusType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -375,7 +453,10 @@ class InputEdgePrometheus(BaseModel):
     r"""Other dimensions to include in events"""
 
     discovery_type: Annotated[
-        Optional[InputEdgePrometheusDiscoveryType],
+        Annotated[
+            Optional[InputEdgePrometheusDiscoveryType],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="discoveryType"),
     ] = InputEdgePrometheusDiscoveryType.STATIC
     r"""Target discovery mechanism. Use static to manually enter a list of targets."""
@@ -392,7 +473,10 @@ class InputEdgePrometheus(BaseModel):
     r"""Fields to add to events from this input"""
 
     auth_type: Annotated[
-        Optional[InputEdgePrometheusAuthTypeAuthenticationMethod],
+        Annotated[
+            Optional[InputEdgePrometheusAuthTypeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="authType"),
     ] = InputEdgePrometheusAuthTypeAuthenticationMethod.MANUAL
     r"""Enter credentials directly, or select a stored secret"""
@@ -401,18 +485,27 @@ class InputEdgePrometheus(BaseModel):
 
     targets: Optional[List[Target]] = None
 
-    name_list: Annotated[Optional[List[str]], pydantic.Field(alias="nameList")] = None
-    r"""List of DNS names to resolve"""
-
     record_type: Annotated[
-        Optional[InputEdgePrometheusRecordType], pydantic.Field(alias="recordType")
+        Annotated[
+            Optional[InputEdgePrometheusRecordType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="recordType"),
     ] = InputEdgePrometheusRecordType.SRV
     r"""DNS Record type to resolve"""
 
+    scrape_port: Annotated[Optional[float], pydantic.Field(alias="scrapePort")] = 9090
+    r"""The port number in the metrics URL for discovered targets."""
+
+    name_list: Annotated[Optional[List[str]], pydantic.Field(alias="nameList")] = None
+    r"""List of DNS names to resolve"""
+
     scrape_protocol: Annotated[
-        Optional[InputEdgePrometheusScrapeProtocolProtocol],
+        Annotated[
+            Optional[ScrapeProtocolProtocol], PlainValidator(validate_open_enum(False))
+        ],
         pydantic.Field(alias="scrapeProtocol"),
-    ] = InputEdgePrometheusScrapeProtocolProtocol.HTTP
+    ] = ScrapeProtocolProtocol.HTTP
     r"""Protocol to use when collecting metrics"""
 
     scrape_path: Annotated[Optional[str], pydantic.Field(alias="scrapePath")] = (
@@ -420,24 +513,29 @@ class InputEdgePrometheus(BaseModel):
     )
     r"""Path to use when collecting metrics from discovered targets"""
 
+    aws_authentication_method: Annotated[
+        Annotated[
+            Optional[InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="awsAuthenticationMethod"),
+    ] = InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod.AUTO
+    r"""AWS authentication method. Choose Auto to use IAM roles."""
+
+    aws_api_key: Annotated[Optional[str], pydantic.Field(alias="awsApiKey")] = None
+
+    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"""
+
     use_public_ip: Annotated[Optional[bool], pydantic.Field(alias="usePublicIp")] = True
     r"""Use public IP address for discovered targets. Set to false if the private IP address should be used."""
 
-    scrape_port: Annotated[Optional[float], pydantic.Field(alias="scrapePort")] = 9090
-    r"""The port number in the metrics URL for discovered targets."""
-
     search_filter: Annotated[
         Optional[List[InputEdgePrometheusSearchFilter]],
         pydantic.Field(alias="searchFilter"),
     ] = None
     r"""EC2 Instance Search Filter"""
 
-    aws_authentication_method: Annotated[
-        Optional[InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod],
-        pydantic.Field(alias="awsAuthenticationMethod"),
-    ] = InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod.AUTO
-    r"""AWS authentication method. Choose Auto to use IAM roles."""
-
     aws_secret_key: Annotated[Optional[str], pydantic.Field(alias="awsSecretKey")] = (
         None
     )
@@ -449,7 +547,10 @@ class InputEdgePrometheus(BaseModel):
     r"""EC2 service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to EC2-compatible endpoint."""
 
     signature_version: Annotated[
-        Optional[InputEdgePrometheusSignatureVersion],
+        Annotated[
+            Optional[InputEdgePrometheusSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="signatureVersion"),
     ] = InputEdgePrometheusSignatureVersion.V4
     r"""Signature version to use for signing EC2 requests"""
@@ -518,3 +619,59 @@ class InputEdgePrometheus(BaseModel):
         Optional[str], pydantic.Field(alias="credentialsSecret")
     ] = None
     r"""Select or create a secret that references your credentials"""
+
+    @field_serializer("discovery_type")
+    def serialize_discovery_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputEdgePrometheusDiscoveryType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputEdgePrometheusAuthTypeAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("record_type")
+    def serialize_record_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputEdgePrometheusRecordType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("scrape_protocol")
+    def serialize_scrape_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.ScrapeProtocolProtocol(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.InputEdgePrometheusAwsAuthenticationMethodAuthenticationMethod(
+                    value
+                )
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputEdgePrometheusSignatureVersion(value)
+            except ValueError:
+                return value
+        return value