perago.WorkspaceInput#

class perago.WorkspaceInput(*, repository, branch, ref_type, ref)[源代码]#

Workspace reference supplied in Conductor task input.

WorkspaceInput identifies the LakeFS repository, target branch, and immutable commit ref that a workspace task should download before running the task body.

Parameters:

repositorystr: LakeFS repository name. Blank strings are rejected.
branchstr: Target branch that successful publication should advance. Blank strings are rejected.
ref_type{"commit"}: Type of input reference. Perago currently accepts immutable commit references only.
refstr: Input commit ref to download. Blank strings are rejected.

参数:

repository (Annotated[str, MinLen(min_length=1)])
branch (Annotated[str, MinLen(min_length=1)])
ref_type (Literal['commit'])
ref (Annotated[str, MinLen(min_length=1)])

参见

WorkspaceOutput: Workspace reference returned after publication.

Examples

>>> input_ref = WorkspaceInput(
...     repository="song-000123",
...     branch="main",
...     ref_type="commit",
...     ref="589f8770",
... )
>>> input_ref.published_output("9c6f8770").ref
'9c6f8770'

Methods

published_output(ref)

Return a workspace output that preserves repository and branch.

Attributes

`repository`
`branch`
`ref_type`
`ref`