cribl-control-plane 0.0.39__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/inputprometheus.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 InputPrometheusConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputPrometheusMode(str, Enum):
+class InputPrometheusMode(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 InputPrometheusCompression(str, Enum):
+class InputPrometheusCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputPrometheusPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputPrometheusPqControls(BaseModel):
+    pass
+
+
 class InputPrometheusPqTypedDict(TypedDict):
     mode: NotRequired[InputPrometheusMode]
     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 InputPrometheusPqTypedDict(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[InputPrometheusCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputPrometheusPqControlsTypedDict]
 
 
 class InputPrometheusPq(BaseModel):
-    mode: Optional[InputPrometheusMode] = InputPrometheusMode.ALWAYS
+    mode: Annotated[
+        Optional[InputPrometheusMode], PlainValidator(validate_open_enum(False))
+    ] = InputPrometheusMode.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,20 +98,47 @@ class InputPrometheusPq(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[InputPrometheusCompression] = InputPrometheusCompression.NONE
+    compress: Annotated[
+        Optional[InputPrometheusCompression], PlainValidator(validate_open_enum(False))
+    ] = InputPrometheusCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputPrometheusPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputPrometheusDiscoveryType(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputPrometheusMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputPrometheusCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputPrometheusDiscoveryType(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"
 
 
-class InputPrometheusLogLevel(str, Enum):
-    r"""Collector runtime Log Level"""
+class InputPrometheusLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Collector runtime log level"""
 
     ERROR = "error"
     WARN = "warn"
@@ -113,52 +159,59 @@ class InputPrometheusMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputPrometheusAuthTypeAuthenticationMethod(str, Enum):
+class InputPrometheusAuthTypeAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
     r"""Enter credentials directly, or select a stored secret"""
 
     MANUAL = "manual"
     SECRET = "secret"
 
 
-class InputPrometheusRecordType(str, Enum):
-    r"""DNS Record type to resolve"""
+class InputPrometheusRecordType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""DNS record type to resolve"""
 
     SRV = "SRV"
     A = "A"
     AAAA = "AAAA"
 
 
-class MetricsProtocol(str, Enum):
+class MetricsProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Protocol to use when collecting metrics"""
 
     HTTP = "http"
     HTTPS = "https"
 
 
+class InputPrometheusAwsAuthenticationMethodAuthenticationMethod(
+    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 InputPrometheusSearchFilterTypedDict(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"""
+    r"""See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for information. Attributes can be manually entered if not present in the list."""
     values: List[str]
-    r"""Search Filter Values, if empty only \"running\" EC2 instances will be returned"""
+    r"""Values to match within this row's attribute. If empty, search will return only running EC2 instances."""
 
 
 class InputPrometheusSearchFilter(BaseModel):
     name: Annotated[str, pydantic.Field(alias="Name")]
-    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"""
+    r"""See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for information. Attributes can be manually entered if not present in the list."""
 
     values: Annotated[List[str], pydantic.Field(alias="Values")]
-    r"""Search Filter Values, if empty only \"running\" EC2 instances will be returned"""
-
+    r"""Values to match within this row's attribute. If empty, search will return only running EC2 instances."""
 
-class InputPrometheusAwsAuthenticationMethodAuthenticationMethod(str, Enum):
-    r"""AWS authentication method. Choose Auto to use IAM roles."""
 
-    AUTO = "auto"
-    MANUAL = "manual"
-    SECRET = "secret"
-
-
-class InputPrometheusSignatureVersion(str, Enum):
+class InputPrometheusSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Signature version to use for signing EC2 requests"""
 
     V2 = "v2"
@@ -188,11 +241,13 @@ class InputPrometheusTypedDict(TypedDict):
     discovery_type: NotRequired[InputPrometheusDiscoveryType]
     r"""Target discovery mechanism. Use static to manually enter a list of targets."""
     interval: NotRequired[float]
-    r"""How often in minutes to scrape targets for metrics, 60 must be evenly divisible by the value or save will fail."""
+    r"""How often, in minutes, to scrape targets for metrics. Maximum of 60 minutes. 60 must be evenly divisible by the value you enter."""
     log_level: NotRequired[InputPrometheusLogLevel]
-    r"""Collector runtime Log Level"""
+    r"""Collector runtime log level"""
     reject_unauthorized: NotRequired[bool]
     r"""Reject certificates that cannot be verified against a valid CA, such as self-signed certificates"""
+    timeout: NotRequired[float]
+    r"""Time, in seconds, before aborting HTTP connection attempts; use 0 for no timeout"""
     keep_alive_time: NotRequired[float]
     r"""How often workers should check in with the scheduler to keep job subscription alive"""
     job_timeout: NotRequired[str]
@@ -210,24 +265,27 @@ class InputPrometheusTypedDict(TypedDict):
     description: NotRequired[str]
     target_list: NotRequired[List[str]]
     r"""List of Prometheus targets to pull metrics from. Values can be in URL or host[:port] format. For example: http://localhost:9090/metrics, localhost:9090, or localhost. In cases where just host[:port] is specified, the endpoint will resolve to 'http://host[:port]/metrics'."""
+    record_type: NotRequired[InputPrometheusRecordType]
+    r"""DNS record type to resolve"""
+    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"""
-    record_type: NotRequired[InputPrometheusRecordType]
-    r"""DNS Record type to resolve"""
     scrape_protocol: NotRequired[MetricsProtocol]
     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[InputPrometheusSearchFilterTypedDict]]
-    r"""EC2 Instance Search Filter"""
     aws_authentication_method: NotRequired[
         InputPrometheusAwsAuthenticationMethodAuthenticationMethod
     ]
     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. Disable to use the private IP address."""
+    search_filter: NotRequired[List[InputPrometheusSearchFilterTypedDict]]
+    r"""Filter to apply when searching for EC2 instances"""
     aws_secret_key: NotRequired[str]
     region: NotRequired[str]
     r"""Region where the EC2 is located"""
@@ -289,23 +347,33 @@ class InputPrometheus(BaseModel):
     r"""Other dimensions to include in events"""
 
     discovery_type: Annotated[
-        Optional[InputPrometheusDiscoveryType], pydantic.Field(alias="discoveryType")
+        Annotated[
+            Optional[InputPrometheusDiscoveryType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="discoveryType"),
     ] = InputPrometheusDiscoveryType.STATIC
     r"""Target discovery mechanism. Use static to manually enter a list of targets."""
 
     interval: Optional[float] = 15
-    r"""How often in minutes to scrape targets for metrics, 60 must be evenly divisible by the value or save will fail."""
+    r"""How often, in minutes, to scrape targets for metrics. Maximum of 60 minutes. 60 must be evenly divisible by the value you enter."""
 
     log_level: Annotated[
-        Optional[InputPrometheusLogLevel], pydantic.Field(alias="logLevel")
+        Annotated[
+            Optional[InputPrometheusLogLevel], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="logLevel"),
     ] = InputPrometheusLogLevel.INFO
-    r"""Collector runtime Log Level"""
+    r"""Collector runtime log level"""
 
     reject_unauthorized: Annotated[
         Optional[bool], pydantic.Field(alias="rejectUnauthorized")
     ] = True
     r"""Reject certificates that cannot be verified against a valid CA, such as self-signed certificates"""
 
+    timeout: Optional[float] = 0
+    r"""Time, in seconds, before aborting HTTP connection attempts; use 0 for no timeout"""
+
     keep_alive_time: Annotated[
         Optional[float], pydantic.Field(alias="keepAliveTime")
     ] = 30
@@ -331,7 +399,10 @@ class InputPrometheus(BaseModel):
     r"""Fields to add to events from this input"""
 
     auth_type: Annotated[
-        Optional[InputPrometheusAuthTypeAuthenticationMethod],
+        Annotated[
+            Optional[InputPrometheusAuthTypeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="authType"),
     ] = InputPrometheusAuthTypeAuthenticationMethod.MANUAL
     r"""Enter credentials directly, or select a stored secret"""
@@ -343,16 +414,24 @@ class InputPrometheus(BaseModel):
     )
     r"""List of Prometheus targets to pull metrics from. Values can be in URL or host[:port] format. For example: http://localhost:9090/metrics, localhost:9090, or localhost. In cases where just host[:port] is specified, the endpoint will resolve to 'http://host[:port]/metrics'."""
 
-    name_list: Annotated[Optional[List[str]], pydantic.Field(alias="nameList")] = None
-    r"""List of DNS names to resolve"""
-
     record_type: Annotated[
-        Optional[InputPrometheusRecordType], pydantic.Field(alias="recordType")
+        Annotated[
+            Optional[InputPrometheusRecordType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="recordType"),
     ] = InputPrometheusRecordType.SRV
-    r"""DNS Record type to resolve"""
+    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[MetricsProtocol], pydantic.Field(alias="scrapeProtocol")
+        Annotated[Optional[MetricsProtocol], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="scrapeProtocol"),
     ] = MetricsProtocol.HTTP
     r"""Protocol to use when collecting metrics"""
 
@@ -361,23 +440,28 @@ class InputPrometheus(BaseModel):
     )
     r"""Path to use when collecting metrics from discovered targets"""
 
-    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."""
+    aws_authentication_method: Annotated[
+        Annotated[
+            Optional[InputPrometheusAwsAuthenticationMethodAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="awsAuthenticationMethod"),
+    ] = InputPrometheusAwsAuthenticationMethodAuthenticationMethod.AUTO
+    r"""AWS authentication method. Choose Auto to use IAM roles."""
 
-    scrape_port: Annotated[Optional[float], pydantic.Field(alias="scrapePort")] = 9090
-    r"""The port number in the metrics URL for discovered targets."""
+    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. Disable to use the private IP address."""
 
     search_filter: Annotated[
         Optional[List[InputPrometheusSearchFilter]],
         pydantic.Field(alias="searchFilter"),
     ] = None
-    r"""EC2 Instance Search Filter"""
-
-    aws_authentication_method: Annotated[
-        Optional[InputPrometheusAwsAuthenticationMethodAuthenticationMethod],
-        pydantic.Field(alias="awsAuthenticationMethod"),
-    ] = InputPrometheusAwsAuthenticationMethodAuthenticationMethod.AUTO
-    r"""AWS authentication method. Choose Auto to use IAM roles."""
+    r"""Filter to apply when searching for EC2 instances"""
 
     aws_secret_key: Annotated[Optional[str], pydantic.Field(alias="awsSecretKey")] = (
         None
@@ -390,7 +474,10 @@ class InputPrometheus(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[InputPrometheusSignatureVersion],
+        Annotated[
+            Optional[InputPrometheusSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="signatureVersion"),
     ] = InputPrometheusSignatureVersion.V4
     r"""Signature version to use for signing EC2 requests"""
@@ -430,3 +517,70 @@ class InputPrometheus(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.InputPrometheusDiscoveryType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("log_level")
+    def serialize_log_level(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputPrometheusLogLevel(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputPrometheusAuthTypeAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("record_type")
+    def serialize_record_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputPrometheusRecordType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("scrape_protocol")
+    def serialize_scrape_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.MetricsProtocol(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.InputPrometheusAwsAuthenticationMethodAuthenticationMethod(
+                        value
+                    )
+                )
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("signature_version")
+    def serialize_signature_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputPrometheusSignatureVersion(value)
+            except ValueError:
+                return value
+        return value