hyperfluid 0.1.0__py3-none-any.whl

hyperfluid/models/create_airflow_connection_request.py

@@ -0,0 +1,56 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .permission_level import PermissionLevel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateAirflowConnectionRequest(BaseModel):
+    """The `CreateAirflowConnectionRequest` object."""
+
+    conn_id: str
+
+    bucket_ref: str | None | Unset = UNSET
+    """Name of the `HFBucket` to connect to, for a bucket connection."""
+
+    catalog: str | None | Unset = UNSET
+    """The Trino catalog every session on the connection opens against.
+    REQUIRED with `trino_ref`, and refused with either other target.
+
+    The session **default** for unqualified table names, and not a scope:
+    OPA decides every statement against the catalog of the table being
+    touched, so a DAG that writes `other_catalog.schema.table` in full
+    reaches it, bounded by the grants the environment's service account
+    already holds. Two connections on one dock naming different catalogs
+    therefore carry identical authority — this field is ergonomics, not
+    isolation.
+
+    Required rather than defaulted because `TrinoHook` falls back to
+    `catalog="hive"`, which exists on no Hyperfluid dock: a row without one
+    aims every query at something that is not there. The platform cannot
+    pick for the user either — a dock carries as many catalogs as the harbor
+    has data containers.
+
+    The charset is the CRD's own (`^[A-Za-z0-9_-]{1,63}$`) because the value
+    leaves as the `X-Trino-Catalog` header, and it is answered here with a
+    `400` rather than deferred to the Kubernetes API server: a `catalog`
+    the CEL rule refuses — `hive.default`, say, which is what a caller
+    reaching for `catalog.schema` writes first — comes back as a field
+    error naming the rule instead of an opaque failure."""
+
+    managed_postgresql_ref: str | None | Unset = UNSET
+    """Name of the `ManagedPostgreSQL` to connect to, for a Postgres
+    connection. Exactly one of this, `bucket_ref` and `trino_ref` is given,
+    and which one it is decides the connection's type."""
+
+    permission_level: PermissionLevel | None | Unset = UNSET
+
+    trino_ref: str | None | Unset = UNSET
+    """Name of the Trino `DataDock` to connect to, for a Trino connection.
+    Requires `catalog` beside it."""

hyperfluid/models/create_airflow_crd_request_body.py

@@ -0,0 +1,60 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .airflow_egress_request import AirflowEgressRequest
+    from .airflow_node_tier import AirflowNodeTier
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateAirflowCrdRequestBody(BaseModel):
+    """The `CreateAirflowCrdRequestBody` object."""
+
+    name: str
+    """Must be a valid slug: lowercase letters, digits, and hyphens only; cannot start or end with a hyphen."""
+
+    config: dict[str, str] | None | Unset = UNSET
+    """`airflow.cfg` overrides as `section.key` → value (rendered as
+    `AIRFLOW__SECTION__KEY`). Platform-owned keys — executor, auth,
+    execution API, database, remote logging, secrets backend — are refused
+    with a 400 listing them."""
+
+    dag_bucket_ref: str | None | Unset = UNSET
+    """Name of an existing bucket (in the Harbor namespace) to use for DAG
+    delivery. When omitted, the operator provisions a dedicated HFBucket
+    `{name}-airflow` (ADR-0021 §1)."""
+
+    description: str | None | Unset = UNSET
+    """Optional description (DB-only, not stored in the CRD)."""
+
+    egress: AirflowEgressRequest | None | Unset = UNSET
+
+    node_tier: AirflowNodeTier | None = None
+
+    postgres_ref: str | None | Unset = UNSET
+    """Name of an existing `ManagedPostgreSQL` (in the Harbor namespace) to host
+    Airflow's metadata DB. When omitted, the operator provisions a dedicated
+    `ManagedPostgreSQL`."""
+
+    runtime_image: str | None | Unset = UNSET
+    """Override the platform Airflow runtime image. When omitted, the
+    operator-default image is used."""
+
+    sleep_mode: bool | None = None
+    """Sleep mode: scale all components to 0 (schedules stop firing)."""
+
+    tags: list[str] | None = None
+    """User-defined tags (DB-only, not stored in the CRD)."""
+
+    task_quota_max_pods: int | None | Unset = UNSET
+    """`count/pods` ceiling for the environment's task namespace. Omitted or
+    `0` leaves the platform default in charge (nothing is persisted)."""
+
+    triggerer_enabled: bool | None = None
+    """Deferrable-operator (triggerer) support. Defaults to enabled
+    (ADR-0019 §2)."""

hyperfluid/models/create_api_key_request.py

@@ -0,0 +1,24 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateApiKeyRequest(BaseModel):
+    """The `CreateApiKeyRequest` object."""
+
+    name: str
+
+    expires_in_days: int | None | Unset = UNSET
+
+    max_llm_rpm: int | None | Unset = UNSET
+    """Optional per-key inference rate ceilings (ADR-0040) — how much of the
+    organization's own rate this key may use. Absent = no key-level ceiling;
+    the org's ceiling and the platform policy still apply."""
+
+    max_llm_tpm: int | None | Unset = UNSET
+
+    scopes: list[str] | None = None

hyperfluid/models/create_api_key_response.py

@@ -0,0 +1,27 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+from datetime import datetime
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateApiKeyResponse(BaseModel):
+    """The `CreateApiKeyResponse` object."""
+
+    created_at: datetime
+
+    id: UUID
+
+    key: str
+
+    key_prefix: str
+
+    name: str
+
+    scopes: list[str]
+
+    expires_at: datetime | None = None

hyperfluid/models/create_app_instance_crd_request_body.py

@@ -0,0 +1,26 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateAppInstanceCrdRequestBody(BaseModel):
+    """The `CreateAppInstanceCrdRequestBody` object."""
+
+    slug: str
+    """DNS-1123 slug — also the CRD object name in the org namespace, and the
+    initial display name (override later via `PATCH .../app-instances/{slug}`)."""
+
+    template_name: str
+    """Name of the `AppTemplate` to instantiate."""
+
+    template_version: str
+    """Semver version declared in `AppTemplate.spec.metadata.version`."""
+
+    parameters: t.Any = None
+    """Concrete parameter values. Keys must match `AppTemplate.spec.parameters[*].name`.
+    Validation against the declared parameter schema happens in the operator."""

hyperfluid/models/create_backup_target_crd_request_body.py

@@ -0,0 +1,36 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .backup_target_source_request import BackupTargetSourceRequest
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateBackupTargetCrdRequestBody(BaseModel):
+    """The `CreateBackupTargetCrdRequestBody` object."""
+
+    name: str
+    """Must be a valid slug: lowercase letters, digits, and hyphens only; cannot start or end with a hyphen."""
+
+    source: BackupTargetSourceRequest
+
+    description: str | None | Unset = UNSET
+    """Optional description (DB-only, not stored in CRD)"""
+
+    insecure: bool | None = None
+    """Skip TLS certificate verification when probing the S3 endpoint.
+    Intended for development (self-signed certs). Defaults to false.
+    Ignored for `internal` source, which is reached through the bucket's
+    own in-cluster storage gateway."""
+
+    retention_days: int | None | Unset = UNSET
+    """Days of backups and WAL archives to keep before expiring them, 1..=35.
+    Omitted means the platform default (7 days)."""
+
+    tags: list[str] | None = None
+    """User-defined tags (DB-only, not stored in CRD)"""

hyperfluid/models/create_compute_dock_crd_request_body.py

@@ -0,0 +1,68 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .auto_suspend_input import AutoSuspendInput
+    from .compute_engine_input import ComputeEngineInput
+    from .partition_input import PartitionInput
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateComputeDockCrdRequestBody(BaseModel):
+    """The `CreateComputeDockCrdRequestBody` object."""
+
+    name: str
+    """Must be a valid slug: lowercase letters, digits, and hyphens only; cannot
+    start or end with a hyphen."""
+
+    partitions: list[PartitionInput]
+    """Compute partitions. At least one is required."""
+
+    accounting_enabled: bool | None = None
+    """Whether to run `slurmdbd` accounting (`sacct` history). Off by default,
+    and only honoured on a cluster whose operator is configured with an
+    accounting database (ADR-0040)."""
+
+    auto_suspend: AutoSuspendInput | None | Unset = UNSET
+
+    description: str | None | Unset = UNSET
+    """Optional description (DB-only, not stored in the CRD)."""
+
+    enabled: bool | None = None
+    """When false, the operator suspends the cluster. Defaults to true."""
+
+    engine: ComputeEngineInput | None = None
+
+    home_size: str | None = None
+    """Shared `/home` volume size (K8s `Quantity`, e.g. `"20Gi"`)."""
+
+    home_storage_class: str | None | Unset = UNSET
+    """RWX StorageClass for `/home`. Falls back to the operator default."""
+
+    login_enabled: bool | None = None
+    """Whether to run an SSH login node. Defaults to true."""
+
+    login_replicas: int | None = None
+    """Number of load-balanced login replicas."""
+
+    oci_jobs: bool | None = None
+    """Let jobs run inside their own OCI image via Pyxis/enroot
+    (`srun --container-image=...`). Off by default (ADR-0041)."""
+
+    rest_api_enabled: bool | None = None
+    """Whether to run `slurmrestd` (REST submission). Defaults to true."""
+
+    rest_api_replicas: int | None = None
+    """Number of `slurmrestd` replicas."""
+
+    tags: list[str] | None = None
+    """User-defined tags (DB-only, not stored in the CRD)."""
+
+    version: str | None | Unset = UNSET
+    """Slinky image tag shared by all Slurm components. When omitted the
+    operator uses its configured default."""

hyperfluid/models/create_connector_ingest_request.py

@@ -0,0 +1,38 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .pipeline_metadata import PipelineMetadata
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateConnectorIngestRequest(BaseModel):
+    """Connector-based ingest pipeline request: run an opendata connector and load
+    the result into an Iceberg table in the Trino catalog of the destination
+    data container (`data_container_id`)."""
+
+    connector_slug: str
+    """Connector slug, e.g. `"world_bank"` or `"overture_places"`."""
+
+    data_container_id: UUID
+    """Destination Iceberg data container UUID; its Trino catalog receives the
+    table the connector data is loaded into."""
+
+    params: dict[str, t.Any]
+    """Connector-specific parameters as a JSON object.
+    The shape is described by the connector's `params_schema` field from the
+    `/api/v1/opendata/connectors` endpoint."""
+
+    pipeline: PipelineMetadata
+
+    schema_name: str
+    """Trino schema name for the destination table."""
+
+    table_name: str
+    """Trino table name to create (full-refresh each run)."""

hyperfluid/models/create_container_app_crd_request_body.py

@@ -0,0 +1,128 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .autoscaling_spec import AutoscalingSpec
+    from .container_app_metrics import ContainerAppMetrics
+    from .container_app_port_input import ContainerAppPortInput
+    from .custom_domain_input import CustomDomainInput
+    from .custom_resource_input import CustomResourceInput
+    from .env_var_input import EnvVarInput
+    from .file_mount_input import FileMountInput
+    from .image_source import ImageSource
+    from .init_container_input import InitContainerInput
+    from .persistence_input import PersistenceInput
+    from .resource_mode import ResourceMode
+    from .resource_tier import ResourceTier
+    from .secret_ref_input import SecretRefInput
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateContainerAppCrdRequestBody(BaseModel):
+    """The `CreateContainerAppCrdRequestBody` object."""
+
+    enabled: bool
+
+    name: str
+    """Display name shown in the console, at most 255 characters. Several apps
+    may share one; only `slug` is unique."""
+
+    alert_on_sync_failure: bool | None | Unset = UNSET
+    """With `image_source`: whether to create the default "Git sync failed"
+    alert rule. Absent means yes."""
+
+    args: list[str] | None = None
+    """Arguments passed to the main container's entrypoint. Empty (or omitted)
+    keeps the image's CMD."""
+
+    autoscaling: AutoscalingSpec | None | Unset = UNSET
+
+    command: list[str] | None = None
+    """Entrypoint of the main container. Empty (or omitted) keeps the image's
+    ENTRYPOINT."""
+
+    custom_domains: list[CustomDomainInput] | None = None
+    """Bring-your-own custom domains. Each FQDN's apex must have a `Verified`
+    `DomainVerification` for the operator to provision a route + cert; otherwise
+    the per-domain status sits in `PendingVerification` until the user completes
+    ownership verification."""
+
+    custom_resources: CustomResourceInput | None | Unset = UNSET
+
+    description: str | None | Unset = UNSET
+    """Free-text description, at most 1000 characters. A blank value is the
+    same as leaving it out."""
+
+    env: list[EnvVarInput] | None = None
+
+    expose_to_internet: bool | None = None
+    """Whether to create internet-facing routes (platform host route and custom-domain
+    routes) for this app. Defaults to `false` — new apps are private by default.
+    When `false`, the operator keeps the ClusterIP Service so the app is still
+    reachable in-cluster. Set to `true` to opt into a public endpoint explicitly."""
+
+    file_mounts: list[FileMountInput] | None = None
+    """Files to mount into the container at startup. Each entry is either an
+    inline literal or a reference to a platform secret. Inline content is
+    hard-capped at 8 KiB per file and 32 KiB total across all entries —
+    file mounts are for small configs, not data."""
+
+    health_check_path: str | None | Unset = UNSET
+
+    health_check_port: int | None | Unset = UNSET
+
+    image_pull_secrets: list[str] | None = None
+    """Names of secrets from the secret store to use as image pull secrets."""
+
+    image_repository: str | None = None
+    """Required unless `image_source` is set, and refused with it."""
+
+    image_source: ImageSource | None | Unset = UNSET
+
+    image_tag: str | None = None
+    """Required unless `image_source` is set, and refused with it."""
+
+    init_containers: list[InitContainerInput] | None = None
+    """Init containers, run to completion (in order) before the main
+    container starts. Each inherits the app's resolved env and persistent
+    volumes by default. Capped at 4 entries."""
+
+    metrics: ContainerAppMetrics | None | Unset = UNSET
+
+    persistence: list[PersistenceInput] | None = None
+    """Persistent volumes attached to the container. Each entry is reconciled
+    into a `PersistentVolumeClaim` owned by the `ContainerApp`. Capped at 8
+    entries. PVCs are always `ReadWriteOnce`; `size` and `storageClass` are
+    immutable after creation in v1 — volume expansion is not yet supported."""
+
+    port: int | None | Unset = UNSET
+    """**Deprecated — use `ports`.** Written to the CR only when supplied, so
+    a request that omits it leaves the field off the spec entirely."""
+
+    ports: list[ContainerAppPortInput] | None = None
+    """Ports the container listens on. When non-empty this replaces `port`.
+    Only the primary port gets a public route; the others are reachable
+    in-cluster through the app's Service."""
+
+    replicas: int | None = None
+
+    resource_mode: ResourceMode | None | Unset = UNSET
+
+    resource_tier: ResourceTier | None | Unset = UNSET
+
+    secret_refs: list[SecretRefInput] | None = None
+
+    slug: str | None | Unset = UNSET
+    """The app's identifier, unique in its environment, used in its URL and
+    Kubernetes resource names; it cannot change later. Lowercase letters,
+    digits and single hyphens, not starting or ending with a hyphen, at most
+    49 characters. Derived from `name` when omitted, so a `name` that is
+    already a valid slug is used as is."""
+
+    tags: list[str] | None = None
+    """Tags shown on the app: at most 20, none blank, each at most 64 characters."""

hyperfluid/models/create_context_enricher_pipeline_request.py

@@ -0,0 +1,27 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .classification_config import ClassificationConfig
+    from .metadata_storage_config import MetadataStorageConfig
+    from .pipeline_metadata import PipelineMetadata
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateContextEnricherPipelineRequest(BaseModel):
+    """Context Enricher pipeline request: enrich Iceberg table with L0/L1 abstracts via LLM.
+    Reads content (L2) from a source table, writes enriched rows (content + L0 + L1) to a destination table.
+    Enables lineage: object storage → OCR → ice_raw → hippocampe → ice_enriched"""
+
+    classification: ClassificationConfig
+
+    destination: MetadataStorageConfig
+
+    pipeline: PipelineMetadata
+
+    source: MetadataStorageConfig

hyperfluid/models/create_context_provider_body.py

@@ -0,0 +1,24 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateContextProviderBody(BaseModel):
+    """Request to create a context provider."""
+
+    config: t.Any
+    """Configuration JSON based on provider type"""
+
+    name: str
+
+    provider_type: str
+    """Provider type: "csv" or "http_api" """
+
+    enabled: bool | None | Unset = UNSET
+
+    sync_interval_seconds: int | None | Unset = UNSET

hyperfluid/models/create_contextual_restriction_body.py

@@ -0,0 +1,24 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import UNSET, BaseModel, Unset
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateContextualRestrictionBody(BaseModel):
+    """Request to create a contextual restriction."""
+
+    data_selector: t.Any
+
+    name: str
+
+    user_requirement: t.Any
+
+    description: str | None | Unset = UNSET
+
+    enabled: bool | None | Unset = UNSET
+
+    priority: int | None | Unset = UNSET

hyperfluid/models/create_copy_pipeline_request.py

@@ -0,0 +1,23 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+
+from ..serialization import BaseModel
+
+if t.TYPE_CHECKING:
+    from .copy_destination_config import CopyDestinationConfig
+    from .copy_source_config import CopySourceConfig
+    from .pipeline_metadata import PipelineMetadata
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateCopyPipelineRequest(BaseModel):
+    """Copy pipeline request: Import API source → S3 destination"""
+
+    destination: CopyDestinationConfig
+
+    pipeline: PipelineMetadata
+
+    source: CopySourceConfig

hyperfluid/models/create_dashboard_request.py

@@ -0,0 +1,31 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .dashboard_variable import DashboardVariable
+    from .dashboard_widget import DashboardWidget
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateDashboardRequest(BaseModel):
+    """The `CreateDashboardRequest` object."""
+
+    name: str
+
+    container_app_id: UUID | None | Unset = UNSET
+    """Attach the dashboard to a Container App of the same organization and
+    Harbor (issue #4727)."""
+
+    description: str | None | Unset = UNSET
+
+    refresh_interval_seconds: int | None | Unset = UNSET
+
+    variables: list[DashboardVariable] | None = None
+
+    widgets: list[DashboardWidget] | None = None

hyperfluid/models/create_data_dock_catalog_request.py

@@ -0,0 +1,63 @@
+# this file is @generated
+from __future__ import annotations
+
+import dataclasses
+import typing as t
+from uuid import UUID
+
+from ..serialization import UNSET, BaseModel, Unset
+
+if t.TYPE_CHECKING:
+    from .data_dock_catalog_kind import DataDockCatalogKind
+
+
+@dataclasses.dataclass(kw_only=True)
+class CreateDataDockCatalogRequest(BaseModel):
+    """Request body for `POST /api/v1/data-docks/{data_dock_id}/catalogs`.
+
+    Declaratively applies a `TrinoCatalog` CRD in the dock namespace. Returns
+    immediately with 201; the operator reconciles asynchronously.
+    `wait_for_trino_catalog_ready` is **never** called."""
+
+    kind: DataDockCatalogKind
+
+    name: str
+    """Catalog name — becomes both `metadata.name` and `spec.name` on the
+    `TrinoCatalog` CR. Must be a K8s RFC1123 DNS label: lowercase
+    alphanumeric + hyphens, no leading/trailing hyphens, ≤ 63 characters."""
+
+    bucket_name: str | None | Unset = UNSET
+    """`HFBucket` name that backs the Iceberg warehouse. Required when
+    `kind = Iceberg`; ignored for all other kinds."""
+
+    connection_secret_name: str | None | Unset = UNSET
+    """Organization secret holding the JSON credential bundle for a catalog
+    pointing at an **external** system. Required for every connector kind
+    the registry has a descriptor for, unless the kind is `Postgresql` and
+    `managed_postgresql_user_id` is given instead.
+
+    One field for all 29 external connectors of epic #3559, rather than one
+    optional field per connector: the bundle's *shape* is per-connector and
+    lives in the registry
+    (`GET /api/v1/organizations/{id}/trino/connectors`), not in this DTO.
+
+    The console reads the secret once, here, only to validate it against
+    that descriptor — so an unusable bundle is a 400 naming the field
+    rather than a `Terminal` condition the user discovers minutes later.
+    The value is never stored on the CR; the operator re-resolves it,
+    org-scoped, at every reconcile."""
+
+    managed_postgresql_user_id: UUID | None | Unset = UNSET
+    """Managed PostgreSQL user whose credentials back the catalog. Valid
+    **only** when `kind = Postgresql`, where it is one of the two accepted
+    credential sources (the other being `connection_secret_name`); passing
+    it for any other kind is a 400 rather than being ignored, so a
+    mistargeted request fails loudly instead of silently producing an
+    unconfigured catalog.
+
+    Must be a read-only (`viewer`) user of a DBaaS cluster in the same
+    organization, already synced on the cluster
+    (`observed_permission_level = viewer`) — the console derives the
+    connection secret from the user's CRD status, so arbitrary secrets
+    can't be linked. Mirrors
+    `CreatePostgresqlDataContainerRequestBody::managed_postgresql_user_id`."""