VolumeExplore

Package: flyteplugins.union.remote

A resolved :class:Volume plus the IO to inspect and walk its lineage.

Construct via :meth:from_action (resolve off a run/action), :meth:from_volume_value (wrap an in-hand Volume), or :meth:from_volume_json (a serialized value on disk).

Parameters

class VolumeExplore(
    volume: Volume,
    op_label: Optional[str],
)

Methods

download_index()

def download_index(
    dest: str,
)

Download this Volume’s metadata index to dest (local path).

from_action()

def from_action(
    run_name: str,
    action_name: str,
    op_name: Optional[str],
) -> 'VolumeExplore'

Resolve the Volume to explore off run/action.

With op_name set it’s matched against the action’s outputs first, then inputs; omitted, the action’s Volume-typed values are discovered, preferring outputs. A unique match wins; multiple raise :class:VolumeResolveError.

from_volume_json()

def from_volume_json(
    path: 'str | Path',
) -> 'VolumeExplore'

Load a serialized Volume value (.json) from disk.

from_volume_value()

def from_volume_value(
    volume: Volume,
) -> 'VolumeExplore'

lineage()

def lineage(
    current_reader: Optional[Any],
) -> List[dict]

Full version chain, newest first, walked via parent_produced_by.locator.

current_reader (any object with an async summary()) supplies the current version’s live stats; without it, the Volume’s stored used_bytes / inode_count are used.

lineage_has_navigable_parent()

def lineage_has_navigable_parent(
    lineage: List[dict],
) -> bool

True iff the immediate parent in lineage can actually be opened — it loaded (no error), has its own index, and is a distinct version.

parent()

def parent()

The immediate parent version as a new :class:VolumeExplore, or None.

provenance()

def provenance()

Producer + parent-producer action refs (flattened for display).