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

cribl_control_plane/models/functionotlpmetrics.py

@@ -0,0 +1,118 @@
+"""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 Any, Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionOtlpMetricsID(str, Enum):
+    OTLP_METRICS = "otlp_metrics"
+
+
+class FunctionOTLPMetricsOTLPVersion(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 FunctionOtlpMetricsSchemaTypedDict(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[FunctionOTLPMetricsOTLPVersion]
+    batch_otlp_metrics: NotRequired[bool]
+    r"""Batch OTLP metrics by shared top-level `resource` attributes"""
+
+
+class FunctionOtlpMetricsSchema(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[FunctionOTLPMetricsOTLPVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="otlpVersion"),
+    ] = FunctionOTLPMetricsOTLPVersion.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.FunctionOTLPMetricsOTLPVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionOtlpMetricsTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionOtlpMetricsID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionOtlpMetricsSchemaTypedDict]
+
+
+class FunctionOtlpMetrics(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionOtlpMetricsID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[FunctionOtlpMetricsSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionotlptraces.py

@@ -0,0 +1,111 @@
+"""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 Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionOtlpTracesID(str, Enum):
+    OTLP_TRACES = "otlp_traces"
+
+
+class FunctionOTLPTracesOTLPVersion(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 FunctionOtlpTracesSchemaTypedDict(TypedDict):
+    drop_non_trace_events: NotRequired[bool]
+    otlp_version: NotRequired[FunctionOTLPTracesOTLPVersion]
+    batch_otlp_traces: NotRequired[bool]
+    r"""Batch OTLP traces by shared top-level `resource` attributes"""
+
+
+class FunctionOtlpTracesSchema(BaseModel):
+    drop_non_trace_events: Annotated[
+        Optional[bool], pydantic.Field(alias="dropNonTraceEvents")
+    ] = False
+
+    otlp_version: Annotated[
+        Annotated[
+            Optional[FunctionOTLPTracesOTLPVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="otlpVersion"),
+    ] = FunctionOTLPTracesOTLPVersion.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.FunctionOTLPTracesOTLPVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionOtlpTracesTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionOtlpTracesID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionOtlpTracesSchemaTypedDict]
+
+
+class FunctionOtlpTraces(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionOtlpTracesID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[FunctionOtlpTracesSchema], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionpack.py

@@ -0,0 +1,80 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionPackID(str, Enum):
+    PACK = "pack"
+
+
+class FunctionPackSchemaTypedDict(TypedDict):
+    unpacked_fields: List[str]
+    r"""List of fields to keep, everything else will be packed"""
+    target: NotRequired[str]
+    r"""Name of the (packed) target field"""
+
+
+class FunctionPackSchema(BaseModel):
+    unpacked_fields: Annotated[List[str], pydantic.Field(alias="unpackedFields")]
+    r"""List of fields to keep, everything else will be packed"""
+
+    target: Optional[str] = "_pack"
+    r"""Name of the (packed) target field"""
+
+
+class FunctionPackTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionPackID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionPackSchemaTypedDict]
+
+
+class FunctionPack(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionPackID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[Optional[FunctionPackSchema], pydantic.Field(alias="schema")] = (
+        None
+    )

cribl_control_plane/models/functionpivot.py

@@ -0,0 +1,85 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Any, Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionPivotID(str, Enum):
+    PIVOT = "pivot"
+
+
+class SimplePivotConfigurationTypedDict(TypedDict):
+    label_field: str
+    r"""Fields to be used for the left-most column."""
+    data_fields: List[str]
+    r"""Fields with the cell values (i.e. aggregates)"""
+    qualifier_fields: List[str]
+    r"""Fields to qualify or group data fields"""
+
+
+class SimplePivotConfiguration(BaseModel):
+    label_field: Annotated[str, pydantic.Field(alias="labelField")]
+    r"""Fields to be used for the left-most column."""
+
+    data_fields: Annotated[List[str], pydantic.Field(alias="dataFields")]
+    r"""Fields with the cell values (i.e. aggregates)"""
+
+    qualifier_fields: Annotated[List[str], pydantic.Field(alias="qualifierFields")]
+    r"""Fields to qualify or group data fields"""
+
+
+class FunctionPivotTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionPivotID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[SimplePivotConfigurationTypedDict]
+
+
+class FunctionPivot(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionPivotID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[SimplePivotConfiguration], pydantic.Field(alias="schema")
+    ] = None

cribl_control_plane/models/functionpublishmetrics.py

@@ -0,0 +1,153 @@
+"""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 Any, Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FunctionPublishMetricsID(str, Enum):
+    PUBLISH_METRICS = "publish_metrics"
+
+
+class FunctionPublishMetricsMetricType(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Counter
+    COUNTER = "counter"
+    # Timer
+    TIMER = "timer"
+    # Gauge
+    GAUGE = "gauge"
+    # Distribution
+    DISTRIBUTION = "distribution"
+    # Summary
+    SUMMARY = "summary"
+    # Histogram
+    HISTOGRAM = "histogram"
+
+
+class FunctionPublishMetricsFieldTypedDict(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[FunctionPublishMetricsMetricType]
+
+
+class FunctionPublishMetricsField(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[FunctionPublishMetricsMetricType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="metricType"),
+    ] = FunctionPublishMetricsMetricType.GAUGE
+
+    @field_serializer("metric_type")
+    def serialize_metric_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.FunctionPublishMetricsMetricType(value)
+            except ValueError:
+                return value
+        return value
+
+
+class FunctionPublishMetricsSchemaTypedDict(TypedDict):
+    fields: NotRequired[List[FunctionPublishMetricsFieldTypedDict]]
+    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 FunctionPublishMetricsSchema(BaseModel):
+    fields: Optional[List[FunctionPublishMetricsField]] = 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."""
+
+
+class FunctionPublishMetricsTypedDict(TypedDict):
+    filename: str
+    group: str
+    id: FunctionPublishMetricsID
+    load_time: float
+    mod_time: float
+    name: str
+    uischema: Dict[str, Any]
+    version: str
+    async_timeout: NotRequired[float]
+    cribl_version: NotRequired[str]
+    disabled: NotRequired[bool]
+    handle_signals: NotRequired[bool]
+    sync: NotRequired[bool]
+    schema_: NotRequired[FunctionPublishMetricsSchemaTypedDict]
+
+
+class FunctionPublishMetrics(BaseModel):
+    filename: Annotated[str, pydantic.Field(alias="__filename")]
+
+    group: str
+
+    id: FunctionPublishMetricsID
+
+    load_time: Annotated[float, pydantic.Field(alias="loadTime")]
+
+    mod_time: Annotated[float, pydantic.Field(alias="modTime")]
+
+    name: str
+
+    uischema: Dict[str, Any]
+
+    version: str
+
+    async_timeout: Annotated[Optional[float], pydantic.Field(alias="asyncTimeout")] = (
+        None
+    )
+
+    cribl_version: Optional[str] = None
+
+    disabled: Optional[bool] = None
+
+    handle_signals: Annotated[Optional[bool], pydantic.Field(alias="handleSignals")] = (
+        None
+    )
+
+    sync: Optional[bool] = None
+
+    schema_: Annotated[
+        Optional[FunctionPublishMetricsSchema], pydantic.Field(alias="schema")
+    ] = None