icechunk.ops#

class GCSummary:
    """Summarizes the results of a garbage collection operation on an icechunk repo"""
    @property
    def bytes_deleted(self) -> int:
        """
        How many bytes were deleted.
        """
    @property
    def chunks_deleted(self) -> int:
        """
        How many chunks were deleted.
        """
    @property
    def manifests_deleted(self) -> int:
        """
        How many manifests were deleted.
        """
    @property
    def snapshots_deleted(self) -> int:
        """
        How many snapshots were deleted.
        """
    @property
    def attributes_deleted(self) -> int:
        """
        How many attributes were deleted.
        """
    @property
    def transaction_logs_deleted(self) -> int:
        """
        How many transaction logs were deleted.
        """
    @property
    def objects_failed_to_delete(self) -> int:
        """
        How many objects could not be deleted because the delete request failed.
        They remain garbage for the next run.
        """
    @property
    def throttled_batches(self) -> int:
        """
        How many delete requests the store throttled. Each one was retried
        after a pause, and none of them counts as a failure.
        """
    @property
    def delete_errors(self) -> list[str]:
        """
        The first distinct delete error messages, at most ten.
        """
    @property
    def skipped_phases(self) -> list[str]:
        """
        Delete phases skipped because an earlier phase had failures, in order.
        Possible values: "transaction_logs", "manifests", "chunks".
        """
    def _repr_html_(self) -> str: ...

@final
class Update:
    """A single entry in the repository operations log.

    Each update records an administrative action taken on the repository,
    along with when it occurred.

    Attributes
    ----------
    kind : UpdateType
        The type of operation that was performed.
    updated_at : datetime.datetime
        When the operation occurred.
    backup_path : str | None
        Path to a backup created before the operation, if any.
    """
    @property
    def kind(self) -> UpdateType: ...
    @property
    def updated_at(self) -> datetime.datetime: ...
    @property
    def backup_path(self) -> str | None: ...
    def _repr_html_(self) -> str: ...

class UpdateType:
    """The type of operation recorded in an ``Update``.

    This is a tagged union — each variant is a nested class with its own
    fields describing what happened.
    """
    @final
    class BranchCreated(UpdateType):
        """A new branch was created."""
        @property
        def name(self) -> str: ...

    @final
    class BranchDeleted(UpdateType):
        """A branch was deleted."""
        @property
        def name(self) -> str: ...
        @property
        def previous_snap_id(self) -> str: ...

    @final
    class BranchReset(UpdateType):
        """A branch was reset to a different snapshot."""
        @property
        def name(self) -> str: ...
        @property
        def previous_snap_id(self) -> str: ...

    @final
    class CommitAmended(UpdateType):
        """A commit on a branch was amended."""
        @property
        def branch(self) -> str: ...
        @property
        def previous_snap_id(self) -> str: ...
        @property
        def new_snap_id(self) -> str: ...

    @final
    class ConfigChanged(UpdateType):
        """The repository configuration was changed."""

    @final
    class ExpirationRan(UpdateType):
        """Snapshot expiration was run."""

    @final
    class FeatureFlagChanged(UpdateType):
        """A feature flag was changed."""
        @property
        def id(self) -> int: ...
        @property
        def new_value(self) -> bool | None: ...

    @final
    class GCRan(UpdateType):
        """Garbage collection was run."""

    @final
    class MetadataChanged(UpdateType):
        """Repository metadata was changed."""

    @final
    class NewCommit(UpdateType):
        """A new commit was made on a branch."""
        @property
        def branch(self) -> str: ...
        @property
        def new_snap_id(self) -> str: ...

    @final
    class NewDetachedSnapshot(UpdateType):
        """A new detached snapshot was created."""
        @property
        def new_snap_id(self) -> str: ...

    @final
    class RepoInitialized(UpdateType):
        """The repository was initialized."""

    @final
    class RepoMigrated(UpdateType):
        """The repository was migrated to a new spec version."""
        @property
        def from_version(self) -> int: ...
        @property
        def to_version(self) -> int: ...

    @final
    class RepoStatusChanged(UpdateType):
        """The repository availability status was changed."""
        @property
        def status(self) -> RepoStatus: ...

    @final
    class TagCreated(UpdateType):
        """A new tag was created."""
        @property
        def name(self) -> str: ...

    @final
    class TagDeleted(UpdateType):
        """A tag was deleted."""
        @property
        def name(self) -> str: ...
        @property
        def previous_snap_id(self) -> str: ...