flyteplugins.union.remote

Union remote control plane objects.

This module provides remote object classes for Union-specific control plane entities, following the same pattern as flyte.remote objects.

Example: from flyteplugins.union.remote import ApiKey

# List all API keys
keys = ApiKey.listall()
for key in keys:
    print(key.client_id)

# Create a new API key
api_key = ApiKey.create(name="my-ci-key")
print(api_key.client_secret)

# Get a specific API key
key = ApiKey.get(client_id="my-client-id")

# Delete an API key
ApiKey.delete(client_id="my-client-id")

# Pod metrics of a run's task (root action, latest attempt) or of an app
from flyteplugins.union.remote import Metrics

for result in Metrics.get_for_action(run_name="my-run"):
    for series in result.series:
        print(result.name, series.labels, series.latest)

Metrics.get_for_app(name="my-app", metrics=["app_requests"])

Directory

Classes

Class	Description
`ApiKey`	Represents a Union API Key (OAuth Application).
`Assignment`	Represents role/policy assignments for an identity.
`Cluster`	Represents a Union cluster.
`ClusterConfig`	The tracked ConfigMaps of a single cluster.
`ClusterPool`	Represents a Union cluster pool — the configuration shared by its member clusters.
`Environment`	One environment version with its full spec, scaling and per-cluster status snapshots.
`EnvironmentVersion`	One environment version as returned by the list call: its summary and per-cluster summaries.
`Member`	Represents a Union organization member (user or application).
`MetricResult`	The result of querying one metric.
`MetricSeries`	One time series of a metric result, e.g. one container or one GPU device.
`Metrics`	Pod metrics of a task’s action attempt or of an app, as shown in the Union UI.
`Policy`	Represents a Union RBAC Policy.
`Queue`	Represents a Union scheduling queue.
`Role`	Represents a Union RBAC Role.
`SSHDebug`	Resolved SSH-into-task connect info for a running debug action.
`SystemLogs`	Logs of the Union system components running on a cluster’s dataplane.
`User`	Represents a Union user.
`VolumeExplore`	A resolved `Volume` plus the IO to inspect and walk its lineage.

Errors

Exception	Description
`VolumeResolveError`	No (or ambiguous) Volume-typed value could be resolved on an action.