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

cribl_control_plane/models/functionconfschemanotificationpolicies.py

@@ -0,0 +1,129 @@
+"""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, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+class Operator(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Comparison operator"""
+
+    EQUAL = "="
+    NOT_EQUAL = "!="
+    REGEX_MATCH = "=~"
+    REGEX_NOT_MATCH = "!~"
+
+
+ValueTypedDict = TypeAliasType("ValueTypedDict", Union[str, float, bool])
+r"""Value to compare against (string, number, boolean)"""
+
+
+Value = TypeAliasType("Value", Union[str, float, bool])
+r"""Value to compare against (string, number, boolean)"""
+
+
+class ConditionTypedDict(TypedDict):
+    key: str
+    r"""Event field name to match against"""
+    operator: Operator
+    r"""Comparison operator"""
+    value: ValueTypedDict
+    r"""Value to compare against (string, number, boolean)"""
+
+
+class Condition(BaseModel):
+    key: str
+    r"""Event field name to match against"""
+
+    operator: Annotated[Operator, PlainValidator(validate_open_enum(False))]
+    r"""Comparison operator"""
+
+    value: Value
+    r"""Value to compare against (string, number, boolean)"""
+
+    @field_serializer("operator")
+    def serialize_operator(self, value):
+        if isinstance(value, str):
+            try:
+                return models.Operator(value)
+            except ValueError:
+                return value
+        return value
+
+
+class TemplateTargetPairTypedDict(TypedDict):
+    template_id: str
+    r"""ID of the notification template to use"""
+    target_id: str
+    r"""ID of the notification target (output)"""
+
+
+class TemplateTargetPair(BaseModel):
+    template_id: Annotated[str, pydantic.Field(alias="templateId")]
+    r"""ID of the notification template to use"""
+
+    target_id: Annotated[str, pydantic.Field(alias="targetId")]
+    r"""ID of the notification target (output)"""
+
+
+class PolicyTypedDict(TypedDict):
+    id: str
+    r"""Unique identifier for this policy"""
+    template_target_pairs: List[TemplateTargetPairTypedDict]
+    r"""List of targets to route to and the templates to use"""
+    disabled: NotRequired[bool]
+    r"""If true, this policy will be skipped during evaluation"""
+    wait_to_group: NotRequired[float]
+    r"""Time to wait (in minutes) to group similar alerts before sending"""
+    group_by_labels: NotRequired[List[str]]
+    r"""Event fields to use for grouping"""
+    conditions: NotRequired[List[List[ConditionTypedDict]]]
+    r"""List of conditions. If ANY condition matches (OR), the policy applies. Each condition is a list of tags that must ALL match (AND)."""
+    final: NotRequired[bool]
+    r"""If true, stop evaluating further policies after this one matches"""
+
+
+class Policy(BaseModel):
+    id: str
+    r"""Unique identifier for this policy"""
+
+    template_target_pairs: Annotated[
+        List[TemplateTargetPair], pydantic.Field(alias="templateTargetPairs")
+    ]
+    r"""List of targets to route to and the templates to use"""
+
+    disabled: Optional[bool] = False
+    r"""If true, this policy will be skipped during evaluation"""
+
+    wait_to_group: Annotated[Optional[float], pydantic.Field(alias="waitToGroup")] = (
+        None
+    )
+    r"""Time to wait (in minutes) to group similar alerts before sending"""
+
+    group_by_labels: Annotated[
+        Optional[List[str]], pydantic.Field(alias="groupByLabels")
+    ] = None
+    r"""Event fields to use for grouping"""
+
+    conditions: Optional[List[List[Condition]]] = None
+    r"""List of conditions. If ANY condition matches (OR), the policy applies. Each condition is a list of tags that must ALL match (AND)."""
+
+    final: Optional[bool] = False
+    r"""If true, stop evaluating further policies after this one matches"""
+
+
+class FunctionConfSchemaNotificationPoliciesTypedDict(TypedDict):
+    policies: NotRequired[List[PolicyTypedDict]]
+    r"""List of notification routing policies evaluated in order"""
+
+
+class FunctionConfSchemaNotificationPolicies(BaseModel):
+    policies: Optional[List[Policy]] = None
+    r"""List of notification routing policies evaluated in order"""

cribl_control_plane/models/functionconfschemanotifications.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class FunctionConfSchemaNotificationsTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""Notification ID"""
+    field: NotRequired[str]
+    r"""Notification event state field name"""
+    deduplicate: NotRequired[bool]
+    r"""Toggle deduplication."""
+
+
+class FunctionConfSchemaNotifications(BaseModel):
+    id: Optional[str] = None
+    r"""Notification ID"""
+
+    field: Optional[str] = None
+    r"""Notification event state field name"""
+
+    deduplicate: Optional[bool] = None
+    r"""Toggle deduplication."""

cribl_control_plane/models/functionconfschemanotify.py

@@ -0,0 +1,149 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionConfSchemaNotifyTriggerType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count"""
+
+    # Where
+    CUSTOM = "custom"
+    # Count of Results
+    RESULTS_COUNT = "resultsCount"
+
+
+class FunctionConfSchemaNotifyCountComparator(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Operation to be applied over the results count"""
+
+    # greater than
+    GREATER_THAN_ = ">"
+    # less than
+    LESS_THAN_ = "<"
+    # equals
+    EQUAL_EQUAL_EQUAL_ = "==="
+    # not equal to
+    NOT_EQUAL_EQUAL_ = "!=="
+    # greater than or equal to
+    GREATER_THAN_EQUAL_ = ">="
+    # less than or equal to
+    LESS_THAN_EQUAL_ = "<="
+
+
+class FunctionConfSchemaNotifyTypedDict(TypedDict):
+    group: NotRequired[str]
+    r"""Group the notification belongs to"""
+    notification_id: NotRequired[str]
+    r"""Workspace within the deployment to send the search results to."""
+    search_id: NotRequired[str]
+    r"""Id of the search this function is running on."""
+    saved_query_id: NotRequired[str]
+    r"""Id of the saved query"""
+    trigger: NotRequired[str]
+    r"""Js expression that filters events, a greater than 'Trigger Count' events will trigger the notification"""
+    trigger_type: NotRequired[FunctionConfSchemaNotifyTriggerType]
+    r"""Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count"""
+    trigger_comparator: NotRequired[FunctionConfSchemaNotifyCountComparator]
+    r"""Operation to be applied over the results count"""
+    trigger_count: NotRequired[float]
+    r"""How many results that match trigger the condition"""
+    results_limit: NotRequired[float]
+    r"""Number of results to include in the notification event"""
+    search_url: NotRequired[str]
+    r"""Url of the search results"""
+    message: NotRequired[str]
+    r"""Message content template, available fields: searchId, resultSet, savedQueryId, notificationId, searchResultsUrl"""
+    auth_token: NotRequired[str]
+    r"""Auth token for sending notification messages"""
+    messages_endpoint: NotRequired[str]
+    r"""System messages api endpoint"""
+    tenant_id: NotRequired[str]
+    r"""Current tenant id"""
+
+
+class FunctionConfSchemaNotify(BaseModel):
+    group: Optional[str] = "default"
+    r"""Group the notification belongs to"""
+
+    notification_id: Annotated[
+        Optional[str], pydantic.Field(alias="notificationId")
+    ] = "main"
+    r"""Workspace within the deployment to send the search results to."""
+
+    search_id: Annotated[Optional[str], pydantic.Field(alias="searchId")] = None
+    r"""Id of the search this function is running on."""
+
+    saved_query_id: Annotated[Optional[str], pydantic.Field(alias="savedQueryId")] = (
+        None
+    )
+    r"""Id of the saved query"""
+
+    trigger: Optional[str] = None
+    r"""Js expression that filters events, a greater than 'Trigger Count' events will trigger the notification"""
+
+    trigger_type: Annotated[
+        Annotated[
+            Optional[FunctionConfSchemaNotifyTriggerType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="triggerType"),
+    ] = None
+    r"""Type of the trigger condition. custom applies a kusto expression over the results, and results count applies a comparison over results count"""
+
+    trigger_comparator: Annotated[
+        Annotated[
+            Optional[FunctionConfSchemaNotifyCountComparator],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="triggerComparator"),
+    ] = None
+    r"""Operation to be applied over the results count"""
+
+    trigger_count: Annotated[Optional[float], pydantic.Field(alias="triggerCount")] = 0
+    r"""How many results that match trigger the condition"""
+
+    results_limit: Annotated[Optional[float], pydantic.Field(alias="resultsLimit")] = 50
+    r"""Number of results to include in the notification event"""
+
+    search_url: Annotated[Optional[str], pydantic.Field(alias="searchUrl")] = None
+    r"""Url of the search results"""
+
+    message: Optional[str] = None
+    r"""Message content template, available fields: searchId, resultSet, savedQueryId, notificationId, searchResultsUrl"""
+
+    auth_token: Annotated[Optional[str], pydantic.Field(alias="authToken")] = None
+    r"""Auth token for sending notification messages"""
+
+    messages_endpoint: Annotated[
+        Optional[str], pydantic.Field(alias="messagesEndpoint")
+    ] = None
+    r"""System messages api endpoint"""
+
+    tenant_id: Annotated[Optional[str], pydantic.Field(alias="tenantId")] = None
+    r"""Current tenant id"""
+
+    @field_serializer("trigger_type")
+    def serialize_trigger_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionConfSchemaNotifyTriggerType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("trigger_comparator")
+    def serialize_trigger_comparator(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionConfSchemaNotifyCountComparator(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/functionconfschemanumerify.py

@@ -0,0 +1,63 @@
+"""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
+
+
+class FunctionConfSchemaNumerifyFormat(str, Enum, metaclass=utils.OpenEnumMeta):
+    # None
+    NONE = "none"
+    # Fix
+    FIX = "fix"
+    # Floor
+    FLOOR = "floor"
+    # Ceil
+    CEIL = "ceil"
+
+
+class FunctionConfSchemaNumerifyTypedDict(TypedDict):
+    depth: NotRequired[int]
+    r"""Depth to which the Numerify Function will search within a nested event. Depth greater than 5 (the default) could decrease performance."""
+    ignore_fields: NotRequired[List[str]]
+    r"""Fields to NOT numerify. Takes precedence over 'Include expression' when set. Supports wildcards. A '!' before field name(s) means: numerify all fields EXCEPT these. For syntax details, see [Wildcard Lists](https://docs.cribl.io/stream/introduction-reference/#wildcard-lists)."""
+    filter_expr: NotRequired[str]
+    r"""Optional JavaScript expression to determine whether a field should be numerified. If left blank, all fields will be numerified. Use the 'name' and 'value' global variables to access fields' names/values. Examples: `value != null`, `name=='fieldname'`. You can access other fields' values via `__e.<fieldName>`."""
+    format_: NotRequired[FunctionConfSchemaNumerifyFormat]
+
+
+class FunctionConfSchemaNumerify(BaseModel):
+    depth: Optional[int] = 5
+    r"""Depth to which the Numerify Function will search within a nested event. Depth greater than 5 (the default) could decrease performance."""
+
+    ignore_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="ignoreFields")
+    ] = None
+    r"""Fields to NOT numerify. Takes precedence over 'Include expression' when set. Supports wildcards. A '!' before field name(s) means: numerify all fields EXCEPT these. For syntax details, see [Wildcard Lists](https://docs.cribl.io/stream/introduction-reference/#wildcard-lists)."""
+
+    filter_expr: Annotated[Optional[str], pydantic.Field(alias="filterExpr")] = None
+    r"""Optional JavaScript expression to determine whether a field should be numerified. If left blank, all fields will be numerified. Use the 'name' and 'value' global variables to access fields' names/values. Examples: `value != null`, `name=='fieldname'`. You can access other fields' values via `__e.<fieldName>`."""
+
+    format_: Annotated[
+        Annotated[
+            Optional[FunctionConfSchemaNumerifyFormat],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="format"),
+    ] = FunctionConfSchemaNumerifyFormat.NONE
+
+    @field_serializer("format_")
+    def serialize_format_(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionConfSchemaNumerifyFormat(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/functionconfschemaotlplogs.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionConfSchemaOtlpLogsTypedDict(TypedDict):
+    drop_non_log_events: NotRequired[bool]
+    batch_otlp_logs: NotRequired[bool]
+    r"""Batch OTLP log records by shared top-level `resource` attributes"""
+
+
+class FunctionConfSchemaOtlpLogs(BaseModel):
+    drop_non_log_events: Annotated[
+        Optional[bool], pydantic.Field(alias="dropNonLogEvents")
+    ] = False
+
+    batch_otlp_logs: Annotated[
+        Optional[bool], pydantic.Field(alias="batchOTLPLogs")
+    ] = False
+    r"""Batch OTLP log records by shared top-level `resource` attributes"""

cribl_control_plane/models/functionconfschemaotlpmetrics.py

@@ -0,0 +1,61 @@
+"""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
+
+
+class FunctionConfSchemaOTLPMetricsOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
+    # 0.10.0
+    ZERO_DOT_10_DOT_0 = "0.10.0"
+    # 1.3.1
+    ONE_DOT_3_DOT_1 = "1.3.1"
+
+
+class FunctionConfSchemaOtlpMetricsTypedDict(TypedDict):
+    resource_attribute_prefixes: NotRequired[List[str]]
+    r"""The prefixes of top-level attributes to add as resource attributes. Each attribute must match the regex pattern `^[a-zA-Z0-9_\.]+$`. Use Eval to copy nested attributes to the top level for matching."""
+    drop_non_metric_events: NotRequired[bool]
+    otlp_version: NotRequired[FunctionConfSchemaOTLPMetricsOTLPVersion]
+    batch_otlp_metrics: NotRequired[bool]
+    r"""Batch OTLP metrics by shared top-level `resource` attributes"""
+
+
+class FunctionConfSchemaOtlpMetrics(BaseModel):
+    resource_attribute_prefixes: Annotated[
+        Optional[List[str]], pydantic.Field(alias="resourceAttributePrefixes")
+    ] = None
+    r"""The prefixes of top-level attributes to add as resource attributes. Each attribute must match the regex pattern `^[a-zA-Z0-9_\.]+$`. Use Eval to copy nested attributes to the top level for matching."""
+
+    drop_non_metric_events: Annotated[
+        Optional[bool], pydantic.Field(alias="dropNonMetricEvents")
+    ] = False
+
+    otlp_version: Annotated[
+        Annotated[
+            Optional[FunctionConfSchemaOTLPMetricsOTLPVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="otlpVersion"),
+    ] = FunctionConfSchemaOTLPMetricsOTLPVersion.ZERO_DOT_10_DOT_0
+
+    batch_otlp_metrics: Annotated[
+        Optional[bool], pydantic.Field(alias="batchOTLPMetrics")
+    ] = False
+    r"""Batch OTLP metrics by shared top-level `resource` attributes"""
+
+    @field_serializer("otlp_version")
+    def serialize_otlp_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionConfSchemaOTLPMetricsOTLPVersion(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/functionconfschemaotlptraces.py

@@ -0,0 +1,54 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionConfSchemaOTLPTracesOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
+    # 0.10.0
+    ZERO_DOT_10_DOT_0 = "0.10.0"
+    # 1.3.1
+    ONE_DOT_3_DOT_1 = "1.3.1"
+
+
+class FunctionConfSchemaOtlpTracesTypedDict(TypedDict):
+    drop_non_trace_events: NotRequired[bool]
+    otlp_version: NotRequired[FunctionConfSchemaOTLPTracesOTLPVersion]
+    batch_otlp_traces: NotRequired[bool]
+    r"""Batch OTLP traces by shared top-level `resource` attributes"""
+
+
+class FunctionConfSchemaOtlpTraces(BaseModel):
+    drop_non_trace_events: Annotated[
+        Optional[bool], pydantic.Field(alias="dropNonTraceEvents")
+    ] = False
+
+    otlp_version: Annotated[
+        Annotated[
+            Optional[FunctionConfSchemaOTLPTracesOTLPVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="otlpVersion"),
+    ] = FunctionConfSchemaOTLPTracesOTLPVersion.ZERO_DOT_10_DOT_0
+
+    batch_otlp_traces: Annotated[
+        Optional[bool], pydantic.Field(alias="batchOTLPTraces")
+    ] = False
+    r"""Batch OTLP traces by shared top-level `resource` attributes"""
+
+    @field_serializer("otlp_version")
+    def serialize_otlp_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionConfSchemaOTLPTracesOTLPVersion(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/functionconfschemapack.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionConfSchemaPackTypedDict(TypedDict):
+    unpacked_fields: NotRequired[List[str]]
+    r"""List of fields to keep, everything else will be packed"""
+    target: NotRequired[str]
+    r"""Name of the (packed) target field"""
+
+
+class FunctionConfSchemaPack(BaseModel):
+    unpacked_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="unpackedFields")
+    ] = None
+    r"""List of fields to keep, everything else will be packed"""
+
+    target: Optional[str] = "_pack"
+    r"""Name of the (packed) target field"""

cribl_control_plane/models/functionconfschemapivot.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionConfSchemaPivotTypedDict(TypedDict):
+    label_field: NotRequired[str]
+    r"""Fields to be used for the left-most column."""
+    data_fields: NotRequired[List[str]]
+    r"""Fields with the cell values (i.e. aggregates)"""
+    qualifier_fields: NotRequired[List[str]]
+    r"""Fields to qualify or group data fields"""
+
+
+class FunctionConfSchemaPivot(BaseModel):
+    label_field: Annotated[Optional[str], pydantic.Field(alias="labelField")] = None
+    r"""Fields to be used for the left-most column."""
+
+    data_fields: Annotated[Optional[List[str]], pydantic.Field(alias="dataFields")] = (
+        None
+    )
+    r"""Fields with the cell values (i.e. aggregates)"""
+
+    qualifier_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="qualifierFields")
+    ] = None
+    r"""Fields to qualify or group data fields"""

cribl_control_plane/models/functionconfschemapublishmetrics.py

@@ -0,0 +1,98 @@
+"""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
+
+
+class FunctionConfSchemaPublishMetricsMetricType(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    # Counter
+    COUNTER = "counter"
+    # Timer
+    TIMER = "timer"
+    # Gauge
+    GAUGE = "gauge"
+    # Distribution
+    DISTRIBUTION = "distribution"
+    # Summary
+    SUMMARY = "summary"
+    # Histogram
+    HISTOGRAM = "histogram"
+
+
+class FunctionConfSchemaPublishMetricsFieldTypedDict(TypedDict):
+    in_field_name: str
+    r"""The name of the field in the event that contains the metric value"""
+    out_field_expr: NotRequired[str]
+    r"""JavaScript expression to evaluate the metric field name. Defaults to Event Field Name."""
+    metric_type: NotRequired[FunctionConfSchemaPublishMetricsMetricType]
+
+
+class FunctionConfSchemaPublishMetricsField(BaseModel):
+    in_field_name: Annotated[str, pydantic.Field(alias="inFieldName")]
+    r"""The name of the field in the event that contains the metric value"""
+
+    out_field_expr: Annotated[Optional[str], pydantic.Field(alias="outFieldExpr")] = (
+        None
+    )
+    r"""JavaScript expression to evaluate the metric field name. Defaults to Event Field Name."""
+
+    metric_type: Annotated[
+        Annotated[
+            Optional[FunctionConfSchemaPublishMetricsMetricType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="metricType"),
+    ] = FunctionConfSchemaPublishMetricsMetricType.GAUGE
+
+    @field_serializer("metric_type")
+    def serialize_metric_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionConfSchemaPublishMetricsMetricType(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionConfSchemaPublishMetricsTypedDict(TypedDict):
+    fields: NotRequired[List[FunctionConfSchemaPublishMetricsFieldTypedDict]]
+    r"""List of metrics from event to extract and format. Formatted metrics can be used by a destination to pass metrics to a metrics aggregation platform."""
+    overwrite: NotRequired[bool]
+    r"""Overwrite previous metric specs. Leave disabled to append."""
+    dimensions: NotRequired[List[str]]
+    r"""Optional list of dimensions to include in events. Wildcards supported. If you don't specify metrics, values will be appended to every metric found in the event. When you add a new metric, dimensions will be present only in those new metrics."""
+    remove_metrics: NotRequired[List[str]]
+    r"""Optional list of metric field names to look for when removing metrics. When a metric's field name matches an element in this list, the metric will be removed from the event."""
+    remove_dimensions: NotRequired[List[str]]
+    r"""Optional list of dimensions to remove from every metric found in the event. Wildcards supported."""
+
+
+class FunctionConfSchemaPublishMetrics(BaseModel):
+    fields: Optional[List[FunctionConfSchemaPublishMetricsField]] = None
+    r"""List of metrics from event to extract and format. Formatted metrics can be used by a destination to pass metrics to a metrics aggregation platform."""
+
+    overwrite: Optional[bool] = False
+    r"""Overwrite previous metric specs. Leave disabled to append."""
+
+    dimensions: Optional[List[str]] = None
+    r"""Optional list of dimensions to include in events. Wildcards supported. If you don't specify metrics, values will be appended to every metric found in the event. When you add a new metric, dimensions will be present only in those new metrics."""
+
+    remove_metrics: Annotated[
+        Optional[List[str]], pydantic.Field(alias="removeMetrics")
+    ] = None
+    r"""Optional list of metric field names to look for when removing metrics. When a metric's field name matches an element in this list, the metric will be removed from the event."""
+
+    remove_dimensions: Annotated[
+        Optional[List[str]], pydantic.Field(alias="removeDimensions")
+    ] = None
+    r"""Optional list of dimensions to remove from every metric found in the event. Wildcards supported."""