Module `pachyderm_sdk.api.pfs`

Expand source code

# Generated by the protocol buffer compiler.  DO NOT EDIT!
# sources: api/pfs/pfs.proto
# plugin: python-betterproto
# This file has been @generated
from dataclasses import dataclass
from datetime import (
    datetime,
    timedelta,
)
from typing import (
    TYPE_CHECKING,
    AsyncIterable,
    AsyncIterator,
    Dict,
    Iterable,
    Iterator,
    List,
    Optional,
    Union,
)

import betterproto
import betterproto.lib.google.protobuf as betterproto_lib_google_protobuf
import grpc

from .. import (
    auth as _auth__,
    taskapi as _taskapi__,
)


if TYPE_CHECKING:
    import grpc


class OriginKind(betterproto.Enum):
    """These are the different places where a commit may be originated from"""

    ORIGIN_KIND_UNKNOWN = 0
    USER = 1
    AUTO = 2
    FSCK = 3


class FileType(betterproto.Enum):
    RESERVED = 0
    FILE = 1
    DIR = 2


class CommitState(betterproto.Enum):
    """
    CommitState describes the states a commit can be in. The states are
    increasingly specific, i.e. a commit that is FINISHED also counts as
    STARTED.
    """

    COMMIT_STATE_UNKNOWN = 0
    STARTED = 1
    READY = 2
    FINISHING = 3
    FINISHED = 4


class Delimiter(betterproto.Enum):
    NONE = 0
    JSON = 1
    LINE = 2
    SQL = 3
    CSV = 4


class RepoPageOrdering(betterproto.Enum):
    PROJECT_REPO = 0


class GetFileSetRequestFileSetType(betterproto.Enum):
    TOTAL = 0
    DIFF = 1


class SqlDatabaseEgressFileFormatType(betterproto.Enum):
    UNKNOWN = 0
    CSV = 1
    JSON = 2
    PARQUET = 3


@dataclass(eq=False, repr=False)
class Repo(betterproto.Message):
    name: str = betterproto.string_field(1)
    type: str = betterproto.string_field(2)
    project: "Project" = betterproto.message_field(3)


@dataclass(eq=False, repr=False)
class RepoPicker(betterproto.Message):
    """
    Repo defines mutually exclusive pickers that resolve to a single
    repository. Currently, the only way to pick a repo is by composing a repo
    name and type with a project. If the type is omitted, the 'user' type will
    be used as a default. Picker messages should only be used as request
    parameters.
    """

    name: "RepoPickerRepoName" = betterproto.message_field(1, group="picker")


@dataclass(eq=False, repr=False)
class RepoPickerRepoName(betterproto.Message):
    project: "ProjectPicker" = betterproto.message_field(1)
    name: str = betterproto.string_field(2)
    type: str = betterproto.string_field(3)


@dataclass(eq=False, repr=False)
class Branch(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    name: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class BranchPicker(betterproto.Message):
    """
    BranchPicker defines mutually exclusive pickers that resolve to a single
    branch. Currently, the only way to pick a branch is by composing a branch
    name with a repo. Picker messages should only be used as request
    parameters.
    """

    name: "BranchPickerBranchName" = betterproto.message_field(1, group="picker")


@dataclass(eq=False, repr=False)
class BranchPickerBranchName(betterproto.Message):
    repo: "RepoPicker" = betterproto.message_field(1)
    name: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class File(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    path: str = betterproto.string_field(2)
    datum: str = betterproto.string_field(3)


@dataclass(eq=False, repr=False)
class RepoInfo(betterproto.Message):
    """RepoInfo is the main data structure representing a Repo in etcd"""

    repo: "Repo" = betterproto.message_field(1)
    created: datetime = betterproto.message_field(2)
    size_bytes_upper_bound: int = betterproto.int64_field(3)
    description: str = betterproto.string_field(4)
    branches: List["Branch"] = betterproto.message_field(5)
    auth_info: "AuthInfo" = betterproto.message_field(6)
    """
    Set by ListRepo and InspectRepo if Pachyderm's auth system is active, but
    not stored in etcd. To set a user's auth scope for a repo, use the
    Pachyderm Auth API (in src/client/auth/auth.proto)
    """

    details: "RepoInfoDetails" = betterproto.message_field(7)
    metadata: Dict[str, str] = betterproto.map_field(
        8, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    """Metadata are user-defined key-value pairs."""


@dataclass(eq=False, repr=False)
class RepoInfoDetails(betterproto.Message):
    """Details are only provided when explicitly requested"""

    size_bytes: int = betterproto.int64_field(1)


@dataclass(eq=False, repr=False)
class AuthInfo(betterproto.Message):
    """
    AuthInfo includes the caller's access scope for a resource, and is returned
    by services like ListRepo, InspectRepo, and ListProject, but is not
    persisted in the database. It's used by the Pachyderm dashboard to render
    repo access appropriately. To set a user's auth scope for a resource, use
    the Pachyderm Auth API (in src/auth/auth.proto)
    """

    permissions: List["_auth__.Permission"] = betterproto.enum_field(1)
    """
    The callers access level to the relevant resource. These are very granular
    permissions - for the end user it makes sense to show them the roles they
    have instead.
    """

    roles: List[str] = betterproto.string_field(2)
    """
    The caller's roles on the relevant resource. This includes inherited roles
    from the cluster, project, group membership, etc.
    """


@dataclass(eq=False, repr=False)
class BranchInfo(betterproto.Message):
    branch: "Branch" = betterproto.message_field(1)
    head: "Commit" = betterproto.message_field(2)
    provenance: List["Branch"] = betterproto.message_field(3)
    subvenance: List["Branch"] = betterproto.message_field(4)
    direct_provenance: List["Branch"] = betterproto.message_field(5)
    trigger: "Trigger" = betterproto.message_field(6)
    metadata: Dict[str, str] = betterproto.map_field(
        7, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    """Metadata on the branch."""

    created_by: str = betterproto.string_field(8)
    """The user that caused this branch to be created."""

    created_at: datetime = betterproto.message_field(9)
    """When the branch was added to the database."""

    updated_at: datetime = betterproto.message_field(10)
    """
    When information about the branch was last modified (not necessarily when
    the data in this branch changed or anything like that).
    """


@dataclass(eq=False, repr=False)
class Trigger(betterproto.Message):
    """
    Trigger defines the conditions under which a head is moved, and to which
    branch it is moved.
    """

    branch: str = betterproto.string_field(1)
    """Which branch this trigger refers to"""

    all: bool = betterproto.bool_field(2)
    """
    All indicates that all conditions must be satisfied before the trigger
    happens, otherwise any conditions being satisfied will trigger it.
    """

    rate_limit_spec: str = betterproto.string_field(3)
    """
    Triggers if the rate limit spec (cron expression) has been satisfied since
    the last trigger.
    """

    size: str = betterproto.string_field(4)
    """
    Triggers if there's been `size` new data added since the last trigger.
    """

    commits: int = betterproto.int64_field(5)
    """
    Triggers if there's been `commits` new commits added since the last
    trigger.
    """

    cron_spec: str = betterproto.string_field(6)
    """
    Creates a background process which fires the trigger on the schedule
    provided by the cron spec. This condition is mutually exclusive with
    respect to the others, so setting this will result with the trigger only
    firing based on the cron schedule.
    """


@dataclass(eq=False, repr=False)
class CommitOrigin(betterproto.Message):
    kind: "OriginKind" = betterproto.enum_field(1)


@dataclass(eq=False, repr=False)
class Commit(betterproto.Message):
    """
    Commit is a reference to a commit (e.g. the collection of branches and the
    collection of currently-open commits in etcd are collections of Commit
    protos)
    """

    repo: "Repo" = betterproto.message_field(3)
    id: str = betterproto.string_field(2)
    branch: "Branch" = betterproto.message_field(1)
    """only used by the client"""


@dataclass(eq=False, repr=False)
class CommitPicker(betterproto.Message):
    """
    CommitPicker defines mutually exclusive pickers that resolve to a single
    commit. Commits can be picked relatively from some other commit like a
    parent or start of branch. Alternatively, they can be picked via their
    global Id, which is composed of a repo picker and an id. Picker messages
    should only be used as request parameters.
    """

    branch_head: "BranchPicker" = betterproto.message_field(1, group="picker")
    id: "CommitPickerCommitByGlobalId" = betterproto.message_field(2, group="picker")
    ancestor: "CommitPickerAncestorOf" = betterproto.message_field(3, group="picker")
    branch_root: "CommitPickerBranchRoot" = betterproto.message_field(4, group="picker")


@dataclass(eq=False, repr=False)
class CommitPickerCommitByGlobalId(betterproto.Message):
    repo: "RepoPicker" = betterproto.message_field(1)
    id: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class CommitPickerBranchRoot(betterproto.Message):
    """This models .N syntax."""

    offset: int = betterproto.uint32_field(1)
    branch: "BranchPicker" = betterproto.message_field(2)


@dataclass(eq=False, repr=False)
class CommitPickerAncestorOf(betterproto.Message):
    """This models ^ syntax recursively."""

    offset: int = betterproto.uint32_field(1)
    start: "CommitPicker" = betterproto.message_field(2)


@dataclass(eq=False, repr=False)
class CommitInfo(betterproto.Message):
    """
    CommitInfo is the main data structure representing a commit in postgres
    """

    commit: "Commit" = betterproto.message_field(1)
    origin: "CommitOrigin" = betterproto.message_field(2)
    description: str = betterproto.string_field(3)
    """description is a user-provided script describing this commit"""

    parent_commit: "Commit" = betterproto.message_field(4)
    child_commits: List["Commit"] = betterproto.message_field(5)
    started: datetime = betterproto.message_field(6)
    finishing: datetime = betterproto.message_field(7)
    finished: datetime = betterproto.message_field(8)
    direct_provenance: List["Commit"] = betterproto.message_field(13)
    direct_subvenance: List["Commit"] = betterproto.message_field(15)
    error: str = betterproto.string_field(10)
    size_bytes_upper_bound: int = betterproto.int64_field(11)
    details: "CommitInfoDetails" = betterproto.message_field(12)
    metadata: Dict[str, str] = betterproto.map_field(
        14, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    """Metadata is user-applied annotations."""

    created_by: str = betterproto.string_field(16)
    """
    The user that created this commit or caused this commit to be created.
    """

    created_at: datetime = betterproto.message_field(17)
    """The time the commit was added to the database."""

    updated_at: datetime = betterproto.message_field(18)
    """The time this commit was most recently updated."""


@dataclass(eq=False, repr=False)
class CommitInfoDetails(betterproto.Message):
    """Details are only provided when explicitly requested"""

    size_bytes: int = betterproto.int64_field(1)
    compacting_time: timedelta = betterproto.message_field(2)
    validating_time: timedelta = betterproto.message_field(3)


@dataclass(eq=False, repr=False)
class CommitSet(betterproto.Message):
    id: str = betterproto.string_field(1)


@dataclass(eq=False, repr=False)
class CommitSetInfo(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)
    commits: List["CommitInfo"] = betterproto.message_field(2)


@dataclass(eq=False, repr=False)
class FileInfo(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    file_type: "FileType" = betterproto.enum_field(2)
    committed: datetime = betterproto.message_field(3)
    size_bytes: int = betterproto.int64_field(4)
    hash: bytes = betterproto.bytes_field(5)


@dataclass(eq=False, repr=False)
class Project(betterproto.Message):
    name: str = betterproto.string_field(1)


@dataclass(eq=False, repr=False)
class ProjectInfo(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    auth_info: "AuthInfo" = betterproto.message_field(3)
    created_at: datetime = betterproto.message_field(4)
    metadata: Dict[str, str] = betterproto.map_field(
        5, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    created_by: str = betterproto.string_field(6)


@dataclass(eq=False, repr=False)
class ProjectPicker(betterproto.Message):
    """
    ProjectPicker defines mutually exclusive pickers that resolve to a single
    project. Currently, the only way to pick a project is by using a project
    name. Picker messages should only be used as request parameters.
    """

    name: str = betterproto.string_field(1, group="picker")


@dataclass(eq=False, repr=False)
class CreateRepoRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    update: bool = betterproto.bool_field(3)


@dataclass(eq=False, repr=False)
class InspectRepoRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class ListRepoRequest(betterproto.Message):
    type: str = betterproto.string_field(1)
    """
    Type is the type of (system) repo that should be returned. An empty string
    requests all repos.
    """

    projects: List["Project"] = betterproto.message_field(2)
    """
    Filters out repos whos project isn't represented. An empty list of projects
    doesn't filter repos by their project.
    """

    page: "RepoPage" = betterproto.message_field(3)
    """
    Specifies which page of repos should be returned. If page isn't specified,
    a single page containing all the relevant repos is returned.
    """


@dataclass(eq=False, repr=False)
class RepoPage(betterproto.Message):
    order: "RepoPageOrdering" = betterproto.enum_field(1)
    page_size: int = betterproto.int64_field(2)
    page_index: int = betterproto.int64_field(3)


@dataclass(eq=False, repr=False)
class DeleteRepoRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    force: bool = betterproto.bool_field(2)


@dataclass(eq=False, repr=False)
class DeleteReposRequest(betterproto.Message):
    """DeleteReposRequest is used to delete more than one repo at once."""

    projects: List["Project"] = betterproto.message_field(1)
    """
    All repos in each project will be deleted if the caller has permission.
    """

    force: bool = betterproto.bool_field(2)
    all: bool = betterproto.bool_field(3)
    """
    If all is set, then all repos in all projects will be deleted if the caller
    has permission.
    """


@dataclass(eq=False, repr=False)
class DeleteRepoResponse(betterproto.Message):
    """
    DeleteRepoResponse returns the repos that were deleted by a DeleteRepo
    call.
    """

    deleted: bool = betterproto.bool_field(1)
    """The repos that were deleted, perhaps none."""


@dataclass(eq=False, repr=False)
class DeleteReposResponse(betterproto.Message):
    repos: List["Repo"] = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class StartCommitRequest(betterproto.Message):
    parent: "Commit" = betterproto.message_field(1)
    """
    parent may be empty in which case the commit that Branch points to will be
    used as the parent. If the branch does not exist, the commit will have no
    parent.
    """

    description: str = betterproto.string_field(2)
    """description is a user-provided string describing this commit"""

    branch: "Branch" = betterproto.message_field(3)


@dataclass(eq=False, repr=False)
class FinishCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    """
    description is a user-provided string describing this commit. Setting this
    will overwrite the description set in StartCommit
    """

    error: str = betterproto.string_field(3)
    force: bool = betterproto.bool_field(4)


@dataclass(eq=False, repr=False)
class InspectCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    wait: "CommitState" = betterproto.enum_field(2)
    """
    Wait causes inspect commit to wait until the commit is in the desired
    state.
    """


@dataclass(eq=False, repr=False)
class ListCommitRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    from_: "Commit" = betterproto.message_field(2)
    to: "Commit" = betterproto.message_field(3)
    number: int = betterproto.int64_field(4)
    reverse: bool = betterproto.bool_field(5)
    all: bool = betterproto.bool_field(6)
    origin_kind: "OriginKind" = betterproto.enum_field(7)
    started_time: datetime = betterproto.message_field(8)


@dataclass(eq=False, repr=False)
class InspectCommitSetRequest(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)
    wait: bool = betterproto.bool_field(2)


@dataclass(eq=False, repr=False)
class ListCommitSetRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class SquashCommitSetRequest(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class DropCommitSetRequest(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class SubscribeCommitRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    branch: str = betterproto.string_field(2)
    from_: "Commit" = betterproto.message_field(3)
    """only commits created since this commit are returned"""

    state: "CommitState" = betterproto.enum_field(4)
    """Don't return commits until they're in (at least) the desired state."""

    all: bool = betterproto.bool_field(5)
    origin_kind: "OriginKind" = betterproto.enum_field(6)


@dataclass(eq=False, repr=False)
class ClearCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class SquashCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    recursive: bool = betterproto.bool_field(2)
    """
    Setting recursive to true indicates that the squash should be applied
    recursively to subvenant commits. If recursive is set to false and the
    provided commit has subvenant commits, the squash will fail.
    """


@dataclass(eq=False, repr=False)
class SquashCommitResponse(betterproto.Message):
    pass


@dataclass(eq=False, repr=False)
class DropCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    recursive: bool = betterproto.bool_field(2)
    """
    Setting recursive to true indicates that the drop should be applied
    recursively to subvenant commits. If recursive is set to false and the
    provided commit has subvenant commits, the drop will fail.
    """


@dataclass(eq=False, repr=False)
class WalkCommitProvenanceRequest(betterproto.Message):
    start: List["CommitPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_commits: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)


@dataclass(eq=False, repr=False)
class WalkCommitSubvenanceRequest(betterproto.Message):
    start: List["CommitPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_commits: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)


@dataclass(eq=False, repr=False)
class WalkBranchProvenanceRequest(betterproto.Message):
    start: List["BranchPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_branches: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)


@dataclass(eq=False, repr=False)
class WalkBranchSubvenanceRequest(betterproto.Message):
    start: List["BranchPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_branches: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)


@dataclass(eq=False, repr=False)
class DropCommitResponse(betterproto.Message):
    pass


@dataclass(eq=False, repr=False)
class CreateBranchRequest(betterproto.Message):
    head: "Commit" = betterproto.message_field(1)
    branch: "Branch" = betterproto.message_field(2)
    provenance: List["Branch"] = betterproto.message_field(3)
    trigger: "Trigger" = betterproto.message_field(4)
    new_commit_set: bool = betterproto.bool_field(5)


@dataclass(eq=False, repr=False)
class FindCommitsRequest(betterproto.Message):
    start: "Commit" = betterproto.message_field(1)
    file_path: str = betterproto.string_field(2)
    limit: int = betterproto.uint32_field(3)


@dataclass(eq=False, repr=False)
class FindCommitsResponse(betterproto.Message):
    found_commit: "Commit" = betterproto.message_field(1, group="result")
    last_searched_commit: "Commit" = betterproto.message_field(2, group="result")
    commits_searched: int = betterproto.uint32_field(3)


@dataclass(eq=False, repr=False)
class InspectBranchRequest(betterproto.Message):
    branch: "Branch" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class ListBranchRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    reverse: bool = betterproto.bool_field(2)


@dataclass(eq=False, repr=False)
class DeleteBranchRequest(betterproto.Message):
    branch: "Branch" = betterproto.message_field(1)
    force: bool = betterproto.bool_field(2)


@dataclass(eq=False, repr=False)
class CreateProjectRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    update: bool = betterproto.bool_field(3)


@dataclass(eq=False, repr=False)
class InspectProjectRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class InspectProjectV2Request(betterproto.Message):
    project: "Project" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class InspectProjectV2Response(betterproto.Message):
    info: "ProjectInfo" = betterproto.message_field(1)
    defaults_json: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class ListProjectRequest(betterproto.Message):
    pass


@dataclass(eq=False, repr=False)
class DeleteProjectRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    force: bool = betterproto.bool_field(2)


@dataclass(eq=False, repr=False)
class AddFile(betterproto.Message):
    path: str = betterproto.string_field(1)
    datum: str = betterproto.string_field(2)
    raw: Optional[bytes] = betterproto.message_field(
        3, wraps=betterproto.TYPE_BYTES, group="source"
    )
    url: "AddFileUrlSource" = betterproto.message_field(4, group="source")


@dataclass(eq=False, repr=False)
class AddFileUrlSource(betterproto.Message):
    url: str = betterproto.string_field(1)
    recursive: bool = betterproto.bool_field(2)
    concurrency: int = betterproto.uint32_field(3)


@dataclass(eq=False, repr=False)
class DeleteFile(betterproto.Message):
    path: str = betterproto.string_field(1)
    datum: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class CopyFile(betterproto.Message):
    dst: str = betterproto.string_field(1)
    datum: str = betterproto.string_field(2)
    src: "File" = betterproto.message_field(3)
    append: bool = betterproto.bool_field(4)


@dataclass(eq=False, repr=False)
class ModifyFileRequest(betterproto.Message):
    set_commit: "Commit" = betterproto.message_field(1, group="body")
    add_file: "AddFile" = betterproto.message_field(2, group="body")
    delete_file: "DeleteFile" = betterproto.message_field(3, group="body")
    copy_file: "CopyFile" = betterproto.message_field(4, group="body")


@dataclass(eq=False, repr=False)
class GetFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    url: str = betterproto.string_field(2)
    offset: int = betterproto.int64_field(3)
    path_range: "PathRange" = betterproto.message_field(4)


@dataclass(eq=False, repr=False)
class InspectFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class ListFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    """
    File is the parent directory of the files we want to list. This sets the
    repo, the commit/branch, and path prefix of files we're interested in If
    the "path" field is omitted, a list of files at the top level of the repo
    is returned
    """

    pagination_marker: "File" = betterproto.message_field(3)
    """
    Marker for pagination. If set, the files that come after the marker in
    lexicographical order will be returned. If reverse is also set, the files
    that come before the marker in lexicographical order will be returned.
    """

    number: int = betterproto.int64_field(4)
    """Number of files to return"""

    reverse: bool = betterproto.bool_field(5)
    """If true, return files in reverse order"""


@dataclass(eq=False, repr=False)
class WalkFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    pagination_marker: "File" = betterproto.message_field(2)
    """
    Marker for pagination. If set, the files that come after the marker in
    lexicographical order will be returned. If reverse is also set, the files
    that come before the marker in lexicographical order will be returned.
    """

    number: int = betterproto.int64_field(3)
    """Number of files to return"""

    reverse: bool = betterproto.bool_field(4)
    """If true, return files in reverse order"""


@dataclass(eq=False, repr=False)
class GlobFileRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    pattern: str = betterproto.string_field(2)
    path_range: "PathRange" = betterproto.message_field(3)


@dataclass(eq=False, repr=False)
class DiffFileRequest(betterproto.Message):
    new_file: "File" = betterproto.message_field(1)
    old_file: "File" = betterproto.message_field(2)
    """
    OldFile may be left nil in which case the same path in the parent of
    NewFile's commit will be used.
    """

    shallow: bool = betterproto.bool_field(3)


@dataclass(eq=False, repr=False)
class DiffFileResponse(betterproto.Message):
    new_file: "FileInfo" = betterproto.message_field(1)
    old_file: "FileInfo" = betterproto.message_field(2)


@dataclass(eq=False, repr=False)
class FsckRequest(betterproto.Message):
    fix: bool = betterproto.bool_field(1)
    zombie_target: "Commit" = betterproto.message_field(2, group="zombie_check")
    zombie_all: bool = betterproto.bool_field(3, group="zombie_check")
    """run zombie data detection against all pipelines"""


@dataclass(eq=False, repr=False)
class FsckResponse(betterproto.Message):
    fix: str = betterproto.string_field(1)
    error: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class CreateFileSetResponse(betterproto.Message):
    file_set_id: str = betterproto.string_field(1)


@dataclass(eq=False, repr=False)
class GetFileSetRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    type: "GetFileSetRequestFileSetType" = betterproto.enum_field(2)


@dataclass(eq=False, repr=False)
class AddFileSetRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    file_set_id: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class RenewFileSetRequest(betterproto.Message):
    file_set_id: str = betterproto.string_field(1)
    ttl_seconds: int = betterproto.int64_field(2)


@dataclass(eq=False, repr=False)
class ComposeFileSetRequest(betterproto.Message):
    file_set_ids: List[str] = betterproto.string_field(1)
    ttl_seconds: int = betterproto.int64_field(2)
    compact: bool = betterproto.bool_field(3)


@dataclass(eq=False, repr=False)
class ShardFileSetRequest(betterproto.Message):
    """
    If both num_files and size_bytes are set, shards are created based on
    whichever threshold is surpassed first. If a shard configuration field
    (num_files, size_bytes) is unset, the storage's default value is used.
    """

    file_set_id: str = betterproto.string_field(1)
    num_files: int = betterproto.int64_field(2)
    size_bytes: int = betterproto.int64_field(3)


@dataclass(eq=False, repr=False)
class PathRange(betterproto.Message):
    lower: str = betterproto.string_field(1)
    upper: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class ShardFileSetResponse(betterproto.Message):
    shards: List["PathRange"] = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class CheckStorageRequest(betterproto.Message):
    read_chunk_data: bool = betterproto.bool_field(1)
    chunk_begin: bytes = betterproto.bytes_field(2)
    chunk_end: bytes = betterproto.bytes_field(3)


@dataclass(eq=False, repr=False)
class CheckStorageResponse(betterproto.Message):
    chunk_object_count: int = betterproto.int64_field(1)


@dataclass(eq=False, repr=False)
class PutCacheRequest(betterproto.Message):
    key: str = betterproto.string_field(1)
    value: "betterproto_lib_google_protobuf.Any" = betterproto.message_field(2)
    file_set_ids: List[str] = betterproto.string_field(3)
    tag: str = betterproto.string_field(4)


@dataclass(eq=False, repr=False)
class GetCacheRequest(betterproto.Message):
    key: str = betterproto.string_field(1)


@dataclass(eq=False, repr=False)
class GetCacheResponse(betterproto.Message):
    value: "betterproto_lib_google_protobuf.Any" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class ClearCacheRequest(betterproto.Message):
    tag_prefix: str = betterproto.string_field(1)


@dataclass(eq=False, repr=False)
class ActivateAuthRequest(betterproto.Message):
    pass


@dataclass(eq=False, repr=False)
class ActivateAuthResponse(betterproto.Message):
    pass


@dataclass(eq=False, repr=False)
class ObjectStorageEgress(betterproto.Message):
    url: str = betterproto.string_field(1)


@dataclass(eq=False, repr=False)
class SqlDatabaseEgress(betterproto.Message):
    url: str = betterproto.string_field(1)
    file_format: "SqlDatabaseEgressFileFormat" = betterproto.message_field(2)
    secret: "SqlDatabaseEgressSecret" = betterproto.message_field(3)


@dataclass(eq=False, repr=False)
class SqlDatabaseEgressFileFormat(betterproto.Message):
    type: "SqlDatabaseEgressFileFormatType" = betterproto.enum_field(1)
    columns: List[str] = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class SqlDatabaseEgressSecret(betterproto.Message):
    name: str = betterproto.string_field(1)
    key: str = betterproto.string_field(2)


@dataclass(eq=False, repr=False)
class EgressRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    object_storage: "ObjectStorageEgress" = betterproto.message_field(2, group="target")
    sql_database: "SqlDatabaseEgress" = betterproto.message_field(3, group="target")


@dataclass(eq=False, repr=False)
class EgressResponse(betterproto.Message):
    object_storage: "EgressResponseObjectStorageResult" = betterproto.message_field(
        1, group="result"
    )
    sql_database: "EgressResponseSqlDatabaseResult" = betterproto.message_field(
        2, group="result"
    )


@dataclass(eq=False, repr=False)
class EgressResponseObjectStorageResult(betterproto.Message):
    bytes_written: int = betterproto.int64_field(1)


@dataclass(eq=False, repr=False)
class EgressResponseSqlDatabaseResult(betterproto.Message):
    rows_written: Dict[str, int] = betterproto.map_field(
        1, betterproto.TYPE_STRING, betterproto.TYPE_INT64
    )


@dataclass(eq=False, repr=False)
class ReposSummaryRequest(betterproto.Message):
    projects: List["ProjectPicker"] = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class ReposSummary(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    user_repo_count: int = betterproto.int64_field(2)
    size_bytes: int = betterproto.int64_field(3)


@dataclass(eq=False, repr=False)
class ReposSummaryResponse(betterproto.Message):
    summaries: List["ReposSummary"] = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class ForgetCommitRequest(betterproto.Message):
    commit: "CommitPicker" = betterproto.message_field(1)


@dataclass(eq=False, repr=False)
class ForgetCommitResponse(betterproto.Message):
    pass


class ApiStub:

    def __init__(self, channel: "grpc.Channel"):
        self.__rpc_create_repo = channel.unary_unary(
            "/pfs_v2.API/CreateRepo",
            request_serializer=CreateRepoRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_repo = channel.unary_unary(
            "/pfs_v2.API/InspectRepo",
            request_serializer=InspectRepoRequest.SerializeToString,
            response_deserializer=RepoInfo.FromString,
        )
        self.__rpc_list_repo = channel.unary_stream(
            "/pfs_v2.API/ListRepo",
            request_serializer=ListRepoRequest.SerializeToString,
            response_deserializer=RepoInfo.FromString,
        )
        self.__rpc_delete_repo = channel.unary_unary(
            "/pfs_v2.API/DeleteRepo",
            request_serializer=DeleteRepoRequest.SerializeToString,
            response_deserializer=DeleteRepoResponse.FromString,
        )
        self.__rpc_delete_repos = channel.unary_unary(
            "/pfs_v2.API/DeleteRepos",
            request_serializer=DeleteReposRequest.SerializeToString,
            response_deserializer=DeleteReposResponse.FromString,
        )
        self.__rpc_start_commit = channel.unary_unary(
            "/pfs_v2.API/StartCommit",
            request_serializer=StartCommitRequest.SerializeToString,
            response_deserializer=Commit.FromString,
        )
        self.__rpc_finish_commit = channel.unary_unary(
            "/pfs_v2.API/FinishCommit",
            request_serializer=FinishCommitRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_clear_commit = channel.unary_unary(
            "/pfs_v2.API/ClearCommit",
            request_serializer=ClearCommitRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_commit = channel.unary_unary(
            "/pfs_v2.API/InspectCommit",
            request_serializer=InspectCommitRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_list_commit = channel.unary_stream(
            "/pfs_v2.API/ListCommit",
            request_serializer=ListCommitRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_subscribe_commit = channel.unary_stream(
            "/pfs_v2.API/SubscribeCommit",
            request_serializer=SubscribeCommitRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_squash_commit = channel.unary_unary(
            "/pfs_v2.API/SquashCommit",
            request_serializer=SquashCommitRequest.SerializeToString,
            response_deserializer=SquashCommitResponse.FromString,
        )
        self.__rpc_drop_commit = channel.unary_unary(
            "/pfs_v2.API/DropCommit",
            request_serializer=DropCommitRequest.SerializeToString,
            response_deserializer=DropCommitResponse.FromString,
        )
        self.__rpc_inspect_commit_set = channel.unary_stream(
            "/pfs_v2.API/InspectCommitSet",
            request_serializer=InspectCommitSetRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_list_commit_set = channel.unary_stream(
            "/pfs_v2.API/ListCommitSet",
            request_serializer=ListCommitSetRequest.SerializeToString,
            response_deserializer=CommitSetInfo.FromString,
        )
        self.__rpc_squash_commit_set = channel.unary_unary(
            "/pfs_v2.API/SquashCommitSet",
            request_serializer=SquashCommitSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_drop_commit_set = channel.unary_unary(
            "/pfs_v2.API/DropCommitSet",
            request_serializer=DropCommitSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_find_commits = channel.unary_stream(
            "/pfs_v2.API/FindCommits",
            request_serializer=FindCommitsRequest.SerializeToString,
            response_deserializer=FindCommitsResponse.FromString,
        )
        self.__rpc_walk_commit_provenance = channel.unary_stream(
            "/pfs_v2.API/WalkCommitProvenance",
            request_serializer=WalkCommitProvenanceRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_walk_commit_subvenance = channel.unary_stream(
            "/pfs_v2.API/WalkCommitSubvenance",
            request_serializer=WalkCommitSubvenanceRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_create_branch = channel.unary_unary(
            "/pfs_v2.API/CreateBranch",
            request_serializer=CreateBranchRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_branch = channel.unary_unary(
            "/pfs_v2.API/InspectBranch",
            request_serializer=InspectBranchRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_list_branch = channel.unary_stream(
            "/pfs_v2.API/ListBranch",
            request_serializer=ListBranchRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_delete_branch = channel.unary_unary(
            "/pfs_v2.API/DeleteBranch",
            request_serializer=DeleteBranchRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_walk_branch_provenance = channel.unary_stream(
            "/pfs_v2.API/WalkBranchProvenance",
            request_serializer=WalkBranchProvenanceRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_walk_branch_subvenance = channel.unary_stream(
            "/pfs_v2.API/WalkBranchSubvenance",
            request_serializer=WalkBranchSubvenanceRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_modify_file = channel.stream_unary(
            "/pfs_v2.API/ModifyFile",
            request_serializer=ModifyFileRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_get_file = channel.unary_stream(
            "/pfs_v2.API/GetFile",
            request_serializer=GetFileRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.BytesValue.FromString,
        )
        self.__rpc_get_file_tar = channel.unary_stream(
            "/pfs_v2.API/GetFileTAR",
            request_serializer=GetFileRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.BytesValue.FromString,
        )
        self.__rpc_inspect_file = channel.unary_unary(
            "/pfs_v2.API/InspectFile",
            request_serializer=InspectFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_list_file = channel.unary_stream(
            "/pfs_v2.API/ListFile",
            request_serializer=ListFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_walk_file = channel.unary_stream(
            "/pfs_v2.API/WalkFile",
            request_serializer=WalkFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_glob_file = channel.unary_stream(
            "/pfs_v2.API/GlobFile",
            request_serializer=GlobFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_diff_file = channel.unary_stream(
            "/pfs_v2.API/DiffFile",
            request_serializer=DiffFileRequest.SerializeToString,
            response_deserializer=DiffFileResponse.FromString,
        )
        self.__rpc_activate_auth = channel.unary_unary(
            "/pfs_v2.API/ActivateAuth",
            request_serializer=ActivateAuthRequest.SerializeToString,
            response_deserializer=ActivateAuthResponse.FromString,
        )
        self.__rpc_delete_all = channel.unary_unary(
            "/pfs_v2.API/DeleteAll",
            request_serializer=betterproto_lib_google_protobuf.Empty.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_fsck = channel.unary_stream(
            "/pfs_v2.API/Fsck",
            request_serializer=FsckRequest.SerializeToString,
            response_deserializer=FsckResponse.FromString,
        )
        self.__rpc_create_file_set = channel.stream_unary(
            "/pfs_v2.API/CreateFileSet",
            request_serializer=ModifyFileRequest.SerializeToString,
            response_deserializer=CreateFileSetResponse.FromString,
        )
        self.__rpc_get_file_set = channel.unary_unary(
            "/pfs_v2.API/GetFileSet",
            request_serializer=GetFileSetRequest.SerializeToString,
            response_deserializer=CreateFileSetResponse.FromString,
        )
        self.__rpc_add_file_set = channel.unary_unary(
            "/pfs_v2.API/AddFileSet",
            request_serializer=AddFileSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_renew_file_set = channel.unary_unary(
            "/pfs_v2.API/RenewFileSet",
            request_serializer=RenewFileSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_compose_file_set = channel.unary_unary(
            "/pfs_v2.API/ComposeFileSet",
            request_serializer=ComposeFileSetRequest.SerializeToString,
            response_deserializer=CreateFileSetResponse.FromString,
        )
        self.__rpc_shard_file_set = channel.unary_unary(
            "/pfs_v2.API/ShardFileSet",
            request_serializer=ShardFileSetRequest.SerializeToString,
            response_deserializer=ShardFileSetResponse.FromString,
        )
        self.__rpc_check_storage = channel.unary_unary(
            "/pfs_v2.API/CheckStorage",
            request_serializer=CheckStorageRequest.SerializeToString,
            response_deserializer=CheckStorageResponse.FromString,
        )
        self.__rpc_put_cache = channel.unary_unary(
            "/pfs_v2.API/PutCache",
            request_serializer=PutCacheRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_get_cache = channel.unary_unary(
            "/pfs_v2.API/GetCache",
            request_serializer=GetCacheRequest.SerializeToString,
            response_deserializer=GetCacheResponse.FromString,
        )
        self.__rpc_clear_cache = channel.unary_unary(
            "/pfs_v2.API/ClearCache",
            request_serializer=ClearCacheRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_list_task = channel.unary_stream(
            "/pfs_v2.API/ListTask",
            request_serializer=_taskapi__.ListTaskRequest.SerializeToString,
            response_deserializer=_taskapi__.TaskInfo.FromString,
        )
        self.__rpc_egress = channel.unary_unary(
            "/pfs_v2.API/Egress",
            request_serializer=EgressRequest.SerializeToString,
            response_deserializer=EgressResponse.FromString,
        )
        self.__rpc_create_project = channel.unary_unary(
            "/pfs_v2.API/CreateProject",
            request_serializer=CreateProjectRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_project = channel.unary_unary(
            "/pfs_v2.API/InspectProject",
            request_serializer=InspectProjectRequest.SerializeToString,
            response_deserializer=ProjectInfo.FromString,
        )
        self.__rpc_inspect_project_v2 = channel.unary_unary(
            "/pfs_v2.API/InspectProjectV2",
            request_serializer=InspectProjectV2Request.SerializeToString,
            response_deserializer=InspectProjectV2Response.FromString,
        )
        self.__rpc_list_project = channel.unary_stream(
            "/pfs_v2.API/ListProject",
            request_serializer=ListProjectRequest.SerializeToString,
            response_deserializer=ProjectInfo.FromString,
        )
        self.__rpc_delete_project = channel.unary_unary(
            "/pfs_v2.API/DeleteProject",
            request_serializer=DeleteProjectRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_repos_summary = channel.unary_unary(
            "/pfs_v2.API/ReposSummary",
            request_serializer=ReposSummaryRequest.SerializeToString,
            response_deserializer=ReposSummaryResponse.FromString,
        )
        self.__rpc_forget_commit = channel.unary_unary(
            "/pfs_v2.API/ForgetCommit",
            request_serializer=ForgetCommitRequest.SerializeToString,
            response_deserializer=ForgetCommitResponse.FromString,
        )

    def create_repo(
        self, *, repo: "Repo" = None, description: str = "", update: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = CreateRepoRequest()
        if repo is not None:
            request.repo = repo
        request.description = description
        request.update = update

        return self.__rpc_create_repo(request)

    def inspect_repo(self, *, repo: "Repo" = None) -> "RepoInfo":

        request = InspectRepoRequest()
        if repo is not None:
            request.repo = repo

        return self.__rpc_inspect_repo(request)

    def list_repo(
        self,
        *,
        type: str = "",
        projects: Optional[List["Project"]] = None,
        page: "RepoPage" = None
    ) -> Iterator["RepoInfo"]:
        projects = projects or []

        request = ListRepoRequest()
        request.type = type
        if projects is not None:
            request.projects = projects
        if page is not None:
            request.page = page

        for response in self.__rpc_list_repo(request):
            yield response

    def delete_repo(
        self, *, repo: "Repo" = None, force: bool = False
    ) -> "DeleteRepoResponse":

        request = DeleteRepoRequest()
        if repo is not None:
            request.repo = repo
        request.force = force

        return self.__rpc_delete_repo(request)

    def delete_repos(
        self,
        *,
        projects: Optional[List["Project"]] = None,
        force: bool = False,
        all: bool = False
    ) -> "DeleteReposResponse":
        projects = projects or []

        request = DeleteReposRequest()
        if projects is not None:
            request.projects = projects
        request.force = force
        request.all = all

        return self.__rpc_delete_repos(request)

    def start_commit(
        self, *, parent: "Commit" = None, description: str = "", branch: "Branch" = None
    ) -> "Commit":

        request = StartCommitRequest()
        if parent is not None:
            request.parent = parent
        request.description = description
        if branch is not None:
            request.branch = branch

        return self.__rpc_start_commit(request)

    def finish_commit(
        self,
        *,
        commit: "Commit" = None,
        description: str = "",
        error: str = "",
        force: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = FinishCommitRequest()
        if commit is not None:
            request.commit = commit
        request.description = description
        request.error = error
        request.force = force

        return self.__rpc_finish_commit(request)

    def clear_commit(
        self, *, commit: "Commit" = None
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = ClearCommitRequest()
        if commit is not None:
            request.commit = commit

        return self.__rpc_clear_commit(request)

    def inspect_commit(
        self, *, commit: "Commit" = None, wait: "CommitState" = None
    ) -> "CommitInfo":

        request = InspectCommitRequest()
        if commit is not None:
            request.commit = commit
        request.wait = wait

        return self.__rpc_inspect_commit(request)

    def list_commit(
        self,
        *,
        repo: "Repo" = None,
        from_: "Commit" = None,
        to: "Commit" = None,
        number: int = 0,
        reverse: bool = False,
        all: bool = False,
        origin_kind: "OriginKind" = None,
        started_time: datetime = None
    ) -> Iterator["CommitInfo"]:

        request = ListCommitRequest()
        if repo is not None:
            request.repo = repo
        if from_ is not None:
            request.from_ = from_
        if to is not None:
            request.to = to
        request.number = number
        request.reverse = reverse
        request.all = all
        request.origin_kind = origin_kind
        if started_time is not None:
            request.started_time = started_time

        for response in self.__rpc_list_commit(request):
            yield response

    def subscribe_commit(
        self,
        *,
        repo: "Repo" = None,
        branch: str = "",
        from_: "Commit" = None,
        state: "CommitState" = None,
        all: bool = False,
        origin_kind: "OriginKind" = None
    ) -> Iterator["CommitInfo"]:

        request = SubscribeCommitRequest()
        if repo is not None:
            request.repo = repo
        request.branch = branch
        if from_ is not None:
            request.from_ = from_
        request.state = state
        request.all = all
        request.origin_kind = origin_kind

        for response in self.__rpc_subscribe_commit(request):
            yield response

    def squash_commit(
        self, *, commit: "Commit" = None, recursive: bool = False
    ) -> "SquashCommitResponse":

        request = SquashCommitRequest()
        if commit is not None:
            request.commit = commit
        request.recursive = recursive

        return self.__rpc_squash_commit(request)

    def drop_commit(
        self, *, commit: "Commit" = None, recursive: bool = False
    ) -> "DropCommitResponse":

        request = DropCommitRequest()
        if commit is not None:
            request.commit = commit
        request.recursive = recursive

        return self.__rpc_drop_commit(request)

    def inspect_commit_set(
        self, *, commit_set: "CommitSet" = None, wait: bool = False
    ) -> Iterator["CommitInfo"]:

        request = InspectCommitSetRequest()
        if commit_set is not None:
            request.commit_set = commit_set
        request.wait = wait

        for response in self.__rpc_inspect_commit_set(request):
            yield response

    def list_commit_set(
        self, *, project: "Project" = None
    ) -> Iterator["CommitSetInfo"]:

        request = ListCommitSetRequest()
        if project is not None:
            request.project = project

        for response in self.__rpc_list_commit_set(request):
            yield response

    def squash_commit_set(
        self, *, commit_set: "CommitSet" = None
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = SquashCommitSetRequest()
        if commit_set is not None:
            request.commit_set = commit_set

        return self.__rpc_squash_commit_set(request)

    def drop_commit_set(
        self, *, commit_set: "CommitSet" = None
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = DropCommitSetRequest()
        if commit_set is not None:
            request.commit_set = commit_set

        return self.__rpc_drop_commit_set(request)

    def find_commits(
        self, *, start: "Commit" = None, file_path: str = "", limit: int = 0
    ) -> Iterator["FindCommitsResponse"]:

        request = FindCommitsRequest()
        if start is not None:
            request.start = start
        request.file_path = file_path
        request.limit = limit

        for response in self.__rpc_find_commits(request):
            yield response

    def walk_commit_provenance(
        self,
        *,
        start: Optional[List["CommitPicker"]] = None,
        max_commits: int = 0,
        max_depth: int = 0
    ) -> Iterator["CommitInfo"]:
        start = start or []

        request = WalkCommitProvenanceRequest()
        if start is not None:
            request.start = start
        request.max_commits = max_commits
        request.max_depth = max_depth

        for response in self.__rpc_walk_commit_provenance(request):
            yield response

    def walk_commit_subvenance(
        self,
        *,
        start: Optional[List["CommitPicker"]] = None,
        max_commits: int = 0,
        max_depth: int = 0
    ) -> Iterator["CommitInfo"]:
        start = start or []

        request = WalkCommitSubvenanceRequest()
        if start is not None:
            request.start = start
        request.max_commits = max_commits
        request.max_depth = max_depth

        for response in self.__rpc_walk_commit_subvenance(request):
            yield response

    def create_branch(
        self,
        *,
        head: "Commit" = None,
        branch: "Branch" = None,
        provenance: Optional[List["Branch"]] = None,
        trigger: "Trigger" = None,
        new_commit_set: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":
        provenance = provenance or []

        request = CreateBranchRequest()
        if head is not None:
            request.head = head
        if branch is not None:
            request.branch = branch
        if provenance is not None:
            request.provenance = provenance
        if trigger is not None:
            request.trigger = trigger
        request.new_commit_set = new_commit_set

        return self.__rpc_create_branch(request)

    def inspect_branch(self, *, branch: "Branch" = None) -> "BranchInfo":

        request = InspectBranchRequest()
        if branch is not None:
            request.branch = branch

        return self.__rpc_inspect_branch(request)

    def list_branch(
        self, *, repo: "Repo" = None, reverse: bool = False
    ) -> Iterator["BranchInfo"]:

        request = ListBranchRequest()
        if repo is not None:
            request.repo = repo
        request.reverse = reverse

        for response in self.__rpc_list_branch(request):
            yield response

    def delete_branch(
        self, *, branch: "Branch" = None, force: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = DeleteBranchRequest()
        if branch is not None:
            request.branch = branch
        request.force = force

        return self.__rpc_delete_branch(request)

    def walk_branch_provenance(
        self,
        *,
        start: Optional[List["BranchPicker"]] = None,
        max_branches: int = 0,
        max_depth: int = 0
    ) -> Iterator["BranchInfo"]:
        start = start or []

        request = WalkBranchProvenanceRequest()
        if start is not None:
            request.start = start
        request.max_branches = max_branches
        request.max_depth = max_depth

        for response in self.__rpc_walk_branch_provenance(request):
            yield response

    def walk_branch_subvenance(
        self,
        *,
        start: Optional[List["BranchPicker"]] = None,
        max_branches: int = 0,
        max_depth: int = 0
    ) -> Iterator["BranchInfo"]:
        start = start or []

        request = WalkBranchSubvenanceRequest()
        if start is not None:
            request.start = start
        request.max_branches = max_branches
        request.max_depth = max_depth

        for response in self.__rpc_walk_branch_subvenance(request):
            yield response

    def modify_file(
        self,
        request_iterator: Union[
            AsyncIterable["ModifyFileRequest"], Iterable["ModifyFileRequest"]
        ],
    ) -> "betterproto_lib_google_protobuf.Empty":

        return self.__rpc_modify_file(request_iterator)

    def get_file(
        self,
        *,
        file: "File" = None,
        url: str = "",
        offset: int = 0,
        path_range: "PathRange" = None
    ) -> Iterator["betterproto_lib_google_protobuf.BytesValue"]:

        request = GetFileRequest()
        if file is not None:
            request.file = file
        request.url = url
        request.offset = offset
        if path_range is not None:
            request.path_range = path_range

        for response in self.__rpc_get_file(request):
            yield response

    def get_file_tar(
        self,
        *,
        file: "File" = None,
        url: str = "",
        offset: int = 0,
        path_range: "PathRange" = None
    ) -> Iterator["betterproto_lib_google_protobuf.BytesValue"]:

        request = GetFileRequest()
        if file is not None:
            request.file = file
        request.url = url
        request.offset = offset
        if path_range is not None:
            request.path_range = path_range

        for response in self.__rpc_get_file_tar(request):
            yield response

    def inspect_file(self, *, file: "File" = None) -> "FileInfo":

        request = InspectFileRequest()
        if file is not None:
            request.file = file

        return self.__rpc_inspect_file(request)

    def list_file(
        self,
        *,
        file: "File" = None,
        pagination_marker: "File" = None,
        number: int = 0,
        reverse: bool = False
    ) -> Iterator["FileInfo"]:

        request = ListFileRequest()
        if file is not None:
            request.file = file
        if pagination_marker is not None:
            request.pagination_marker = pagination_marker
        request.number = number
        request.reverse = reverse

        for response in self.__rpc_list_file(request):
            yield response

    def walk_file(
        self,
        *,
        file: "File" = None,
        pagination_marker: "File" = None,
        number: int = 0,
        reverse: bool = False
    ) -> Iterator["FileInfo"]:

        request = WalkFileRequest()
        if file is not None:
            request.file = file
        if pagination_marker is not None:
            request.pagination_marker = pagination_marker
        request.number = number
        request.reverse = reverse

        for response in self.__rpc_walk_file(request):
            yield response

    def glob_file(
        self,
        *,
        commit: "Commit" = None,
        pattern: str = "",
        path_range: "PathRange" = None
    ) -> Iterator["FileInfo"]:

        request = GlobFileRequest()
        if commit is not None:
            request.commit = commit
        request.pattern = pattern
        if path_range is not None:
            request.path_range = path_range

        for response in self.__rpc_glob_file(request):
            yield response

    def diff_file(
        self, *, new_file: "File" = None, old_file: "File" = None, shallow: bool = False
    ) -> Iterator["DiffFileResponse"]:

        request = DiffFileRequest()
        if new_file is not None:
            request.new_file = new_file
        if old_file is not None:
            request.old_file = old_file
        request.shallow = shallow

        for response in self.__rpc_diff_file(request):
            yield response

    def activate_auth(self) -> "ActivateAuthResponse":

        request = ActivateAuthRequest()

        return self.__rpc_activate_auth(request)

    def delete_all(self) -> "betterproto_lib_google_protobuf.Empty":

        request = betterproto_lib_google_protobuf.Empty()

        return self.__rpc_delete_all(request)

    def fsck(
        self,
        *,
        fix: bool = False,
        zombie_target: "Commit" = None,
        zombie_all: bool = False
    ) -> Iterator["FsckResponse"]:

        request = FsckRequest()
        request.fix = fix
        if zombie_target is not None:
            request.zombie_target = zombie_target
        request.zombie_all = zombie_all

        for response in self.__rpc_fsck(request):
            yield response

    def create_file_set(
        self,
        request_iterator: Union[
            AsyncIterable["ModifyFileRequest"], Iterable["ModifyFileRequest"]
        ],
    ) -> "CreateFileSetResponse":

        return self.__rpc_create_file_set(request_iterator)

    def get_file_set(
        self, *, commit: "Commit" = None, type: "GetFileSetRequestFileSetType" = None
    ) -> "CreateFileSetResponse":

        request = GetFileSetRequest()
        if commit is not None:
            request.commit = commit
        request.type = type

        return self.__rpc_get_file_set(request)

    def add_file_set(
        self, *, commit: "Commit" = None, file_set_id: str = ""
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = AddFileSetRequest()
        if commit is not None:
            request.commit = commit
        request.file_set_id = file_set_id

        return self.__rpc_add_file_set(request)

    def renew_file_set(
        self, *, file_set_id: str = "", ttl_seconds: int = 0
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = RenewFileSetRequest()
        request.file_set_id = file_set_id
        request.ttl_seconds = ttl_seconds

        return self.__rpc_renew_file_set(request)

    def compose_file_set(
        self,
        *,
        file_set_ids: Optional[List[str]] = None,
        ttl_seconds: int = 0,
        compact: bool = False
    ) -> "CreateFileSetResponse":
        file_set_ids = file_set_ids or []

        request = ComposeFileSetRequest()
        request.file_set_ids = file_set_ids
        request.ttl_seconds = ttl_seconds
        request.compact = compact

        return self.__rpc_compose_file_set(request)

    def shard_file_set(
        self, *, file_set_id: str = "", num_files: int = 0, size_bytes: int = 0
    ) -> "ShardFileSetResponse":

        request = ShardFileSetRequest()
        request.file_set_id = file_set_id
        request.num_files = num_files
        request.size_bytes = size_bytes

        return self.__rpc_shard_file_set(request)

    def check_storage(
        self,
        *,
        read_chunk_data: bool = False,
        chunk_begin: bytes = b"",
        chunk_end: bytes = b""
    ) -> "CheckStorageResponse":

        request = CheckStorageRequest()
        request.read_chunk_data = read_chunk_data
        request.chunk_begin = chunk_begin
        request.chunk_end = chunk_end

        return self.__rpc_check_storage(request)

    def put_cache(
        self,
        *,
        key: str = "",
        value: "betterproto_lib_google_protobuf.Any" = None,
        file_set_ids: Optional[List[str]] = None,
        tag: str = ""
    ) -> "betterproto_lib_google_protobuf.Empty":
        file_set_ids = file_set_ids or []

        request = PutCacheRequest()
        request.key = key
        if value is not None:
            request.value = value
        request.file_set_ids = file_set_ids
        request.tag = tag

        return self.__rpc_put_cache(request)

    def get_cache(self, *, key: str = "") -> "GetCacheResponse":

        request = GetCacheRequest()
        request.key = key

        return self.__rpc_get_cache(request)

    def clear_cache(
        self, *, tag_prefix: str = ""
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = ClearCacheRequest()
        request.tag_prefix = tag_prefix

        return self.__rpc_clear_cache(request)

    def list_task(self, *, group: "Group" = None) -> Iterator["_taskapi__.TaskInfo"]:

        request = _taskapi__.ListTaskRequest()
        if group is not None:
            request.group = group

        for response in self.__rpc_list_task(request):
            yield response

    def egress(
        self,
        *,
        commit: "Commit" = None,
        object_storage: "ObjectStorageEgress" = None,
        sql_database: "SqlDatabaseEgress" = None
    ) -> "EgressResponse":

        request = EgressRequest()
        if commit is not None:
            request.commit = commit
        if object_storage is not None:
            request.object_storage = object_storage
        if sql_database is not None:
            request.sql_database = sql_database

        return self.__rpc_egress(request)

    def create_project(
        self, *, project: "Project" = None, description: str = "", update: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = CreateProjectRequest()
        if project is not None:
            request.project = project
        request.description = description
        request.update = update

        return self.__rpc_create_project(request)

    def inspect_project(self, *, project: "Project" = None) -> "ProjectInfo":

        request = InspectProjectRequest()
        if project is not None:
            request.project = project

        return self.__rpc_inspect_project(request)

    def inspect_project_v2(
        self, *, project: "Project" = None
    ) -> "InspectProjectV2Response":

        request = InspectProjectV2Request()
        if project is not None:
            request.project = project

        return self.__rpc_inspect_project_v2(request)

    def list_project(self) -> Iterator["ProjectInfo"]:

        request = ListProjectRequest()

        for response in self.__rpc_list_project(request):
            yield response

    def delete_project(
        self, *, project: "Project" = None, force: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = DeleteProjectRequest()
        if project is not None:
            request.project = project
        request.force = force

        return self.__rpc_delete_project(request)

    def repos_summary(
        self, *, projects: Optional[List["ProjectPicker"]] = None
    ) -> "ReposSummaryResponse":
        projects = projects or []

        request = ReposSummaryRequest()
        if projects is not None:
            request.projects = projects

        return self.__rpc_repos_summary(request)

    def forget_commit(self, *, commit: "CommitPicker" = None) -> "ForgetCommitResponse":

        request = ForgetCommitRequest()
        if commit is not None:
            request.commit = commit

        return self.__rpc_forget_commit(request)

Sub-modules

pachyderm_sdk.api.pfs.extension: Handwritten classes/methods that augment the existing PFS API.
pachyderm_sdk.api.pfs.file

Classes

class OriginKind (*args, **kwds)

These are the different places where a commit may be originated from

Expand source code

class OriginKind(betterproto.Enum):
    """These are the different places where a commit may be originated from"""

    ORIGIN_KIND_UNKNOWN = 0
    USER = 1
    AUTO = 2
    FSCK = 3

Ancestors

betterproto.Enum
enum.IntEnum
builtins.int
enum.ReprEnum
enum.Enum

Class variables

var ORIGIN_KIND_UNKNOWN
var USER
var AUTO
var FSCK

class FileType (*args, **kwds)

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases :class:enum.IntEnum.

Expand source code

class FileType(betterproto.Enum):
    RESERVED = 0
    FILE = 1
    DIR = 2

Ancestors

betterproto.Enum
enum.IntEnum
builtins.int
enum.ReprEnum
enum.Enum

Class variables

var RESERVED
var FILE
var DIR

class CommitState (*args, **kwds)

CommitState describes the states a commit can be in. The states are increasingly specific, i.e. a commit that is FINISHED also counts as STARTED.

Expand source code

class CommitState(betterproto.Enum):
    """
    CommitState describes the states a commit can be in. The states are
    increasingly specific, i.e. a commit that is FINISHED also counts as
    STARTED.
    """

    COMMIT_STATE_UNKNOWN = 0
    STARTED = 1
    READY = 2
    FINISHING = 3
    FINISHED = 4

Ancestors

betterproto.Enum
enum.IntEnum
builtins.int
enum.ReprEnum
enum.Enum

Class variables

var COMMIT_STATE_UNKNOWN
var STARTED
var READY
var FINISHING
var FINISHED

class Delimiter (*args, **kwds)

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases :class:enum.IntEnum.

Expand source code

class Delimiter(betterproto.Enum):
    NONE = 0
    JSON = 1
    LINE = 2
    SQL = 3
    CSV = 4

Ancestors

betterproto.Enum
enum.IntEnum
builtins.int
enum.ReprEnum
enum.Enum

Class variables

var NONE
var JSON
var LINE
var SQL
var CSV

class RepoPageOrdering (*args, **kwds)

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases :class:enum.IntEnum.

Expand source code

class RepoPageOrdering(betterproto.Enum):
    PROJECT_REPO = 0

Ancestors

betterproto.Enum
enum.IntEnum
builtins.int
enum.ReprEnum
enum.Enum

Class variables

var PROJECT_REPO

class GetFileSetRequestFileSetType (*args, **kwds)

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases :class:enum.IntEnum.

Expand source code

class GetFileSetRequestFileSetType(betterproto.Enum):
    TOTAL = 0
    DIFF = 1

Ancestors

betterproto.Enum
enum.IntEnum
builtins.int
enum.ReprEnum
enum.Enum

Class variables

var TOTAL
var DIFF

class SqlDatabaseEgressFileFormatType (*args, **kwds)

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases :class:enum.IntEnum.

Expand source code

class SqlDatabaseEgressFileFormatType(betterproto.Enum):
    UNKNOWN = 0
    CSV = 1
    JSON = 2
    PARQUET = 3

Ancestors

betterproto.Enum
enum.IntEnum
builtins.int
enum.ReprEnum
enum.Enum

Class variables

var UNKNOWN
var CSV
var JSON
var PARQUET

class Repo (name: str = None, type: str = None, project: Project = None)

Repo(name: str = None, type: str = None, project: 'Project' = None)

Expand source code

@dataclass(eq=False, repr=False)
class Repo(betterproto.Message):
    name: str = betterproto.string_field(1)
    type: str = betterproto.string_field(2)
    project: "Project" = betterproto.message_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var name : str
var type : str
var project : Project

Methods

def from_uri(uri: str) ‑> Repo

Parses the following format: [project/]repo

If no project is specified it defaults to "default".

Expand source code

def _Repo_from_uri(uri: str) -> Repo:
    """
    Parses the following format:
        [project/]repo

    If no project is specified it defaults to "default".
    """
    if "/" in uri:
        project, repo = uri.split("/", 1)
    else:
        project, repo = "default", uri
    return Repo(name=repo, type="user", project=Project(name=project))

def as_uri(self: Repo) ‑> str

Returns the URI for the Repo object in the following format: project/repo

If no project is specified it defaults to "default"

Expand source code

def _Repo_as_uri(self: "Repo") -> str:
    """Returns the URI for the Repo object in the following format:
      project/repo

    If no project is specified it defaults to "default"
    """
    if not self.name:
        raise ValueError("Empty repo name")
    project = "default"
    if self.project and self.project.name:
        project = self.project.name
    return f"{project}/{self.name}"

def as_picker(self: Repo) ‑> RepoPicker

Converts a Repo to a RepoPicker

Expand source code

def _Repo_as_picker(self: "Repo") -> RepoPicker:
    """Converts a Repo to a RepoPicker"""
    project = None if self.project is None else self.project.as_picker()
    return RepoPicker(
        name=RepoPickerRepoName(name=self.name, type=self.type, project=project)
    )

class RepoPicker (name: RepoPickerRepoName = None)

Repo defines mutually exclusive pickers that resolve to a single repository. Currently, the only way to pick a repo is by composing a repo name and type with a project. If the type is omitted, the 'user' type will be used as a default. Picker messages should only be used as request parameters.

Expand source code

@dataclass(eq=False, repr=False)
class RepoPicker(betterproto.Message):
    """
    Repo defines mutually exclusive pickers that resolve to a single
    repository. Currently, the only way to pick a repo is by composing a repo
    name and type with a project. If the type is omitted, the 'user' type will
    be used as a default. Picker messages should only be used as request
    parameters.
    """

    name: "RepoPickerRepoName" = betterproto.message_field(1, group="picker")

Ancestors

betterproto.Message
abc.ABC

Class variables

var name : RepoPickerRepoName

Methods

def from_uri(uri: str) ‑> RepoPicker

Parses the following format: [project/]repo

If no project is specified it defaults to "default".

Expand source code

def _RepoPicker_from_uri(uri: str) -> RepoPicker:
    """
    Parses the following format:
        [project/]repo

    If no project is specified it defaults to "default".
    """
    return Repo.from_uri(uri).as_picker()

def as_uri(self: RepoPicker) ‑> str

Returns the URI for the RepoPicker object in the following format: project/repo

If no project is specified it defaults to "default"

Expand source code

def _RepoPicker_as_uri(self: RepoPicker) -> str:
    """
    Returns the URI for the RepoPicker object in the following format:
        project/repo

    If no project is specified it defaults to "default"
    """
    project = "default"
    if self.name.project and self.name.project.name:
        project = self.name.project.name
    return f"{project}/{self.name.name}"

class RepoPickerRepoName (project: ProjectPicker = None, name: str = None, type: str = None)

RepoPickerRepoName(project: 'ProjectPicker' = None, name: str = None, type: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class RepoPickerRepoName(betterproto.Message):
    project: "ProjectPicker" = betterproto.message_field(1)
    name: str = betterproto.string_field(2)
    type: str = betterproto.string_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : ProjectPicker
var name : str
var type : str

class Branch (repo: Repo = None, name: str = None)

Branch(repo: 'Repo' = None, name: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class Branch(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    name: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo
var name : str

Methods

def from_uri(uri: str) ‑> Branch

Parses the following format: [project/]repo@branch

If no project is specified it defaults to "default".

Raises

ValueError: If no branch is specified.

Expand source code

def _Branch_from_uri(uri: str) -> Branch:
    """
    Parses the following format:
        [project/]repo@branch

    If no project is specified it defaults to "default".

    Raises:
        ValueError: If no branch is specified.
    """
    if "@" not in uri:
        raise ValueError(
            "Could not parse branch/commit. URI must have the form: "
            "[project/]<repo>@branch"
        )
    project_repo, branch = uri.split("@", 1)
    if not branch_re.match(branch):
        raise ValueError(f"Invalid branch name: {branch}")
    return Branch(name=branch, repo=Repo.from_uri(project_repo))

def as_uri(self: Branch) ‑> str

Returns the URI for the Branch object in the following format: project/repo@branch

If no project is specified it defaults to "default"

Expand source code

def _Branch_as_uri(self: "Branch") -> str:
    """Returns the URI for the Branch object in the following format:
      project/repo@branch

    If no project is specified it defaults to "default"
    """
    return f"{self.repo.as_uri()}@{self.name}"

def as_picker(self: Branch) ‑> BranchPicker

Converts a Branch to a BranchPicker.

Expand source code

def _Branch_as_picker(self: "Branch") -> BranchPicker:
    """Converts a Branch to a BranchPicker."""
    repo = self.repo.as_picker()
    return BranchPicker(name=BranchPickerBranchName(name=self.name, repo=repo))

class BranchPicker (name: BranchPickerBranchName = None)

BranchPicker defines mutually exclusive pickers that resolve to a single branch. Currently, the only way to pick a branch is by composing a branch name with a repo. Picker messages should only be used as request parameters.

Expand source code

@dataclass(eq=False, repr=False)
class BranchPicker(betterproto.Message):
    """
    BranchPicker defines mutually exclusive pickers that resolve to a single
    branch. Currently, the only way to pick a branch is by composing a branch
    name with a repo. Picker messages should only be used as request
    parameters.
    """

    name: "BranchPickerBranchName" = betterproto.message_field(1, group="picker")

Ancestors

betterproto.Message
abc.ABC

Class variables

var name : BranchPickerBranchName

Methods

def from_uri(uri: str) ‑> BranchPicker

Parses the following format: [project/]repo@branch

If no project is specified it defaults to "default".

Raises

ValueError: If no branch is specified.

Expand source code

def _BranchPicker_from_uri(uri: str) -> BranchPicker:
    """
    Parses the following format:
        [project/]repo@branch

    If no project is specified it defaults to "default".

    Raises:
        ValueError: If no branch is specified.
    """
    return Branch.from_uri(uri).as_picker()

def as_uri(self: BranchPicker) ‑> str

Returns the URI for the BranchPicker object in the following format: project/repo@branch

If no project is specified it defaults to "default"

Expand source code

def _BranchPicker_as_uri(self: BranchPicker) -> str:
    """Returns the URI for the BranchPicker object in the following format:
      project/repo@branch

    If no project is specified it defaults to "default"
    """
    return f"{self.name.repo.as_uri()}@{self.name.name}"

class BranchPickerBranchName (repo: RepoPicker = None, name: str = None)

BranchPickerBranchName(repo: 'RepoPicker' = None, name: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class BranchPickerBranchName(betterproto.Message):
    repo: "RepoPicker" = betterproto.message_field(1)
    name: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : RepoPicker
var name : str

class File (commit: Commit = None, path: str = None, datum: str = None)

File(commit: 'Commit' = None, path: str = None, datum: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class File(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    path: str = betterproto.string_field(2)
    datum: str = betterproto.string_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var path : str
var datum : str

Methods

def from_uri(uri: str) ‑> File

Parses the following format: [project/]repo@branch-or-commit[:path/in/pfs] where @branch-or-commit can take the form: @branch @branch=commit @commit Additionally @branch-or-commit can be augmented with caret notation: @branch^2

All unspecified components will default to None, except for an unspecified project which defaults to "default".

Expand source code

def _File_from_uri(uri: str) -> File:
    """
    Parses the following format:
        [project/]repo@branch-or-commit[:path/in/pfs]
    where @branch-or-commit can take the form:
        @branch
        @branch=commit
        @commit
    Additionally @branch-or-commit can be augmented with caret notation:
        @branch^2

    All unspecified components will default to None, except for an unspecified
      project which defaults to "default".
    """
    if ":" in uri:
        project_repo_branch, path = uri.split(":", 1)
    else:
        project_repo_branch, path = uri, None

    return File(
        commit=Commit.from_uri(project_repo_branch),
        path=path,
    )

def as_uri(self: File) ‑> str

Returns the URI for the File object in one of the following formats: project/repo@branch:/path project/repo@branch=commit:/path project/repo@commit:/path

If no project is specified it defaults to "default"

Expand source code

def _File_as_uri(self: "File") -> str:
    """Returns the URI for the File object in one of the following formats:
        project/repo@branch:/path
        project/repo@branch=commit:/path
        project/repo@commit:/path

    If no project is specified it defaults to "default"
    """
    return f"{self.commit.as_uri()}:{self.path}"

class RepoInfo (repo: Repo = None, created: datetime.datetime = None, size_bytes_upper_bound: int = None, description: str = None, branches: List[ForwardRef('Branch')] = None, auth_info: AuthInfo = None, details: RepoInfoDetails = None, metadata: Dict[str, str] = None)

RepoInfo is the main data structure representing a Repo in etcd

Expand source code

@dataclass(eq=False, repr=False)
class RepoInfo(betterproto.Message):
    """RepoInfo is the main data structure representing a Repo in etcd"""

    repo: "Repo" = betterproto.message_field(1)
    created: datetime = betterproto.message_field(2)
    size_bytes_upper_bound: int = betterproto.int64_field(3)
    description: str = betterproto.string_field(4)
    branches: List["Branch"] = betterproto.message_field(5)
    auth_info: "AuthInfo" = betterproto.message_field(6)
    """
    Set by ListRepo and InspectRepo if Pachyderm's auth system is active, but
    not stored in etcd. To set a user's auth scope for a repo, use the
    Pachyderm Auth API (in src/client/auth/auth.proto)
    """

    details: "RepoInfoDetails" = betterproto.message_field(7)
    metadata: Dict[str, str] = betterproto.map_field(
        8, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    """Metadata are user-defined key-value pairs."""

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo
var created : datetime.datetime
var size_bytes_upper_bound : int
var description : str
var branches : List[Branch]
var auth_info : AuthInfo: Set by ListRepo and InspectRepo if Pachyderm's auth system is active, but not stored in etcd. To set a user's auth scope for a repo, use the Pachyderm Auth API (in src/client/auth/auth.proto)
var details : RepoInfoDetails
var metadata : Dict[str, str]: Metadata are user-defined key-value pairs.

class RepoInfoDetails (size_bytes: int = None)

Details are only provided when explicitly requested

Expand source code

@dataclass(eq=False, repr=False)
class RepoInfoDetails(betterproto.Message):
    """Details are only provided when explicitly requested"""

    size_bytes: int = betterproto.int64_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var size_bytes : int

class AuthInfo (permissions: List[ForwardRef('_auth__.Permission')] = None, roles: List[str] = None)

AuthInfo includes the caller's access scope for a resource, and is returned by services like ListRepo, InspectRepo, and ListProject, but is not persisted in the database. It's used by the Pachyderm dashboard to render repo access appropriately. To set a user's auth scope for a resource, use the Pachyderm Auth API (in src/auth/auth.proto)

Expand source code

@dataclass(eq=False, repr=False)
class AuthInfo(betterproto.Message):
    """
    AuthInfo includes the caller's access scope for a resource, and is returned
    by services like ListRepo, InspectRepo, and ListProject, but is not
    persisted in the database. It's used by the Pachyderm dashboard to render
    repo access appropriately. To set a user's auth scope for a resource, use
    the Pachyderm Auth API (in src/auth/auth.proto)
    """

    permissions: List["_auth__.Permission"] = betterproto.enum_field(1)
    """
    The callers access level to the relevant resource. These are very granular
    permissions - for the end user it makes sense to show them the roles they
    have instead.
    """

    roles: List[str] = betterproto.string_field(2)
    """
    The caller's roles on the relevant resource. This includes inherited roles
    from the cluster, project, group membership, etc.
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var permissions : List[Permission]: The callers access level to the relevant resource. These are very granular permissions - for the end user it makes sense to show them the roles they have instead.
var roles : List[str]: The caller's roles on the relevant resource. This includes inherited roles from the cluster, project, group membership, etc.

class BranchInfo (branch: Branch = None, head: Commit = None, provenance: List[ForwardRef('Branch')] = None, subvenance: List[ForwardRef('Branch')] = None, direct_provenance: List[ForwardRef('Branch')] = None, trigger: Trigger = None, metadata: Dict[str, str] = None, created_by: str = None, created_at: datetime.datetime = None, updated_at: datetime.datetime = None)

BranchInfo(branch: 'Branch' = None, head: 'Commit' = None, provenance: List[ForwardRef('Branch')] = None, subvenance: List[ForwardRef('Branch')] = None, direct_provenance: List[ForwardRef('Branch')] = None, trigger: 'Trigger' = None, metadata: Dict[str, str] = None, created_by: str = None, created_at: datetime.datetime = None, updated_at: datetime.datetime = None)

Expand source code

@dataclass(eq=False, repr=False)
class BranchInfo(betterproto.Message):
    branch: "Branch" = betterproto.message_field(1)
    head: "Commit" = betterproto.message_field(2)
    provenance: List["Branch"] = betterproto.message_field(3)
    subvenance: List["Branch"] = betterproto.message_field(4)
    direct_provenance: List["Branch"] = betterproto.message_field(5)
    trigger: "Trigger" = betterproto.message_field(6)
    metadata: Dict[str, str] = betterproto.map_field(
        7, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    """Metadata on the branch."""

    created_by: str = betterproto.string_field(8)
    """The user that caused this branch to be created."""

    created_at: datetime = betterproto.message_field(9)
    """When the branch was added to the database."""

    updated_at: datetime = betterproto.message_field(10)
    """
    When information about the branch was last modified (not necessarily when
    the data in this branch changed or anything like that).
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var branch : Branch
var head : Commit
var provenance : List[Branch]
var subvenance : List[Branch]
var direct_provenance : List[Branch]
var trigger : Trigger
var metadata : Dict[str, str]: Metadata on the branch.
var created_by : str: The user that caused this branch to be created.
var created_at : datetime.datetime: When the branch was added to the database.
var updated_at : datetime.datetime: When information about the branch was last modified (not necessarily when the data in this branch changed or anything like that).

class Trigger (branch: str = None, all: bool = None, rate_limit_spec: str = None, size: str = None, commits: int = None, cron_spec: str = None)

Trigger defines the conditions under which a head is moved, and to which branch it is moved.

Expand source code

@dataclass(eq=False, repr=False)
class Trigger(betterproto.Message):
    """
    Trigger defines the conditions under which a head is moved, and to which
    branch it is moved.
    """

    branch: str = betterproto.string_field(1)
    """Which branch this trigger refers to"""

    all: bool = betterproto.bool_field(2)
    """
    All indicates that all conditions must be satisfied before the trigger
    happens, otherwise any conditions being satisfied will trigger it.
    """

    rate_limit_spec: str = betterproto.string_field(3)
    """
    Triggers if the rate limit spec (cron expression) has been satisfied since
    the last trigger.
    """

    size: str = betterproto.string_field(4)
    """
    Triggers if there's been `size` new data added since the last trigger.
    """

    commits: int = betterproto.int64_field(5)
    """
    Triggers if there's been `commits` new commits added since the last
    trigger.
    """

    cron_spec: str = betterproto.string_field(6)
    """
    Creates a background process which fires the trigger on the schedule
    provided by the cron spec. This condition is mutually exclusive with
    respect to the others, so setting this will result with the trigger only
    firing based on the cron schedule.
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var branch : str: Which branch this trigger refers to
var all : bool: All indicates that all conditions must be satisfied before the trigger happens, otherwise any conditions being satisfied will trigger it.
var rate_limit_spec : str: Triggers if the rate limit spec (cron expression) has been satisfied since the last trigger.
var size : str: Triggers if there's been size new data added since the last trigger.
var commits : int: Triggers if there's been commits new commits added since the last trigger.
var cron_spec : str: Creates a background process which fires the trigger on the schedule provided by the cron spec. This condition is mutually exclusive with respect to the others, so setting this will result with the trigger only firing based on the cron schedule.

class CommitOrigin (kind: OriginKind = None)

CommitOrigin(kind: 'OriginKind' = None)

Expand source code

@dataclass(eq=False, repr=False)
class CommitOrigin(betterproto.Message):
    kind: "OriginKind" = betterproto.enum_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var kind : OriginKind

class Commit (repo: Repo = None, id: str = None, branch: Branch = None)

Commit is a reference to a commit (e.g. the collection of branches and the collection of currently-open commits in etcd are collections of Commit protos)

Expand source code

@dataclass(eq=False, repr=False)
class Commit(betterproto.Message):
    """
    Commit is a reference to a commit (e.g. the collection of branches and the
    collection of currently-open commits in etcd are collections of Commit
    protos)
    """

    repo: "Repo" = betterproto.message_field(3)
    id: str = betterproto.string_field(2)
    branch: "Branch" = betterproto.message_field(1)
    """only used by the client"""

Ancestors

betterproto.Message
abc.ABC

Subclasses

ClosedCommit

Class variables

var repo : Repo
var id : str
var branch : Branch: only used by the client

Methods

def from_uri(uri: str) ‑> Commit

Parses the following format: [project/]repo@branch-or-commit where @branch-or-commit can take the form: @branch @branch=commit @commit Additionally @branch-or-commit can be augmented with caret notation: @branch^2

All unspecified components will default to None, except for an unspecified project which defaults to "default".

Expand source code

def _Commit_from_uri(uri: str) -> Commit:
    """
    Parses the following format:
        [project/]repo@branch-or-commit
    where @branch-or-commit can take the form:
        @branch
        @branch=commit
        @commit
    Additionally @branch-or-commit can be augmented with caret notation:
        @branch^2

    All unspecified components will default to None, except for an unspecified
      project which defaults to "default".
    """
    if "@" not in uri:
        raise ValueError(
            "Could not parse branch/commit. URI must have the form: "
            "[project/]<repo>@(branch|branch=commit|commit)"
        )
    project_repo, branch_or_commit = uri.split("@", 1)
    repo = Repo.from_uri(project_repo)
    if "=" in branch_or_commit:
        branch, commit = branch_or_commit.split("=", 1)
    elif uuid_re.match(branch_or_commit) or not branch_re.match(branch_or_commit):
        branch, commit = None, branch_or_commit
    else:
        branch, commit = branch_or_commit, None
    # TODO: Commits are no longer pinned to branches.
    #       When officially deprecated, the `branch` field will be removed.
    return Commit(
        branch=Branch(name=branch, repo=repo),
        id=commit,
        repo=repo,
    )

def as_uri(self: Commit) ‑> str

Returns the URI for the Commit object in one of the following formats: project/repo@branch project/repo@branch=commit project/repo@commit

If no project is specified it defaults to "default"

Expand source code

def _Commit_as_uri(self: "Commit") -> str:
    """Returns the URI for the Commit object in one of the following formats:
        project/repo@branch
        project/repo@branch=commit
        project/repo@commit

    If no project is specified it defaults to "default"
    """
    if self.branch:
        project_repo = self.branch.repo.as_uri()
        if self.branch.name and self.id:
            return f"{project_repo}@{self.branch.name}={self.id}"
        elif self.branch.name:
            return f"{project_repo}@{self.branch.name}"
        else:
            return f"{project_repo}@{self.id}"

    project_repo = self.repo.as_uri()
    return f"{project_repo}@{self.id}"

def as_picker(self: Commit) ‑> CommitPicker

Converts a Commit to a CommitPicker.

Expand source code

def _Commit_as_picker(self: "Commit") -> CommitPicker:
    """Converts a Commit to a CommitPicker."""
    # Note: Due to the fact the ancestor/branch offset notation was
    #   encoded within the Commit.id field, a more direct conversion
    #   from Commit -> CommitPicker would already require a lot of
    #   str parsing. Therefore, the choice was made to implement all
    #   of this within the CommitPicker.from_uri method.
    return CommitPicker.from_uri(self.as_uri())

class CommitPicker (branch_head: BranchPicker = None, id: CommitPickerCommitByGlobalId = None, ancestor: CommitPickerAncestorOf = None, branch_root: CommitPickerBranchRoot = None)

CommitPicker defines mutually exclusive pickers that resolve to a single commit. Commits can be picked relatively from some other commit like a parent or start of branch. Alternatively, they can be picked via their global Id, which is composed of a repo picker and an id. Picker messages should only be used as request parameters.

Expand source code

@dataclass(eq=False, repr=False)
class CommitPicker(betterproto.Message):
    """
    CommitPicker defines mutually exclusive pickers that resolve to a single
    commit. Commits can be picked relatively from some other commit like a
    parent or start of branch. Alternatively, they can be picked via their
    global Id, which is composed of a repo picker and an id. Picker messages
    should only be used as request parameters.
    """

    branch_head: "BranchPicker" = betterproto.message_field(1, group="picker")
    id: "CommitPickerCommitByGlobalId" = betterproto.message_field(2, group="picker")
    ancestor: "CommitPickerAncestorOf" = betterproto.message_field(3, group="picker")
    branch_root: "CommitPickerBranchRoot" = betterproto.message_field(4, group="picker")

Ancestors

betterproto.Message
abc.ABC

Class variables

var branch_head : BranchPicker
var id : CommitPickerCommitByGlobalId
var ancestor : CommitPickerAncestorOf
var branch_root : CommitPickerBranchRoot

Methods

def from_uri(uri: str) ‑> CommitPicker

All unspecified components will default to None, except for an unspecified project which defaults to "default".

Expand source code

def _CommitPicker_from_uri(uri: str) -> CommitPicker:
    """
    Parses the following format:
        [project/]repo@branch-or-commit
    where @branch-or-commit can take the form:
        @branch
        @branch=commit
        @commit
    Additionally @branch-or-commit can be augmented in the following ways:
        @branch.2
        @commit^3

    All unspecified components will default to None, except for an unspecified
      project which defaults to "default".
    """

    def parse_offset(value: str) -> int:
        try:
            return int(value)
        except ValueError:
            raise ValueError(
                "Could not parse commit uri. "
                "Branch name is invalid - expected a integer offset. "
                f"uri: {uri}"
            )

    if "@" not in uri:
        raise ValueError(
            "Could not parse branch/commit. URI must have the form: "
            "[project/]<repo>@(branch|branch=commit|commit)"
        )
    project_repo, branch_or_commit = uri.split("@", 1)
    repo = RepoPicker.from_uri(project_repo)
    if "=" in branch_or_commit:
        _, commit = branch_or_commit.split("=", 1)
        return CommitPicker(id=CommitPickerCommitByGlobalId(repo=repo, id=commit))
    elif uuid_re.match(branch_or_commit) or not branch_re.match(branch_or_commit):
        if "." in branch_or_commit:
            branch_name, offset_str = branch_or_commit.split(".")
            return CommitPicker(
                branch_root=CommitPickerBranchRoot(
                    branch=BranchPicker(
                        name=BranchPickerBranchName(name=branch_name, repo=repo)
                    ),
                    offset=parse_offset(offset_str),
                )
            )
        if "^" in branch_or_commit:
            start_uri, offset_str = uri.split("^")
            return CommitPicker(
                ancestor=CommitPickerAncestorOf(
                    offset=parse_offset(offset_str),
                    start=_CommitPicker_from_uri(start_uri),
                )
            )
        return CommitPicker(id=CommitPickerCommitByGlobalId(repo=repo, id=branch_or_commit))
    else:
        return CommitPicker(
            branch_head=BranchPicker(
                name=BranchPickerBranchName(name=branch_or_commit, repo=repo)
            ),
        )

def as_uri(self: CommitPicker) ‑> str

Returns the URI for the CommitPicker object. If no project is specified it defaults to "default"

Expand source code

def _CommitPicker_as_uri(self: CommitPicker) -> str:
    """Returns the URI for the CommitPicker object.
    If no project is specified it defaults to "default"
    """
    if self.branch_head:
        return self.branch_head.as_uri()
    if self.id:
        return f"{self.id.repo}@{self.id.id}"
    if self.ancestor:
        return f"{self.ancestor.start}^{self.ancestor.offset}"
    if self.branch_root:
        return f"{self.branch_root.branch}.{self.branch_root.offset}"
    raise ValueError(f"invalid CommitPicker: {repr(self)}")

class CommitPickerCommitByGlobalId (repo: RepoPicker = None, id: str = None)

CommitPickerCommitByGlobalId(repo: 'RepoPicker' = None, id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class CommitPickerCommitByGlobalId(betterproto.Message):
    repo: "RepoPicker" = betterproto.message_field(1)
    id: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : RepoPicker
var id : str

class CommitPickerBranchRoot (offset: int = None, branch: BranchPicker = None)

This models .N syntax.

Expand source code

@dataclass(eq=False, repr=False)
class CommitPickerBranchRoot(betterproto.Message):
    """This models .N syntax."""

    offset: int = betterproto.uint32_field(1)
    branch: "BranchPicker" = betterproto.message_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var offset : int
var branch : BranchPicker

class CommitPickerAncestorOf (offset: int = None, start: CommitPicker = None)

This models ^ syntax recursively.

Expand source code

@dataclass(eq=False, repr=False)
class CommitPickerAncestorOf(betterproto.Message):
    """This models ^ syntax recursively."""

    offset: int = betterproto.uint32_field(1)
    start: "CommitPicker" = betterproto.message_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var offset : int
var start : CommitPicker

class CommitInfo (commit: Commit = None, origin: CommitOrigin = None, description: str = None, parent_commit: Commit = None, child_commits: List[ForwardRef('Commit')] = None, started: datetime.datetime = None, finishing: datetime.datetime = None, finished: datetime.datetime = None, direct_provenance: List[ForwardRef('Commit')] = None, direct_subvenance: List[ForwardRef('Commit')] = None, error: str = None, size_bytes_upper_bound: int = None, details: CommitInfoDetails = None, metadata: Dict[str, str] = None, created_by: str = None, created_at: datetime.datetime = None, updated_at: datetime.datetime = None)

CommitInfo is the main data structure representing a commit in postgres

Expand source code

@dataclass(eq=False, repr=False)
class CommitInfo(betterproto.Message):
    """
    CommitInfo is the main data structure representing a commit in postgres
    """

    commit: "Commit" = betterproto.message_field(1)
    origin: "CommitOrigin" = betterproto.message_field(2)
    description: str = betterproto.string_field(3)
    """description is a user-provided script describing this commit"""

    parent_commit: "Commit" = betterproto.message_field(4)
    child_commits: List["Commit"] = betterproto.message_field(5)
    started: datetime = betterproto.message_field(6)
    finishing: datetime = betterproto.message_field(7)
    finished: datetime = betterproto.message_field(8)
    direct_provenance: List["Commit"] = betterproto.message_field(13)
    direct_subvenance: List["Commit"] = betterproto.message_field(15)
    error: str = betterproto.string_field(10)
    size_bytes_upper_bound: int = betterproto.int64_field(11)
    details: "CommitInfoDetails" = betterproto.message_field(12)
    metadata: Dict[str, str] = betterproto.map_field(
        14, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    """Metadata is user-applied annotations."""

    created_by: str = betterproto.string_field(16)
    """
    The user that created this commit or caused this commit to be created.
    """

    created_at: datetime = betterproto.message_field(17)
    """The time the commit was added to the database."""

    updated_at: datetime = betterproto.message_field(18)
    """The time this commit was most recently updated."""

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var origin : CommitOrigin
var description : str: description is a user-provided script describing this commit
var parent_commit : Commit
var child_commits : List[Commit]
var started : datetime.datetime
var finishing : datetime.datetime
var finished : datetime.datetime
var direct_provenance : List[Commit]
var direct_subvenance : List[Commit]
var error : str
var size_bytes_upper_bound : int
var details : CommitInfoDetails
var metadata : Dict[str, str]: Metadata is user-applied annotations.
var created_by : str: The user that created this commit or caused this commit to be created.
var created_at : datetime.datetime: The time the commit was added to the database.
var updated_at : datetime.datetime: The time this commit was most recently updated.

class CommitInfoDetails (size_bytes: int = None, compacting_time: datetime.timedelta = None, validating_time: datetime.timedelta = None)

Details are only provided when explicitly requested

Expand source code

@dataclass(eq=False, repr=False)
class CommitInfoDetails(betterproto.Message):
    """Details are only provided when explicitly requested"""

    size_bytes: int = betterproto.int64_field(1)
    compacting_time: timedelta = betterproto.message_field(2)
    validating_time: timedelta = betterproto.message_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var size_bytes : int
var compacting_time : datetime.timedelta
var validating_time : datetime.timedelta

class CommitSet (id: str = None)

CommitSet(id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class CommitSet(betterproto.Message):
    id: str = betterproto.string_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var id : str

class CommitSetInfo (commit_set: CommitSet = None, commits: List[ForwardRef('CommitInfo')] = None)

CommitSetInfo(commit_set: 'CommitSet' = None, commits: List[ForwardRef('CommitInfo')] = None)

Expand source code

@dataclass(eq=False, repr=False)
class CommitSetInfo(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)
    commits: List["CommitInfo"] = betterproto.message_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit_set : CommitSet
var commits : List[CommitInfo]

class FileInfo (file: File = None, file_type: FileType = None, committed: datetime.datetime = None, size_bytes: int = None, hash: bytes = None)

FileInfo(file: 'File' = None, file_type: 'FileType' = None, committed: datetime.datetime = None, size_bytes: int = None, hash: bytes = None)

Expand source code

@dataclass(eq=False, repr=False)
class FileInfo(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    file_type: "FileType" = betterproto.enum_field(2)
    committed: datetime = betterproto.message_field(3)
    size_bytes: int = betterproto.int64_field(4)
    hash: bytes = betterproto.bytes_field(5)

Ancestors

betterproto.Message
abc.ABC

Class variables

var file : File
var file_type : FileType
var committed : datetime.datetime
var size_bytes : int
var hash : bytes

class Project (name: str = None)

Project(name: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class Project(betterproto.Message):
    name: str = betterproto.string_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var name : str

Methods

def as_picker(self: Project) ‑> ProjectPicker

Converts a Project to a ProjectPicker.

Expand source code

def _Project_as_picker(self: "Project") -> ProjectPicker:
    """Converts a Project to a ProjectPicker."""
    return ProjectPicker(name=self.name)

class ProjectInfo (project: Project = None, description: str = None, auth_info: AuthInfo = None, created_at: datetime.datetime = None, metadata: Dict[str, str] = None, created_by: str = None)

ProjectInfo(project: 'Project' = None, description: str = None, auth_info: 'AuthInfo' = None, created_at: datetime.datetime = None, metadata: Dict[str, str] = None, created_by: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class ProjectInfo(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    auth_info: "AuthInfo" = betterproto.message_field(3)
    created_at: datetime = betterproto.message_field(4)
    metadata: Dict[str, str] = betterproto.map_field(
        5, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    created_by: str = betterproto.string_field(6)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : Project
var description : str
var auth_info : AuthInfo
var created_at : datetime.datetime
var metadata : Dict[str, str]
var created_by : str

class ProjectPicker (name: str = None)

ProjectPicker defines mutually exclusive pickers that resolve to a single project. Currently, the only way to pick a project is by using a project name. Picker messages should only be used as request parameters.

Expand source code

@dataclass(eq=False, repr=False)
class ProjectPicker(betterproto.Message):
    """
    ProjectPicker defines mutually exclusive pickers that resolve to a single
    project. Currently, the only way to pick a project is by using a project
    name. Picker messages should only be used as request parameters.
    """

    name: str = betterproto.string_field(1, group="picker")

Ancestors

betterproto.Message
abc.ABC

Class variables

var name : str

class CreateRepoRequest (repo: Repo = None, description: str = None, update: bool = None)

CreateRepoRequest(repo: 'Repo' = None, description: str = None, update: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateRepoRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    update: bool = betterproto.bool_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo
var description : str
var update : bool

class InspectRepoRequest (repo: Repo = None)

InspectRepoRequest(repo: 'Repo' = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectRepoRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo

class ListRepoRequest (type: str = None, projects: List[ForwardRef('Project')] = None, page: RepoPage = None)

ListRepoRequest(type: str = None, projects: List[ForwardRef('Project')] = None, page: 'RepoPage' = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListRepoRequest(betterproto.Message):
    type: str = betterproto.string_field(1)
    """
    Type is the type of (system) repo that should be returned. An empty string
    requests all repos.
    """

    projects: List["Project"] = betterproto.message_field(2)
    """
    Filters out repos whos project isn't represented. An empty list of projects
    doesn't filter repos by their project.
    """

    page: "RepoPage" = betterproto.message_field(3)
    """
    Specifies which page of repos should be returned. If page isn't specified,
    a single page containing all the relevant repos is returned.
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var type : str: Type is the type of (system) repo that should be returned. An empty string requests all repos.
var projects : List[Project]: Filters out repos whos project isn't represented. An empty list of projects doesn't filter repos by their project.
var page : RepoPage: Specifies which page of repos should be returned. If page isn't specified, a single page containing all the relevant repos is returned.

class RepoPage (order: RepoPageOrdering = None, page_size: int = None, page_index: int = None)

RepoPage(order: 'RepoPageOrdering' = None, page_size: int = None, page_index: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class RepoPage(betterproto.Message):
    order: "RepoPageOrdering" = betterproto.enum_field(1)
    page_size: int = betterproto.int64_field(2)
    page_index: int = betterproto.int64_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var order : RepoPageOrdering
var page_size : int
var page_index : int

class DeleteRepoRequest (repo: Repo = None, force: bool = None)

DeleteRepoRequest(repo: 'Repo' = None, force: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteRepoRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    force: bool = betterproto.bool_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo
var force : bool

class DeleteReposRequest (projects: List[ForwardRef('Project')] = None, force: bool = None, all: bool = None)

DeleteReposRequest is used to delete more than one repo at once.

Expand source code

@dataclass(eq=False, repr=False)
class DeleteReposRequest(betterproto.Message):
    """DeleteReposRequest is used to delete more than one repo at once."""

    projects: List["Project"] = betterproto.message_field(1)
    """
    All repos in each project will be deleted if the caller has permission.
    """

    force: bool = betterproto.bool_field(2)
    all: bool = betterproto.bool_field(3)
    """
    If all is set, then all repos in all projects will be deleted if the caller
    has permission.
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var projects : List[Project]: All repos in each project will be deleted if the caller has permission.
var force : bool
var all : bool: If all is set, then all repos in all projects will be deleted if the caller has permission.

class DeleteRepoResponse (deleted: bool = None)

DeleteRepoResponse returns the repos that were deleted by a DeleteRepo call.

Expand source code

@dataclass(eq=False, repr=False)
class DeleteRepoResponse(betterproto.Message):
    """
    DeleteRepoResponse returns the repos that were deleted by a DeleteRepo
    call.
    """

    deleted: bool = betterproto.bool_field(1)
    """The repos that were deleted, perhaps none."""

Ancestors

betterproto.Message
abc.ABC

Class variables

var deleted : bool: The repos that were deleted, perhaps none.

class DeleteReposResponse (repos: List[ForwardRef('Repo')] = None)

DeleteReposResponse(repos: List[ForwardRef('Repo')] = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteReposResponse(betterproto.Message):
    repos: List["Repo"] = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repos : List[Repo]

class StartCommitRequest (parent: Commit = None, description: str = None, branch: Branch = None)

StartCommitRequest(parent: 'Commit' = None, description: str = None, branch: 'Branch' = None)

Expand source code

@dataclass(eq=False, repr=False)
class StartCommitRequest(betterproto.Message):
    parent: "Commit" = betterproto.message_field(1)
    """
    parent may be empty in which case the commit that Branch points to will be
    used as the parent. If the branch does not exist, the commit will have no
    parent.
    """

    description: str = betterproto.string_field(2)
    """description is a user-provided string describing this commit"""

    branch: "Branch" = betterproto.message_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var parent : Commit: parent may be empty in which case the commit that Branch points to will be used as the parent. If the branch does not exist, the commit will have no parent.
var description : str: description is a user-provided string describing this commit
var branch : Branch

class FinishCommitRequest (commit: Commit = None, description: str = None, error: str = None, force: bool = None)

FinishCommitRequest(commit: 'Commit' = None, description: str = None, error: str = None, force: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class FinishCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    """
    description is a user-provided string describing this commit. Setting this
    will overwrite the description set in StartCommit
    """

    error: str = betterproto.string_field(3)
    force: bool = betterproto.bool_field(4)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var description : str: description is a user-provided string describing this commit. Setting this will overwrite the description set in StartCommit
var error : str
var force : bool

class InspectCommitRequest (commit: Commit = None, wait: CommitState = None)

InspectCommitRequest(commit: 'Commit' = None, wait: 'CommitState' = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    wait: "CommitState" = betterproto.enum_field(2)
    """
    Wait causes inspect commit to wait until the commit is in the desired
    state.
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var wait : CommitState: Wait causes inspect commit to wait until the commit is in the desired state.

class ListCommitRequest (repo: Repo = None, from_: Commit = None, to: Commit = None, number: int = None, reverse: bool = None, all: bool = None, origin_kind: OriginKind = None, started_time: datetime.datetime = None)

ListCommitRequest(repo: 'Repo' = None, from_: 'Commit' = None, to: 'Commit' = None, number: int = None, reverse: bool = None, all: bool = None, origin_kind: 'OriginKind' = None, started_time: datetime.datetime = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListCommitRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    from_: "Commit" = betterproto.message_field(2)
    to: "Commit" = betterproto.message_field(3)
    number: int = betterproto.int64_field(4)
    reverse: bool = betterproto.bool_field(5)
    all: bool = betterproto.bool_field(6)
    origin_kind: "OriginKind" = betterproto.enum_field(7)
    started_time: datetime = betterproto.message_field(8)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo
var from_ : Commit
var to : Commit
var number : int
var reverse : bool
var all : bool
var origin_kind : OriginKind
var started_time : datetime.datetime

class InspectCommitSetRequest (commit_set: CommitSet = None, wait: bool = None)

InspectCommitSetRequest(commit_set: 'CommitSet' = None, wait: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectCommitSetRequest(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)
    wait: bool = betterproto.bool_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit_set : CommitSet
var wait : bool

class ListCommitSetRequest (project: Project = None)

ListCommitSetRequest(project: 'Project' = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListCommitSetRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : Project

class SquashCommitSetRequest (commit_set: CommitSet = None)

SquashCommitSetRequest(commit_set: 'CommitSet' = None)

Expand source code

@dataclass(eq=False, repr=False)
class SquashCommitSetRequest(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit_set : CommitSet

class DropCommitSetRequest (commit_set: CommitSet = None)

DropCommitSetRequest(commit_set: 'CommitSet' = None)

Expand source code

@dataclass(eq=False, repr=False)
class DropCommitSetRequest(betterproto.Message):
    commit_set: "CommitSet" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit_set : CommitSet

class SubscribeCommitRequest (repo: Repo = None, branch: str = None, from_: Commit = None, state: CommitState = None, all: bool = None, origin_kind: OriginKind = None)

SubscribeCommitRequest(repo: 'Repo' = None, branch: str = None, from_: 'Commit' = None, state: 'CommitState' = None, all: bool = None, origin_kind: 'OriginKind' = None)

Expand source code

@dataclass(eq=False, repr=False)
class SubscribeCommitRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    branch: str = betterproto.string_field(2)
    from_: "Commit" = betterproto.message_field(3)
    """only commits created since this commit are returned"""

    state: "CommitState" = betterproto.enum_field(4)
    """Don't return commits until they're in (at least) the desired state."""

    all: bool = betterproto.bool_field(5)
    origin_kind: "OriginKind" = betterproto.enum_field(6)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo
var branch : str
var from_ : Commit: only commits created since this commit are returned
var state : CommitState: Don't return commits until they're in (at least) the desired state.
var all : bool
var origin_kind : OriginKind

class ClearCommitRequest (commit: Commit = None)

ClearCommitRequest(commit: 'Commit' = None)

Expand source code

@dataclass(eq=False, repr=False)
class ClearCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit

class SquashCommitRequest (commit: Commit = None, recursive: bool = None)

SquashCommitRequest(commit: 'Commit' = None, recursive: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class SquashCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    recursive: bool = betterproto.bool_field(2)
    """
    Setting recursive to true indicates that the squash should be applied
    recursively to subvenant commits. If recursive is set to false and the
    provided commit has subvenant commits, the squash will fail.
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var recursive : bool: Setting recursive to true indicates that the squash should be applied recursively to subvenant commits. If recursive is set to false and the provided commit has subvenant commits, the squash will fail.

class SquashCommitResponse

SquashCommitResponse()

Expand source code

@dataclass(eq=False, repr=False)
class SquashCommitResponse(betterproto.Message):
    pass

Ancestors

betterproto.Message
abc.ABC

class DropCommitRequest (commit: Commit = None, recursive: bool = None)

DropCommitRequest(commit: 'Commit' = None, recursive: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class DropCommitRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    recursive: bool = betterproto.bool_field(2)
    """
    Setting recursive to true indicates that the drop should be applied
    recursively to subvenant commits. If recursive is set to false and the
    provided commit has subvenant commits, the drop will fail.
    """

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var recursive : bool: Setting recursive to true indicates that the drop should be applied recursively to subvenant commits. If recursive is set to false and the provided commit has subvenant commits, the drop will fail.

class WalkCommitProvenanceRequest (start: List[ForwardRef('CommitPicker')] = None, max_commits: int = None, max_depth: int = None)

WalkCommitProvenanceRequest(start: List[ForwardRef('CommitPicker')] = None, max_commits: int = None, max_depth: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class WalkCommitProvenanceRequest(betterproto.Message):
    start: List["CommitPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_commits: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var start : List[CommitPicker]: if more than one picker is specified, the result stream is the concatenation of the streams of each picker.
var max_commits : int
var max_depth : int

class WalkCommitSubvenanceRequest (start: List[ForwardRef('CommitPicker')] = None, max_commits: int = None, max_depth: int = None)

WalkCommitSubvenanceRequest(start: List[ForwardRef('CommitPicker')] = None, max_commits: int = None, max_depth: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class WalkCommitSubvenanceRequest(betterproto.Message):
    start: List["CommitPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_commits: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var start : List[CommitPicker]: if more than one picker is specified, the result stream is the concatenation of the streams of each picker.
var max_commits : int
var max_depth : int

class WalkBranchProvenanceRequest (start: List[ForwardRef('BranchPicker')] = None, max_branches: int = None, max_depth: int = None)

WalkBranchProvenanceRequest(start: List[ForwardRef('BranchPicker')] = None, max_branches: int = None, max_depth: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class WalkBranchProvenanceRequest(betterproto.Message):
    start: List["BranchPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_branches: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var start : List[BranchPicker]: if more than one picker is specified, the result stream is the concatenation of the streams of each picker.
var max_branches : int
var max_depth : int

class WalkBranchSubvenanceRequest (start: List[ForwardRef('BranchPicker')] = None, max_branches: int = None, max_depth: int = None)

WalkBranchSubvenanceRequest(start: List[ForwardRef('BranchPicker')] = None, max_branches: int = None, max_depth: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class WalkBranchSubvenanceRequest(betterproto.Message):
    start: List["BranchPicker"] = betterproto.message_field(1)
    """
    if more than one picker is specified, the result stream is the
    concatenation of the streams of each picker.
    """

    max_branches: int = betterproto.uint64_field(2)
    max_depth: int = betterproto.uint64_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var start : List[BranchPicker]: if more than one picker is specified, the result stream is the concatenation of the streams of each picker.
var max_branches : int
var max_depth : int

class DropCommitResponse

DropCommitResponse()

Expand source code

@dataclass(eq=False, repr=False)
class DropCommitResponse(betterproto.Message):
    pass

Ancestors

betterproto.Message
abc.ABC

class CreateBranchRequest (head: Commit = None, branch: Branch = None, provenance: List[ForwardRef('Branch')] = None, trigger: Trigger = None, new_commit_set: bool = None)

CreateBranchRequest(head: 'Commit' = None, branch: 'Branch' = None, provenance: List[ForwardRef('Branch')] = None, trigger: 'Trigger' = None, new_commit_set: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateBranchRequest(betterproto.Message):
    head: "Commit" = betterproto.message_field(1)
    branch: "Branch" = betterproto.message_field(2)
    provenance: List["Branch"] = betterproto.message_field(3)
    trigger: "Trigger" = betterproto.message_field(4)
    new_commit_set: bool = betterproto.bool_field(5)

Ancestors

betterproto.Message
abc.ABC

Class variables

var head : Commit
var branch : Branch
var provenance : List[Branch]
var trigger : Trigger
var new_commit_set : bool

class FindCommitsRequest (start: Commit = None, file_path: str = None, limit: int = None)

FindCommitsRequest(start: 'Commit' = None, file_path: str = None, limit: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class FindCommitsRequest(betterproto.Message):
    start: "Commit" = betterproto.message_field(1)
    file_path: str = betterproto.string_field(2)
    limit: int = betterproto.uint32_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var start : Commit
var file_path : str
var limit : int

class FindCommitsResponse (found_commit: Commit = None, last_searched_commit: Commit = None, commits_searched: int = None)

FindCommitsResponse(found_commit: 'Commit' = None, last_searched_commit: 'Commit' = None, commits_searched: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class FindCommitsResponse(betterproto.Message):
    found_commit: "Commit" = betterproto.message_field(1, group="result")
    last_searched_commit: "Commit" = betterproto.message_field(2, group="result")
    commits_searched: int = betterproto.uint32_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var found_commit : Commit
var last_searched_commit : Commit
var commits_searched : int

class InspectBranchRequest (branch: Branch = None)

InspectBranchRequest(branch: 'Branch' = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectBranchRequest(betterproto.Message):
    branch: "Branch" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var branch : Branch

class ListBranchRequest (repo: Repo = None, reverse: bool = None)

ListBranchRequest(repo: 'Repo' = None, reverse: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListBranchRequest(betterproto.Message):
    repo: "Repo" = betterproto.message_field(1)
    reverse: bool = betterproto.bool_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var repo : Repo
var reverse : bool

class DeleteBranchRequest (branch: Branch = None, force: bool = None)

DeleteBranchRequest(branch: 'Branch' = None, force: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteBranchRequest(betterproto.Message):
    branch: "Branch" = betterproto.message_field(1)
    force: bool = betterproto.bool_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var branch : Branch
var force : bool

class CreateProjectRequest (project: Project = None, description: str = None, update: bool = None)

CreateProjectRequest(project: 'Project' = None, description: str = None, update: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateProjectRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    description: str = betterproto.string_field(2)
    update: bool = betterproto.bool_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : Project
var description : str
var update : bool

class InspectProjectRequest (project: Project = None)

InspectProjectRequest(project: 'Project' = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectProjectRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : Project

class InspectProjectV2Request (project: Project = None)

InspectProjectV2Request(project: 'Project' = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectProjectV2Request(betterproto.Message):
    project: "Project" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : Project

class InspectProjectV2Response (info: ProjectInfo = None, defaults_json: str = None)

InspectProjectV2Response(info: 'ProjectInfo' = None, defaults_json: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectProjectV2Response(betterproto.Message):
    info: "ProjectInfo" = betterproto.message_field(1)
    defaults_json: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var info : ProjectInfo
var defaults_json : str

class ListProjectRequest

ListProjectRequest()

Expand source code

@dataclass(eq=False, repr=False)
class ListProjectRequest(betterproto.Message):
    pass

Ancestors

betterproto.Message
abc.ABC

class DeleteProjectRequest (project: Project = None, force: bool = None)

DeleteProjectRequest(project: 'Project' = None, force: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteProjectRequest(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    force: bool = betterproto.bool_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : Project
var force : bool

class AddFile (path: str = None, datum: str = None, raw: Optional[bytes] = None, url: AddFileUrlSource = None)

AddFile(path: str = None, datum: str = None, raw: Optional[bytes] = None, url: 'AddFileUrlSource' = None)

Expand source code

@dataclass(eq=False, repr=False)
class AddFile(betterproto.Message):
    path: str = betterproto.string_field(1)
    datum: str = betterproto.string_field(2)
    raw: Optional[bytes] = betterproto.message_field(
        3, wraps=betterproto.TYPE_BYTES, group="source"
    )
    url: "AddFileUrlSource" = betterproto.message_field(4, group="source")

Ancestors

betterproto.Message
abc.ABC

Class variables

var path : str
var datum : str
var raw : Optional[bytes]
var url : AddFileUrlSource

class AddFileUrlSource (url: str = None, recursive: bool = None, concurrency: int = None)

AddFileUrlSource(url: str = None, recursive: bool = None, concurrency: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class AddFileUrlSource(betterproto.Message):
    url: str = betterproto.string_field(1)
    recursive: bool = betterproto.bool_field(2)
    concurrency: int = betterproto.uint32_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var url : str
var recursive : bool
var concurrency : int

class DeleteFile (path: str = None, datum: str = None)

DeleteFile(path: str = None, datum: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteFile(betterproto.Message):
    path: str = betterproto.string_field(1)
    datum: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var path : str
var datum : str

class CopyFile (dst: str = None, datum: str = None, src: File = None, append: bool = None)

CopyFile(dst: str = None, datum: str = None, src: 'File' = None, append: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class CopyFile(betterproto.Message):
    dst: str = betterproto.string_field(1)
    datum: str = betterproto.string_field(2)
    src: "File" = betterproto.message_field(3)
    append: bool = betterproto.bool_field(4)

Ancestors

betterproto.Message
abc.ABC

Class variables

var dst : str
var datum : str
var src : File
var append : bool

class ModifyFileRequest (set_commit: Commit = None, add_file: AddFile = None, delete_file: DeleteFile = None, copy_file: CopyFile = None)

ModifyFileRequest(set_commit: 'Commit' = None, add_file: 'AddFile' = None, delete_file: 'DeleteFile' = None, copy_file: 'CopyFile' = None)

Expand source code

@dataclass(eq=False, repr=False)
class ModifyFileRequest(betterproto.Message):
    set_commit: "Commit" = betterproto.message_field(1, group="body")
    add_file: "AddFile" = betterproto.message_field(2, group="body")
    delete_file: "DeleteFile" = betterproto.message_field(3, group="body")
    copy_file: "CopyFile" = betterproto.message_field(4, group="body")

Ancestors

betterproto.Message
abc.ABC

Class variables

var set_commit : Commit
var add_file : AddFile
var delete_file : DeleteFile
var copy_file : CopyFile

class GetFileRequest (file: File = None, url: str = None, offset: int = None, path_range: PathRange = None)

GetFileRequest(file: 'File' = None, url: str = None, offset: int = None, path_range: 'PathRange' = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    url: str = betterproto.string_field(2)
    offset: int = betterproto.int64_field(3)
    path_range: "PathRange" = betterproto.message_field(4)

Ancestors

betterproto.Message
abc.ABC

Class variables

var file : File
var url : str
var offset : int
var path_range : PathRange

class InspectFileRequest (file: File = None)

InspectFileRequest(file: 'File' = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var file : File

class ListFileRequest (file: File = None, pagination_marker: File = None, number: int = None, reverse: bool = None)

ListFileRequest(file: 'File' = None, pagination_marker: 'File' = None, number: int = None, reverse: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    """
    File is the parent directory of the files we want to list. This sets the
    repo, the commit/branch, and path prefix of files we're interested in If
    the "path" field is omitted, a list of files at the top level of the repo
    is returned
    """

    pagination_marker: "File" = betterproto.message_field(3)
    """
    Marker for pagination. If set, the files that come after the marker in
    lexicographical order will be returned. If reverse is also set, the files
    that come before the marker in lexicographical order will be returned.
    """

    number: int = betterproto.int64_field(4)
    """Number of files to return"""

    reverse: bool = betterproto.bool_field(5)
    """If true, return files in reverse order"""

Ancestors

betterproto.Message
abc.ABC

Class variables

var file : File: File is the parent directory of the files we want to list. This sets the repo, the commit/branch, and path prefix of files we're interested in If the "path" field is omitted, a list of files at the top level of the repo is returned
var pagination_marker : File: Marker for pagination. If set, the files that come after the marker in lexicographical order will be returned. If reverse is also set, the files that come before the marker in lexicographical order will be returned.
var number : int: Number of files to return
var reverse : bool: If true, return files in reverse order

class WalkFileRequest (file: File = None, pagination_marker: File = None, number: int = None, reverse: bool = None)

WalkFileRequest(file: 'File' = None, pagination_marker: 'File' = None, number: int = None, reverse: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class WalkFileRequest(betterproto.Message):
    file: "File" = betterproto.message_field(1)
    pagination_marker: "File" = betterproto.message_field(2)
    """
    Marker for pagination. If set, the files that come after the marker in
    lexicographical order will be returned. If reverse is also set, the files
    that come before the marker in lexicographical order will be returned.
    """

    number: int = betterproto.int64_field(3)
    """Number of files to return"""

    reverse: bool = betterproto.bool_field(4)
    """If true, return files in reverse order"""

Ancestors

betterproto.Message
abc.ABC

Class variables

var file : File
var pagination_marker : File: Marker for pagination. If set, the files that come after the marker in lexicographical order will be returned. If reverse is also set, the files that come before the marker in lexicographical order will be returned.
var number : int: Number of files to return
var reverse : bool: If true, return files in reverse order

class GlobFileRequest (commit: Commit = None, pattern: str = None, path_range: PathRange = None)

GlobFileRequest(commit: 'Commit' = None, pattern: str = None, path_range: 'PathRange' = None)

Expand source code

@dataclass(eq=False, repr=False)
class GlobFileRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    pattern: str = betterproto.string_field(2)
    path_range: "PathRange" = betterproto.message_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var pattern : str
var path_range : PathRange

class DiffFileRequest (new_file: File = None, old_file: File = None, shallow: bool = None)

DiffFileRequest(new_file: 'File' = None, old_file: 'File' = None, shallow: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class DiffFileRequest(betterproto.Message):
    new_file: "File" = betterproto.message_field(1)
    old_file: "File" = betterproto.message_field(2)
    """
    OldFile may be left nil in which case the same path in the parent of
    NewFile's commit will be used.
    """

    shallow: bool = betterproto.bool_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var new_file : File
var old_file : File: OldFile may be left nil in which case the same path in the parent of NewFile's commit will be used.
var shallow : bool

class DiffFileResponse (new_file: FileInfo = None, old_file: FileInfo = None)

DiffFileResponse(new_file: 'FileInfo' = None, old_file: 'FileInfo' = None)

Expand source code

@dataclass(eq=False, repr=False)
class DiffFileResponse(betterproto.Message):
    new_file: "FileInfo" = betterproto.message_field(1)
    old_file: "FileInfo" = betterproto.message_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var new_file : FileInfo
var old_file : FileInfo

class FsckRequest (fix: bool = None, zombie_target: Commit = None, zombie_all: bool = None)

FsckRequest(fix: bool = None, zombie_target: 'Commit' = None, zombie_all: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class FsckRequest(betterproto.Message):
    fix: bool = betterproto.bool_field(1)
    zombie_target: "Commit" = betterproto.message_field(2, group="zombie_check")
    zombie_all: bool = betterproto.bool_field(3, group="zombie_check")
    """run zombie data detection against all pipelines"""

Ancestors

betterproto.Message
abc.ABC

Class variables

var fix : bool
var zombie_target : Commit
var zombie_all : bool: run zombie data detection against all pipelines

class FsckResponse (fix: str = None, error: str = None)

FsckResponse(fix: str = None, error: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class FsckResponse(betterproto.Message):
    fix: str = betterproto.string_field(1)
    error: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var fix : str
var error : str

class CreateFileSetResponse (file_set_id: str = None)

CreateFileSetResponse(file_set_id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateFileSetResponse(betterproto.Message):
    file_set_id: str = betterproto.string_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var file_set_id : str

class GetFileSetRequest (commit: Commit = None, type: GetFileSetRequestFileSetType = None)

GetFileSetRequest(commit: 'Commit' = None, type: 'GetFileSetRequestFileSetType' = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetFileSetRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    type: "GetFileSetRequestFileSetType" = betterproto.enum_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var type : GetFileSetRequestFileSetType

class AddFileSetRequest (commit: Commit = None, file_set_id: str = None)

AddFileSetRequest(commit: 'Commit' = None, file_set_id: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class AddFileSetRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    file_set_id: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var file_set_id : str

class RenewFileSetRequest (file_set_id: str = None, ttl_seconds: int = None)

RenewFileSetRequest(file_set_id: str = None, ttl_seconds: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class RenewFileSetRequest(betterproto.Message):
    file_set_id: str = betterproto.string_field(1)
    ttl_seconds: int = betterproto.int64_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var file_set_id : str
var ttl_seconds : int

class ComposeFileSetRequest (file_set_ids: List[str] = None, ttl_seconds: int = None, compact: bool = None)

ComposeFileSetRequest(file_set_ids: List[str] = None, ttl_seconds: int = None, compact: bool = None)

Expand source code

@dataclass(eq=False, repr=False)
class ComposeFileSetRequest(betterproto.Message):
    file_set_ids: List[str] = betterproto.string_field(1)
    ttl_seconds: int = betterproto.int64_field(2)
    compact: bool = betterproto.bool_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var file_set_ids : List[str]
var ttl_seconds : int
var compact : bool

class ShardFileSetRequest (file_set_id: str = None, num_files: int = None, size_bytes: int = None)

If both num_files and size_bytes are set, shards are created based on whichever threshold is surpassed first. If a shard configuration field (num_files, size_bytes) is unset, the storage's default value is used.

Expand source code

@dataclass(eq=False, repr=False)
class ShardFileSetRequest(betterproto.Message):
    """
    If both num_files and size_bytes are set, shards are created based on
    whichever threshold is surpassed first. If a shard configuration field
    (num_files, size_bytes) is unset, the storage's default value is used.
    """

    file_set_id: str = betterproto.string_field(1)
    num_files: int = betterproto.int64_field(2)
    size_bytes: int = betterproto.int64_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var file_set_id : str
var num_files : int
var size_bytes : int

class PathRange (lower: str = None, upper: str = None)

PathRange(lower: str = None, upper: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class PathRange(betterproto.Message):
    lower: str = betterproto.string_field(1)
    upper: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var lower : str
var upper : str

class ShardFileSetResponse (shards: List[ForwardRef('PathRange')] = None)

ShardFileSetResponse(shards: List[ForwardRef('PathRange')] = None)

Expand source code

@dataclass(eq=False, repr=False)
class ShardFileSetResponse(betterproto.Message):
    shards: List["PathRange"] = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var shards : List[PathRange]

class CheckStorageRequest (read_chunk_data: bool = None, chunk_begin: bytes = None, chunk_end: bytes = None)

CheckStorageRequest(read_chunk_data: bool = None, chunk_begin: bytes = None, chunk_end: bytes = None)

Expand source code

@dataclass(eq=False, repr=False)
class CheckStorageRequest(betterproto.Message):
    read_chunk_data: bool = betterproto.bool_field(1)
    chunk_begin: bytes = betterproto.bytes_field(2)
    chunk_end: bytes = betterproto.bytes_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var read_chunk_data : bool
var chunk_begin : bytes
var chunk_end : bytes

class CheckStorageResponse (chunk_object_count: int = None)

CheckStorageResponse(chunk_object_count: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class CheckStorageResponse(betterproto.Message):
    chunk_object_count: int = betterproto.int64_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var chunk_object_count : int

class PutCacheRequest (key: str = None, value: betterproto_lib_google_protobuf.Any = None, file_set_ids: List[str] = None, tag: str = None)

PutCacheRequest(key: str = None, value: 'betterproto_lib_google_protobuf.Any' = None, file_set_ids: List[str] = None, tag: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class PutCacheRequest(betterproto.Message):
    key: str = betterproto.string_field(1)
    value: "betterproto_lib_google_protobuf.Any" = betterproto.message_field(2)
    file_set_ids: List[str] = betterproto.string_field(3)
    tag: str = betterproto.string_field(4)

Ancestors

betterproto.Message
abc.ABC

Class variables

var key : str
var value : betterproto.lib.google.protobuf.Any
var file_set_ids : List[str]
var tag : str

class GetCacheRequest (key: str = None)

GetCacheRequest(key: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetCacheRequest(betterproto.Message):
    key: str = betterproto.string_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var key : str

class GetCacheResponse (value: betterproto_lib_google_protobuf.Any = None)

GetCacheResponse(value: 'betterproto_lib_google_protobuf.Any' = None)

Expand source code

@dataclass(eq=False, repr=False)
class GetCacheResponse(betterproto.Message):
    value: "betterproto_lib_google_protobuf.Any" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var value : betterproto.lib.google.protobuf.Any

class ClearCacheRequest (tag_prefix: str = None)

ClearCacheRequest(tag_prefix: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class ClearCacheRequest(betterproto.Message):
    tag_prefix: str = betterproto.string_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var tag_prefix : str

class ActivateAuthRequest

ActivateAuthRequest()

Expand source code

@dataclass(eq=False, repr=False)
class ActivateAuthRequest(betterproto.Message):
    pass

Ancestors

betterproto.Message
abc.ABC

class ActivateAuthResponse

ActivateAuthResponse()

Expand source code

@dataclass(eq=False, repr=False)
class ActivateAuthResponse(betterproto.Message):
    pass

Ancestors

betterproto.Message
abc.ABC

class ObjectStorageEgress (url: str = None)

ObjectStorageEgress(url: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class ObjectStorageEgress(betterproto.Message):
    url: str = betterproto.string_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var url : str

class SqlDatabaseEgress (url: str = None, file_format: SqlDatabaseEgressFileFormat = None, secret: SqlDatabaseEgressSecret = None)

SqlDatabaseEgress(url: str = None, file_format: 'SqlDatabaseEgressFileFormat' = None, secret: 'SqlDatabaseEgressSecret' = None)

Expand source code

@dataclass(eq=False, repr=False)
class SqlDatabaseEgress(betterproto.Message):
    url: str = betterproto.string_field(1)
    file_format: "SqlDatabaseEgressFileFormat" = betterproto.message_field(2)
    secret: "SqlDatabaseEgressSecret" = betterproto.message_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var url : str
var file_format : SqlDatabaseEgressFileFormat
var secret : SqlDatabaseEgressSecret

class SqlDatabaseEgressFileFormat (type: SqlDatabaseEgressFileFormatType = None, columns: List[str] = None)

SqlDatabaseEgressFileFormat(type: 'SqlDatabaseEgressFileFormatType' = None, columns: List[str] = None)

Expand source code

@dataclass(eq=False, repr=False)
class SqlDatabaseEgressFileFormat(betterproto.Message):
    type: "SqlDatabaseEgressFileFormatType" = betterproto.enum_field(1)
    columns: List[str] = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var type : SqlDatabaseEgressFileFormatType
var columns : List[str]

class SqlDatabaseEgressSecret (name: str = None, key: str = None)

SqlDatabaseEgressSecret(name: str = None, key: str = None)

Expand source code

@dataclass(eq=False, repr=False)
class SqlDatabaseEgressSecret(betterproto.Message):
    name: str = betterproto.string_field(1)
    key: str = betterproto.string_field(2)

Ancestors

betterproto.Message
abc.ABC

Class variables

var name : str
var key : str

class EgressRequest (commit: Commit = None, object_storage: ObjectStorageEgress = None, sql_database: SqlDatabaseEgress = None)

EgressRequest(commit: 'Commit' = None, object_storage: 'ObjectStorageEgress' = None, sql_database: 'SqlDatabaseEgress' = None)

Expand source code

@dataclass(eq=False, repr=False)
class EgressRequest(betterproto.Message):
    commit: "Commit" = betterproto.message_field(1)
    object_storage: "ObjectStorageEgress" = betterproto.message_field(2, group="target")
    sql_database: "SqlDatabaseEgress" = betterproto.message_field(3, group="target")

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : Commit
var object_storage : ObjectStorageEgress
var sql_database : SqlDatabaseEgress

class EgressResponse (object_storage: EgressResponseObjectStorageResult = None, sql_database: EgressResponseSqlDatabaseResult = None)

EgressResponse(object_storage: 'EgressResponseObjectStorageResult' = None, sql_database: 'EgressResponseSqlDatabaseResult' = None)

Expand source code

@dataclass(eq=False, repr=False)
class EgressResponse(betterproto.Message):
    object_storage: "EgressResponseObjectStorageResult" = betterproto.message_field(
        1, group="result"
    )
    sql_database: "EgressResponseSqlDatabaseResult" = betterproto.message_field(
        2, group="result"
    )

Ancestors

betterproto.Message
abc.ABC

Class variables

var object_storage : EgressResponseObjectStorageResult
var sql_database : EgressResponseSqlDatabaseResult

class EgressResponseObjectStorageResult (bytes_written: int = None)

EgressResponseObjectStorageResult(bytes_written: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class EgressResponseObjectStorageResult(betterproto.Message):
    bytes_written: int = betterproto.int64_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var bytes_written : int

class EgressResponseSqlDatabaseResult (rows_written: Dict[str, int] = None)

EgressResponseSqlDatabaseResult(rows_written: Dict[str, int] = None)

Expand source code

@dataclass(eq=False, repr=False)
class EgressResponseSqlDatabaseResult(betterproto.Message):
    rows_written: Dict[str, int] = betterproto.map_field(
        1, betterproto.TYPE_STRING, betterproto.TYPE_INT64
    )

Ancestors

betterproto.Message
abc.ABC

Class variables

var rows_written : Dict[str, int]

class ReposSummaryRequest (projects: List[ForwardRef('ProjectPicker')] = None)

ReposSummaryRequest(projects: List[ForwardRef('ProjectPicker')] = None)

Expand source code

@dataclass(eq=False, repr=False)
class ReposSummaryRequest(betterproto.Message):
    projects: List["ProjectPicker"] = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var projects : List[ProjectPicker]

class ReposSummary (project: Project = None, user_repo_count: int = None, size_bytes: int = None)

ReposSummary(project: 'Project' = None, user_repo_count: int = None, size_bytes: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class ReposSummary(betterproto.Message):
    project: "Project" = betterproto.message_field(1)
    user_repo_count: int = betterproto.int64_field(2)
    size_bytes: int = betterproto.int64_field(3)

Ancestors

betterproto.Message
abc.ABC

Class variables

var project : Project
var user_repo_count : int
var size_bytes : int

class ReposSummaryResponse (summaries: List[ForwardRef('ReposSummary')] = None)

ReposSummaryResponse(summaries: List[ForwardRef('ReposSummary')] = None)

Expand source code

@dataclass(eq=False, repr=False)
class ReposSummaryResponse(betterproto.Message):
    summaries: List["ReposSummary"] = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var summaries : List[ReposSummary]

class ForgetCommitRequest (commit: CommitPicker = None)

ForgetCommitRequest(commit: 'CommitPicker' = None)

Expand source code

@dataclass(eq=False, repr=False)
class ForgetCommitRequest(betterproto.Message):
    commit: "CommitPicker" = betterproto.message_field(1)

Ancestors

betterproto.Message
abc.ABC

Class variables

var commit : CommitPicker

class ForgetCommitResponse

ForgetCommitResponse()

Expand source code

@dataclass(eq=False, repr=False)
class ForgetCommitResponse(betterproto.Message):
    pass

Ancestors

betterproto.Message
abc.ABC

class ApiStub (channel: grpc.Channel)

Expand source code

class ApiStub:

    def __init__(self, channel: "grpc.Channel"):
        self.__rpc_create_repo = channel.unary_unary(
            "/pfs_v2.API/CreateRepo",
            request_serializer=CreateRepoRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_repo = channel.unary_unary(
            "/pfs_v2.API/InspectRepo",
            request_serializer=InspectRepoRequest.SerializeToString,
            response_deserializer=RepoInfo.FromString,
        )
        self.__rpc_list_repo = channel.unary_stream(
            "/pfs_v2.API/ListRepo",
            request_serializer=ListRepoRequest.SerializeToString,
            response_deserializer=RepoInfo.FromString,
        )
        self.__rpc_delete_repo = channel.unary_unary(
            "/pfs_v2.API/DeleteRepo",
            request_serializer=DeleteRepoRequest.SerializeToString,
            response_deserializer=DeleteRepoResponse.FromString,
        )
        self.__rpc_delete_repos = channel.unary_unary(
            "/pfs_v2.API/DeleteRepos",
            request_serializer=DeleteReposRequest.SerializeToString,
            response_deserializer=DeleteReposResponse.FromString,
        )
        self.__rpc_start_commit = channel.unary_unary(
            "/pfs_v2.API/StartCommit",
            request_serializer=StartCommitRequest.SerializeToString,
            response_deserializer=Commit.FromString,
        )
        self.__rpc_finish_commit = channel.unary_unary(
            "/pfs_v2.API/FinishCommit",
            request_serializer=FinishCommitRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_clear_commit = channel.unary_unary(
            "/pfs_v2.API/ClearCommit",
            request_serializer=ClearCommitRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_commit = channel.unary_unary(
            "/pfs_v2.API/InspectCommit",
            request_serializer=InspectCommitRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_list_commit = channel.unary_stream(
            "/pfs_v2.API/ListCommit",
            request_serializer=ListCommitRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_subscribe_commit = channel.unary_stream(
            "/pfs_v2.API/SubscribeCommit",
            request_serializer=SubscribeCommitRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_squash_commit = channel.unary_unary(
            "/pfs_v2.API/SquashCommit",
            request_serializer=SquashCommitRequest.SerializeToString,
            response_deserializer=SquashCommitResponse.FromString,
        )
        self.__rpc_drop_commit = channel.unary_unary(
            "/pfs_v2.API/DropCommit",
            request_serializer=DropCommitRequest.SerializeToString,
            response_deserializer=DropCommitResponse.FromString,
        )
        self.__rpc_inspect_commit_set = channel.unary_stream(
            "/pfs_v2.API/InspectCommitSet",
            request_serializer=InspectCommitSetRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_list_commit_set = channel.unary_stream(
            "/pfs_v2.API/ListCommitSet",
            request_serializer=ListCommitSetRequest.SerializeToString,
            response_deserializer=CommitSetInfo.FromString,
        )
        self.__rpc_squash_commit_set = channel.unary_unary(
            "/pfs_v2.API/SquashCommitSet",
            request_serializer=SquashCommitSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_drop_commit_set = channel.unary_unary(
            "/pfs_v2.API/DropCommitSet",
            request_serializer=DropCommitSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_find_commits = channel.unary_stream(
            "/pfs_v2.API/FindCommits",
            request_serializer=FindCommitsRequest.SerializeToString,
            response_deserializer=FindCommitsResponse.FromString,
        )
        self.__rpc_walk_commit_provenance = channel.unary_stream(
            "/pfs_v2.API/WalkCommitProvenance",
            request_serializer=WalkCommitProvenanceRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_walk_commit_subvenance = channel.unary_stream(
            "/pfs_v2.API/WalkCommitSubvenance",
            request_serializer=WalkCommitSubvenanceRequest.SerializeToString,
            response_deserializer=CommitInfo.FromString,
        )
        self.__rpc_create_branch = channel.unary_unary(
            "/pfs_v2.API/CreateBranch",
            request_serializer=CreateBranchRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_branch = channel.unary_unary(
            "/pfs_v2.API/InspectBranch",
            request_serializer=InspectBranchRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_list_branch = channel.unary_stream(
            "/pfs_v2.API/ListBranch",
            request_serializer=ListBranchRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_delete_branch = channel.unary_unary(
            "/pfs_v2.API/DeleteBranch",
            request_serializer=DeleteBranchRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_walk_branch_provenance = channel.unary_stream(
            "/pfs_v2.API/WalkBranchProvenance",
            request_serializer=WalkBranchProvenanceRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_walk_branch_subvenance = channel.unary_stream(
            "/pfs_v2.API/WalkBranchSubvenance",
            request_serializer=WalkBranchSubvenanceRequest.SerializeToString,
            response_deserializer=BranchInfo.FromString,
        )
        self.__rpc_modify_file = channel.stream_unary(
            "/pfs_v2.API/ModifyFile",
            request_serializer=ModifyFileRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_get_file = channel.unary_stream(
            "/pfs_v2.API/GetFile",
            request_serializer=GetFileRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.BytesValue.FromString,
        )
        self.__rpc_get_file_tar = channel.unary_stream(
            "/pfs_v2.API/GetFileTAR",
            request_serializer=GetFileRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.BytesValue.FromString,
        )
        self.__rpc_inspect_file = channel.unary_unary(
            "/pfs_v2.API/InspectFile",
            request_serializer=InspectFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_list_file = channel.unary_stream(
            "/pfs_v2.API/ListFile",
            request_serializer=ListFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_walk_file = channel.unary_stream(
            "/pfs_v2.API/WalkFile",
            request_serializer=WalkFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_glob_file = channel.unary_stream(
            "/pfs_v2.API/GlobFile",
            request_serializer=GlobFileRequest.SerializeToString,
            response_deserializer=FileInfo.FromString,
        )
        self.__rpc_diff_file = channel.unary_stream(
            "/pfs_v2.API/DiffFile",
            request_serializer=DiffFileRequest.SerializeToString,
            response_deserializer=DiffFileResponse.FromString,
        )
        self.__rpc_activate_auth = channel.unary_unary(
            "/pfs_v2.API/ActivateAuth",
            request_serializer=ActivateAuthRequest.SerializeToString,
            response_deserializer=ActivateAuthResponse.FromString,
        )
        self.__rpc_delete_all = channel.unary_unary(
            "/pfs_v2.API/DeleteAll",
            request_serializer=betterproto_lib_google_protobuf.Empty.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_fsck = channel.unary_stream(
            "/pfs_v2.API/Fsck",
            request_serializer=FsckRequest.SerializeToString,
            response_deserializer=FsckResponse.FromString,
        )
        self.__rpc_create_file_set = channel.stream_unary(
            "/pfs_v2.API/CreateFileSet",
            request_serializer=ModifyFileRequest.SerializeToString,
            response_deserializer=CreateFileSetResponse.FromString,
        )
        self.__rpc_get_file_set = channel.unary_unary(
            "/pfs_v2.API/GetFileSet",
            request_serializer=GetFileSetRequest.SerializeToString,
            response_deserializer=CreateFileSetResponse.FromString,
        )
        self.__rpc_add_file_set = channel.unary_unary(
            "/pfs_v2.API/AddFileSet",
            request_serializer=AddFileSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_renew_file_set = channel.unary_unary(
            "/pfs_v2.API/RenewFileSet",
            request_serializer=RenewFileSetRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_compose_file_set = channel.unary_unary(
            "/pfs_v2.API/ComposeFileSet",
            request_serializer=ComposeFileSetRequest.SerializeToString,
            response_deserializer=CreateFileSetResponse.FromString,
        )
        self.__rpc_shard_file_set = channel.unary_unary(
            "/pfs_v2.API/ShardFileSet",
            request_serializer=ShardFileSetRequest.SerializeToString,
            response_deserializer=ShardFileSetResponse.FromString,
        )
        self.__rpc_check_storage = channel.unary_unary(
            "/pfs_v2.API/CheckStorage",
            request_serializer=CheckStorageRequest.SerializeToString,
            response_deserializer=CheckStorageResponse.FromString,
        )
        self.__rpc_put_cache = channel.unary_unary(
            "/pfs_v2.API/PutCache",
            request_serializer=PutCacheRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_get_cache = channel.unary_unary(
            "/pfs_v2.API/GetCache",
            request_serializer=GetCacheRequest.SerializeToString,
            response_deserializer=GetCacheResponse.FromString,
        )
        self.__rpc_clear_cache = channel.unary_unary(
            "/pfs_v2.API/ClearCache",
            request_serializer=ClearCacheRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_list_task = channel.unary_stream(
            "/pfs_v2.API/ListTask",
            request_serializer=_taskapi__.ListTaskRequest.SerializeToString,
            response_deserializer=_taskapi__.TaskInfo.FromString,
        )
        self.__rpc_egress = channel.unary_unary(
            "/pfs_v2.API/Egress",
            request_serializer=EgressRequest.SerializeToString,
            response_deserializer=EgressResponse.FromString,
        )
        self.__rpc_create_project = channel.unary_unary(
            "/pfs_v2.API/CreateProject",
            request_serializer=CreateProjectRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_inspect_project = channel.unary_unary(
            "/pfs_v2.API/InspectProject",
            request_serializer=InspectProjectRequest.SerializeToString,
            response_deserializer=ProjectInfo.FromString,
        )
        self.__rpc_inspect_project_v2 = channel.unary_unary(
            "/pfs_v2.API/InspectProjectV2",
            request_serializer=InspectProjectV2Request.SerializeToString,
            response_deserializer=InspectProjectV2Response.FromString,
        )
        self.__rpc_list_project = channel.unary_stream(
            "/pfs_v2.API/ListProject",
            request_serializer=ListProjectRequest.SerializeToString,
            response_deserializer=ProjectInfo.FromString,
        )
        self.__rpc_delete_project = channel.unary_unary(
            "/pfs_v2.API/DeleteProject",
            request_serializer=DeleteProjectRequest.SerializeToString,
            response_deserializer=betterproto_lib_google_protobuf.Empty.FromString,
        )
        self.__rpc_repos_summary = channel.unary_unary(
            "/pfs_v2.API/ReposSummary",
            request_serializer=ReposSummaryRequest.SerializeToString,
            response_deserializer=ReposSummaryResponse.FromString,
        )
        self.__rpc_forget_commit = channel.unary_unary(
            "/pfs_v2.API/ForgetCommit",
            request_serializer=ForgetCommitRequest.SerializeToString,
            response_deserializer=ForgetCommitResponse.FromString,
        )

    def create_repo(
        self, *, repo: "Repo" = None, description: str = "", update: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = CreateRepoRequest()
        if repo is not None:
            request.repo = repo
        request.description = description
        request.update = update

        return self.__rpc_create_repo(request)

    def inspect_repo(self, *, repo: "Repo" = None) -> "RepoInfo":

        request = InspectRepoRequest()
        if repo is not None:
            request.repo = repo

        return self.__rpc_inspect_repo(request)

    def list_repo(
        self,
        *,
        type: str = "",
        projects: Optional[List["Project"]] = None,
        page: "RepoPage" = None
    ) -> Iterator["RepoInfo"]:
        projects = projects or []

        request = ListRepoRequest()
        request.type = type
        if projects is not None:
            request.projects = projects
        if page is not None:
            request.page = page

        for response in self.__rpc_list_repo(request):
            yield response

    def delete_repo(
        self, *, repo: "Repo" = None, force: bool = False
    ) -> "DeleteRepoResponse":

        request = DeleteRepoRequest()
        if repo is not None:
            request.repo = repo
        request.force = force

        return self.__rpc_delete_repo(request)

    def delete_repos(
        self,
        *,
        projects: Optional[List["Project"]] = None,
        force: bool = False,
        all: bool = False
    ) -> "DeleteReposResponse":
        projects = projects or []

        request = DeleteReposRequest()
        if projects is not None:
            request.projects = projects
        request.force = force
        request.all = all

        return self.__rpc_delete_repos(request)

    def start_commit(
        self, *, parent: "Commit" = None, description: str = "", branch: "Branch" = None
    ) -> "Commit":

        request = StartCommitRequest()
        if parent is not None:
            request.parent = parent
        request.description = description
        if branch is not None:
            request.branch = branch

        return self.__rpc_start_commit(request)

    def finish_commit(
        self,
        *,
        commit: "Commit" = None,
        description: str = "",
        error: str = "",
        force: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = FinishCommitRequest()
        if commit is not None:
            request.commit = commit
        request.description = description
        request.error = error
        request.force = force

        return self.__rpc_finish_commit(request)

    def clear_commit(
        self, *, commit: "Commit" = None
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = ClearCommitRequest()
        if commit is not None:
            request.commit = commit

        return self.__rpc_clear_commit(request)

    def inspect_commit(
        self, *, commit: "Commit" = None, wait: "CommitState" = None
    ) -> "CommitInfo":

        request = InspectCommitRequest()
        if commit is not None:
            request.commit = commit
        request.wait = wait

        return self.__rpc_inspect_commit(request)

    def list_commit(
        self,
        *,
        repo: "Repo" = None,
        from_: "Commit" = None,
        to: "Commit" = None,
        number: int = 0,
        reverse: bool = False,
        all: bool = False,
        origin_kind: "OriginKind" = None,
        started_time: datetime = None
    ) -> Iterator["CommitInfo"]:

        request = ListCommitRequest()
        if repo is not None:
            request.repo = repo
        if from_ is not None:
            request.from_ = from_
        if to is not None:
            request.to = to
        request.number = number
        request.reverse = reverse
        request.all = all
        request.origin_kind = origin_kind
        if started_time is not None:
            request.started_time = started_time

        for response in self.__rpc_list_commit(request):
            yield response

    def subscribe_commit(
        self,
        *,
        repo: "Repo" = None,
        branch: str = "",
        from_: "Commit" = None,
        state: "CommitState" = None,
        all: bool = False,
        origin_kind: "OriginKind" = None
    ) -> Iterator["CommitInfo"]:

        request = SubscribeCommitRequest()
        if repo is not None:
            request.repo = repo
        request.branch = branch
        if from_ is not None:
            request.from_ = from_
        request.state = state
        request.all = all
        request.origin_kind = origin_kind

        for response in self.__rpc_subscribe_commit(request):
            yield response

    def squash_commit(
        self, *, commit: "Commit" = None, recursive: bool = False
    ) -> "SquashCommitResponse":

        request = SquashCommitRequest()
        if commit is not None:
            request.commit = commit
        request.recursive = recursive

        return self.__rpc_squash_commit(request)

    def drop_commit(
        self, *, commit: "Commit" = None, recursive: bool = False
    ) -> "DropCommitResponse":

        request = DropCommitRequest()
        if commit is not None:
            request.commit = commit
        request.recursive = recursive

        return self.__rpc_drop_commit(request)

    def inspect_commit_set(
        self, *, commit_set: "CommitSet" = None, wait: bool = False
    ) -> Iterator["CommitInfo"]:

        request = InspectCommitSetRequest()
        if commit_set is not None:
            request.commit_set = commit_set
        request.wait = wait

        for response in self.__rpc_inspect_commit_set(request):
            yield response

    def list_commit_set(
        self, *, project: "Project" = None
    ) -> Iterator["CommitSetInfo"]:

        request = ListCommitSetRequest()
        if project is not None:
            request.project = project

        for response in self.__rpc_list_commit_set(request):
            yield response

    def squash_commit_set(
        self, *, commit_set: "CommitSet" = None
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = SquashCommitSetRequest()
        if commit_set is not None:
            request.commit_set = commit_set

        return self.__rpc_squash_commit_set(request)

    def drop_commit_set(
        self, *, commit_set: "CommitSet" = None
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = DropCommitSetRequest()
        if commit_set is not None:
            request.commit_set = commit_set

        return self.__rpc_drop_commit_set(request)

    def find_commits(
        self, *, start: "Commit" = None, file_path: str = "", limit: int = 0
    ) -> Iterator["FindCommitsResponse"]:

        request = FindCommitsRequest()
        if start is not None:
            request.start = start
        request.file_path = file_path
        request.limit = limit

        for response in self.__rpc_find_commits(request):
            yield response

    def walk_commit_provenance(
        self,
        *,
        start: Optional[List["CommitPicker"]] = None,
        max_commits: int = 0,
        max_depth: int = 0
    ) -> Iterator["CommitInfo"]:
        start = start or []

        request = WalkCommitProvenanceRequest()
        if start is not None:
            request.start = start
        request.max_commits = max_commits
        request.max_depth = max_depth

        for response in self.__rpc_walk_commit_provenance(request):
            yield response

    def walk_commit_subvenance(
        self,
        *,
        start: Optional[List["CommitPicker"]] = None,
        max_commits: int = 0,
        max_depth: int = 0
    ) -> Iterator["CommitInfo"]:
        start = start or []

        request = WalkCommitSubvenanceRequest()
        if start is not None:
            request.start = start
        request.max_commits = max_commits
        request.max_depth = max_depth

        for response in self.__rpc_walk_commit_subvenance(request):
            yield response

    def create_branch(
        self,
        *,
        head: "Commit" = None,
        branch: "Branch" = None,
        provenance: Optional[List["Branch"]] = None,
        trigger: "Trigger" = None,
        new_commit_set: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":
        provenance = provenance or []

        request = CreateBranchRequest()
        if head is not None:
            request.head = head
        if branch is not None:
            request.branch = branch
        if provenance is not None:
            request.provenance = provenance
        if trigger is not None:
            request.trigger = trigger
        request.new_commit_set = new_commit_set

        return self.__rpc_create_branch(request)

    def inspect_branch(self, *, branch: "Branch" = None) -> "BranchInfo":

        request = InspectBranchRequest()
        if branch is not None:
            request.branch = branch

        return self.__rpc_inspect_branch(request)

    def list_branch(
        self, *, repo: "Repo" = None, reverse: bool = False
    ) -> Iterator["BranchInfo"]:

        request = ListBranchRequest()
        if repo is not None:
            request.repo = repo
        request.reverse = reverse

        for response in self.__rpc_list_branch(request):
            yield response

    def delete_branch(
        self, *, branch: "Branch" = None, force: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = DeleteBranchRequest()
        if branch is not None:
            request.branch = branch
        request.force = force

        return self.__rpc_delete_branch(request)

    def walk_branch_provenance(
        self,
        *,
        start: Optional[List["BranchPicker"]] = None,
        max_branches: int = 0,
        max_depth: int = 0
    ) -> Iterator["BranchInfo"]:
        start = start or []

        request = WalkBranchProvenanceRequest()
        if start is not None:
            request.start = start
        request.max_branches = max_branches
        request.max_depth = max_depth

        for response in self.__rpc_walk_branch_provenance(request):
            yield response

    def walk_branch_subvenance(
        self,
        *,
        start: Optional[List["BranchPicker"]] = None,
        max_branches: int = 0,
        max_depth: int = 0
    ) -> Iterator["BranchInfo"]:
        start = start or []

        request = WalkBranchSubvenanceRequest()
        if start is not None:
            request.start = start
        request.max_branches = max_branches
        request.max_depth = max_depth

        for response in self.__rpc_walk_branch_subvenance(request):
            yield response

    def modify_file(
        self,
        request_iterator: Union[
            AsyncIterable["ModifyFileRequest"], Iterable["ModifyFileRequest"]
        ],
    ) -> "betterproto_lib_google_protobuf.Empty":

        return self.__rpc_modify_file(request_iterator)

    def get_file(
        self,
        *,
        file: "File" = None,
        url: str = "",
        offset: int = 0,
        path_range: "PathRange" = None
    ) -> Iterator["betterproto_lib_google_protobuf.BytesValue"]:

        request = GetFileRequest()
        if file is not None:
            request.file = file
        request.url = url
        request.offset = offset
        if path_range is not None:
            request.path_range = path_range

        for response in self.__rpc_get_file(request):
            yield response

    def get_file_tar(
        self,
        *,
        file: "File" = None,
        url: str = "",
        offset: int = 0,
        path_range: "PathRange" = None
    ) -> Iterator["betterproto_lib_google_protobuf.BytesValue"]:

        request = GetFileRequest()
        if file is not None:
            request.file = file
        request.url = url
        request.offset = offset
        if path_range is not None:
            request.path_range = path_range

        for response in self.__rpc_get_file_tar(request):
            yield response

    def inspect_file(self, *, file: "File" = None) -> "FileInfo":

        request = InspectFileRequest()
        if file is not None:
            request.file = file

        return self.__rpc_inspect_file(request)

    def list_file(
        self,
        *,
        file: "File" = None,
        pagination_marker: "File" = None,
        number: int = 0,
        reverse: bool = False
    ) -> Iterator["FileInfo"]:

        request = ListFileRequest()
        if file is not None:
            request.file = file
        if pagination_marker is not None:
            request.pagination_marker = pagination_marker
        request.number = number
        request.reverse = reverse

        for response in self.__rpc_list_file(request):
            yield response

    def walk_file(
        self,
        *,
        file: "File" = None,
        pagination_marker: "File" = None,
        number: int = 0,
        reverse: bool = False
    ) -> Iterator["FileInfo"]:

        request = WalkFileRequest()
        if file is not None:
            request.file = file
        if pagination_marker is not None:
            request.pagination_marker = pagination_marker
        request.number = number
        request.reverse = reverse

        for response in self.__rpc_walk_file(request):
            yield response

    def glob_file(
        self,
        *,
        commit: "Commit" = None,
        pattern: str = "",
        path_range: "PathRange" = None
    ) -> Iterator["FileInfo"]:

        request = GlobFileRequest()
        if commit is not None:
            request.commit = commit
        request.pattern = pattern
        if path_range is not None:
            request.path_range = path_range

        for response in self.__rpc_glob_file(request):
            yield response

    def diff_file(
        self, *, new_file: "File" = None, old_file: "File" = None, shallow: bool = False
    ) -> Iterator["DiffFileResponse"]:

        request = DiffFileRequest()
        if new_file is not None:
            request.new_file = new_file
        if old_file is not None:
            request.old_file = old_file
        request.shallow = shallow

        for response in self.__rpc_diff_file(request):
            yield response

    def activate_auth(self) -> "ActivateAuthResponse":

        request = ActivateAuthRequest()

        return self.__rpc_activate_auth(request)

    def delete_all(self) -> "betterproto_lib_google_protobuf.Empty":

        request = betterproto_lib_google_protobuf.Empty()

        return self.__rpc_delete_all(request)

    def fsck(
        self,
        *,
        fix: bool = False,
        zombie_target: "Commit" = None,
        zombie_all: bool = False
    ) -> Iterator["FsckResponse"]:

        request = FsckRequest()
        request.fix = fix
        if zombie_target is not None:
            request.zombie_target = zombie_target
        request.zombie_all = zombie_all

        for response in self.__rpc_fsck(request):
            yield response

    def create_file_set(
        self,
        request_iterator: Union[
            AsyncIterable["ModifyFileRequest"], Iterable["ModifyFileRequest"]
        ],
    ) -> "CreateFileSetResponse":

        return self.__rpc_create_file_set(request_iterator)

    def get_file_set(
        self, *, commit: "Commit" = None, type: "GetFileSetRequestFileSetType" = None
    ) -> "CreateFileSetResponse":

        request = GetFileSetRequest()
        if commit is not None:
            request.commit = commit
        request.type = type

        return self.__rpc_get_file_set(request)

    def add_file_set(
        self, *, commit: "Commit" = None, file_set_id: str = ""
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = AddFileSetRequest()
        if commit is not None:
            request.commit = commit
        request.file_set_id = file_set_id

        return self.__rpc_add_file_set(request)

    def renew_file_set(
        self, *, file_set_id: str = "", ttl_seconds: int = 0
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = RenewFileSetRequest()
        request.file_set_id = file_set_id
        request.ttl_seconds = ttl_seconds

        return self.__rpc_renew_file_set(request)

    def compose_file_set(
        self,
        *,
        file_set_ids: Optional[List[str]] = None,
        ttl_seconds: int = 0,
        compact: bool = False
    ) -> "CreateFileSetResponse":
        file_set_ids = file_set_ids or []

        request = ComposeFileSetRequest()
        request.file_set_ids = file_set_ids
        request.ttl_seconds = ttl_seconds
        request.compact = compact

        return self.__rpc_compose_file_set(request)

    def shard_file_set(
        self, *, file_set_id: str = "", num_files: int = 0, size_bytes: int = 0
    ) -> "ShardFileSetResponse":

        request = ShardFileSetRequest()
        request.file_set_id = file_set_id
        request.num_files = num_files
        request.size_bytes = size_bytes

        return self.__rpc_shard_file_set(request)

    def check_storage(
        self,
        *,
        read_chunk_data: bool = False,
        chunk_begin: bytes = b"",
        chunk_end: bytes = b""
    ) -> "CheckStorageResponse":

        request = CheckStorageRequest()
        request.read_chunk_data = read_chunk_data
        request.chunk_begin = chunk_begin
        request.chunk_end = chunk_end

        return self.__rpc_check_storage(request)

    def put_cache(
        self,
        *,
        key: str = "",
        value: "betterproto_lib_google_protobuf.Any" = None,
        file_set_ids: Optional[List[str]] = None,
        tag: str = ""
    ) -> "betterproto_lib_google_protobuf.Empty":
        file_set_ids = file_set_ids or []

        request = PutCacheRequest()
        request.key = key
        if value is not None:
            request.value = value
        request.file_set_ids = file_set_ids
        request.tag = tag

        return self.__rpc_put_cache(request)

    def get_cache(self, *, key: str = "") -> "GetCacheResponse":

        request = GetCacheRequest()
        request.key = key

        return self.__rpc_get_cache(request)

    def clear_cache(
        self, *, tag_prefix: str = ""
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = ClearCacheRequest()
        request.tag_prefix = tag_prefix

        return self.__rpc_clear_cache(request)

    def list_task(self, *, group: "Group" = None) -> Iterator["_taskapi__.TaskInfo"]:

        request = _taskapi__.ListTaskRequest()
        if group is not None:
            request.group = group

        for response in self.__rpc_list_task(request):
            yield response

    def egress(
        self,
        *,
        commit: "Commit" = None,
        object_storage: "ObjectStorageEgress" = None,
        sql_database: "SqlDatabaseEgress" = None
    ) -> "EgressResponse":

        request = EgressRequest()
        if commit is not None:
            request.commit = commit
        if object_storage is not None:
            request.object_storage = object_storage
        if sql_database is not None:
            request.sql_database = sql_database

        return self.__rpc_egress(request)

    def create_project(
        self, *, project: "Project" = None, description: str = "", update: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = CreateProjectRequest()
        if project is not None:
            request.project = project
        request.description = description
        request.update = update

        return self.__rpc_create_project(request)

    def inspect_project(self, *, project: "Project" = None) -> "ProjectInfo":

        request = InspectProjectRequest()
        if project is not None:
            request.project = project

        return self.__rpc_inspect_project(request)

    def inspect_project_v2(
        self, *, project: "Project" = None
    ) -> "InspectProjectV2Response":

        request = InspectProjectV2Request()
        if project is not None:
            request.project = project

        return self.__rpc_inspect_project_v2(request)

    def list_project(self) -> Iterator["ProjectInfo"]:

        request = ListProjectRequest()

        for response in self.__rpc_list_project(request):
            yield response

    def delete_project(
        self, *, project: "Project" = None, force: bool = False
    ) -> "betterproto_lib_google_protobuf.Empty":

        request = DeleteProjectRequest()
        if project is not None:
            request.project = project
        request.force = force

        return self.__rpc_delete_project(request)

    def repos_summary(
        self, *, projects: Optional[List["ProjectPicker"]] = None
    ) -> "ReposSummaryResponse":
        projects = projects or []

        request = ReposSummaryRequest()
        if projects is not None:
            request.projects = projects

        return self.__rpc_repos_summary(request)

    def forget_commit(self, *, commit: "CommitPicker" = None) -> "ForgetCommitResponse":

        request = ForgetCommitRequest()
        if commit is not None:
            request.commit = commit

        return self.__rpc_forget_commit(request)

Subclasses

ApiStub

Methods

def create_repo(self, *, repo: Repo = None, description: str = '', update: bool = False) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def create_repo(
    self, *, repo: "Repo" = None, description: str = "", update: bool = False
) -> "betterproto_lib_google_protobuf.Empty":

    request = CreateRepoRequest()
    if repo is not None:
        request.repo = repo
    request.description = description
    request.update = update

    return self.__rpc_create_repo(request)

def inspect_repo(self, *, repo: Repo = None) ‑> RepoInfo

Expand source code

def inspect_repo(self, *, repo: "Repo" = None) -> "RepoInfo":

    request = InspectRepoRequest()
    if repo is not None:
        request.repo = repo

    return self.__rpc_inspect_repo(request)

def list_repo(self, *, type: str = '', projects: Optional[List[ForwardRef('Project')]] = None, page: RepoPage = None) ‑> Iterator[RepoInfo]

Expand source code

def list_repo(
    self,
    *,
    type: str = "",
    projects: Optional[List["Project"]] = None,
    page: "RepoPage" = None
) -> Iterator["RepoInfo"]:
    projects = projects or []

    request = ListRepoRequest()
    request.type = type
    if projects is not None:
        request.projects = projects
    if page is not None:
        request.page = page

    for response in self.__rpc_list_repo(request):
        yield response

def delete_repo(self, *, repo: Repo = None, force: bool = False) ‑> DeleteRepoResponse

Expand source code

def delete_repo(
    self, *, repo: "Repo" = None, force: bool = False
) -> "DeleteRepoResponse":

    request = DeleteRepoRequest()
    if repo is not None:
        request.repo = repo
    request.force = force

    return self.__rpc_delete_repo(request)

def delete_repos(self, *, projects: Optional[List[ForwardRef('Project')]] = None, force: bool = False, all: bool = False) ‑> DeleteReposResponse

Expand source code

def delete_repos(
    self,
    *,
    projects: Optional[List["Project"]] = None,
    force: bool = False,
    all: bool = False
) -> "DeleteReposResponse":
    projects = projects or []

    request = DeleteReposRequest()
    if projects is not None:
        request.projects = projects
    request.force = force
    request.all = all

    return self.__rpc_delete_repos(request)

def start_commit(self, *, parent: Commit = None, description: str = '', branch: Branch = None) ‑> Commit

Expand source code

def start_commit(
    self, *, parent: "Commit" = None, description: str = "", branch: "Branch" = None
) -> "Commit":

    request = StartCommitRequest()
    if parent is not None:
        request.parent = parent
    request.description = description
    if branch is not None:
        request.branch = branch

    return self.__rpc_start_commit(request)

def finish_commit(self, *, commit: Commit = None, description: str = '', error: str = '', force: bool = False) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def finish_commit(
    self,
    *,
    commit: "Commit" = None,
    description: str = "",
    error: str = "",
    force: bool = False
) -> "betterproto_lib_google_protobuf.Empty":

    request = FinishCommitRequest()
    if commit is not None:
        request.commit = commit
    request.description = description
    request.error = error
    request.force = force

    return self.__rpc_finish_commit(request)

def clear_commit(self, *, commit: Commit = None) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def clear_commit(
    self, *, commit: "Commit" = None
) -> "betterproto_lib_google_protobuf.Empty":

    request = ClearCommitRequest()
    if commit is not None:
        request.commit = commit

    return self.__rpc_clear_commit(request)

def inspect_commit(self, *, commit: Commit = None, wait: CommitState = None) ‑> CommitInfo

Expand source code

def inspect_commit(
    self, *, commit: "Commit" = None, wait: "CommitState" = None
) -> "CommitInfo":

    request = InspectCommitRequest()
    if commit is not None:
        request.commit = commit
    request.wait = wait

    return self.__rpc_inspect_commit(request)

def list_commit(self, *, repo: Repo = None, from_: Commit = None, to: Commit = None, number: int = 0, reverse: bool = False, all: bool = False, origin_kind: OriginKind = None, started_time: datetime.datetime = None) ‑> Iterator[CommitInfo]

Expand source code

def list_commit(
    self,
    *,
    repo: "Repo" = None,
    from_: "Commit" = None,
    to: "Commit" = None,
    number: int = 0,
    reverse: bool = False,
    all: bool = False,
    origin_kind: "OriginKind" = None,
    started_time: datetime = None
) -> Iterator["CommitInfo"]:

    request = ListCommitRequest()
    if repo is not None:
        request.repo = repo
    if from_ is not None:
        request.from_ = from_
    if to is not None:
        request.to = to
    request.number = number
    request.reverse = reverse
    request.all = all
    request.origin_kind = origin_kind
    if started_time is not None:
        request.started_time = started_time

    for response in self.__rpc_list_commit(request):
        yield response

def subscribe_commit(self, *, repo: Repo = None, branch: str = '', from_: Commit = None, state: CommitState = None, all: bool = False, origin_kind: OriginKind = None) ‑> Iterator[CommitInfo]

Expand source code

def subscribe_commit(
    self,
    *,
    repo: "Repo" = None,
    branch: str = "",
    from_: "Commit" = None,
    state: "CommitState" = None,
    all: bool = False,
    origin_kind: "OriginKind" = None
) -> Iterator["CommitInfo"]:

    request = SubscribeCommitRequest()
    if repo is not None:
        request.repo = repo
    request.branch = branch
    if from_ is not None:
        request.from_ = from_
    request.state = state
    request.all = all
    request.origin_kind = origin_kind

    for response in self.__rpc_subscribe_commit(request):
        yield response

def squash_commit(self, *, commit: Commit = None, recursive: bool = False) ‑> SquashCommitResponse

Expand source code

def squash_commit(
    self, *, commit: "Commit" = None, recursive: bool = False
) -> "SquashCommitResponse":

    request = SquashCommitRequest()
    if commit is not None:
        request.commit = commit
    request.recursive = recursive

    return self.__rpc_squash_commit(request)

def drop_commit(self, *, commit: Commit = None, recursive: bool = False) ‑> DropCommitResponse

Expand source code

def drop_commit(
    self, *, commit: "Commit" = None, recursive: bool = False
) -> "DropCommitResponse":

    request = DropCommitRequest()
    if commit is not None:
        request.commit = commit
    request.recursive = recursive

    return self.__rpc_drop_commit(request)

def inspect_commit_set(self, *, commit_set: CommitSet = None, wait: bool = False) ‑> Iterator[CommitInfo]

Expand source code

def inspect_commit_set(
    self, *, commit_set: "CommitSet" = None, wait: bool = False
) -> Iterator["CommitInfo"]:

    request = InspectCommitSetRequest()
    if commit_set is not None:
        request.commit_set = commit_set
    request.wait = wait

    for response in self.__rpc_inspect_commit_set(request):
        yield response

def list_commit_set(self, *, project: Project = None) ‑> Iterator[CommitSetInfo]

Expand source code

def list_commit_set(
    self, *, project: "Project" = None
) -> Iterator["CommitSetInfo"]:

    request = ListCommitSetRequest()
    if project is not None:
        request.project = project

    for response in self.__rpc_list_commit_set(request):
        yield response

def squash_commit_set(self, *, commit_set: CommitSet = None) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def squash_commit_set(
    self, *, commit_set: "CommitSet" = None
) -> "betterproto_lib_google_protobuf.Empty":

    request = SquashCommitSetRequest()
    if commit_set is not None:
        request.commit_set = commit_set

    return self.__rpc_squash_commit_set(request)

def drop_commit_set(self, *, commit_set: CommitSet = None) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def drop_commit_set(
    self, *, commit_set: "CommitSet" = None
) -> "betterproto_lib_google_protobuf.Empty":

    request = DropCommitSetRequest()
    if commit_set is not None:
        request.commit_set = commit_set

    return self.__rpc_drop_commit_set(request)

def find_commits(self, *, start: Commit = None, file_path: str = '', limit: int = 0) ‑> Iterator[FindCommitsResponse]

Expand source code

def find_commits(
    self, *, start: "Commit" = None, file_path: str = "", limit: int = 0
) -> Iterator["FindCommitsResponse"]:

    request = FindCommitsRequest()
    if start is not None:
        request.start = start
    request.file_path = file_path
    request.limit = limit

    for response in self.__rpc_find_commits(request):
        yield response

def walk_commit_provenance(self, *, start: Optional[List[ForwardRef('CommitPicker')]] = None, max_commits: int = 0, max_depth: int = 0) ‑> Iterator[CommitInfo]

Expand source code

def walk_commit_provenance(
    self,
    *,
    start: Optional[List["CommitPicker"]] = None,
    max_commits: int = 0,
    max_depth: int = 0
) -> Iterator["CommitInfo"]:
    start = start or []

    request = WalkCommitProvenanceRequest()
    if start is not None:
        request.start = start
    request.max_commits = max_commits
    request.max_depth = max_depth

    for response in self.__rpc_walk_commit_provenance(request):
        yield response

def walk_commit_subvenance(self, *, start: Optional[List[ForwardRef('CommitPicker')]] = None, max_commits: int = 0, max_depth: int = 0) ‑> Iterator[CommitInfo]

Expand source code

def walk_commit_subvenance(
    self,
    *,
    start: Optional[List["CommitPicker"]] = None,
    max_commits: int = 0,
    max_depth: int = 0
) -> Iterator["CommitInfo"]:
    start = start or []

    request = WalkCommitSubvenanceRequest()
    if start is not None:
        request.start = start
    request.max_commits = max_commits
    request.max_depth = max_depth

    for response in self.__rpc_walk_commit_subvenance(request):
        yield response

def create_branch(self, *, head: Commit = None, branch: Branch = None, provenance: Optional[List[ForwardRef('Branch')]] = None, trigger: Trigger = None, new_commit_set: bool = False) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def create_branch(
    self,
    *,
    head: "Commit" = None,
    branch: "Branch" = None,
    provenance: Optional[List["Branch"]] = None,
    trigger: "Trigger" = None,
    new_commit_set: bool = False
) -> "betterproto_lib_google_protobuf.Empty":
    provenance = provenance or []

    request = CreateBranchRequest()
    if head is not None:
        request.head = head
    if branch is not None:
        request.branch = branch
    if provenance is not None:
        request.provenance = provenance
    if trigger is not None:
        request.trigger = trigger
    request.new_commit_set = new_commit_set

    return self.__rpc_create_branch(request)

def inspect_branch(self, *, branch: Branch = None) ‑> BranchInfo

Expand source code

def inspect_branch(self, *, branch: "Branch" = None) -> "BranchInfo":

    request = InspectBranchRequest()
    if branch is not None:
        request.branch = branch

    return self.__rpc_inspect_branch(request)

def list_branch(self, *, repo: Repo = None, reverse: bool = False) ‑> Iterator[BranchInfo]

Expand source code

def list_branch(
    self, *, repo: "Repo" = None, reverse: bool = False
) -> Iterator["BranchInfo"]:

    request = ListBranchRequest()
    if repo is not None:
        request.repo = repo
    request.reverse = reverse

    for response in self.__rpc_list_branch(request):
        yield response

def delete_branch(self, *, branch: Branch = None, force: bool = False) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def delete_branch(
    self, *, branch: "Branch" = None, force: bool = False
) -> "betterproto_lib_google_protobuf.Empty":

    request = DeleteBranchRequest()
    if branch is not None:
        request.branch = branch
    request.force = force

    return self.__rpc_delete_branch(request)

def walk_branch_provenance(self, *, start: Optional[List[ForwardRef('BranchPicker')]] = None, max_branches: int = 0, max_depth: int = 0) ‑> Iterator[BranchInfo]

Expand source code

def walk_branch_provenance(
    self,
    *,
    start: Optional[List["BranchPicker"]] = None,
    max_branches: int = 0,
    max_depth: int = 0
) -> Iterator["BranchInfo"]:
    start = start or []

    request = WalkBranchProvenanceRequest()
    if start is not None:
        request.start = start
    request.max_branches = max_branches
    request.max_depth = max_depth

    for response in self.__rpc_walk_branch_provenance(request):
        yield response

def walk_branch_subvenance(self, *, start: Optional[List[ForwardRef('BranchPicker')]] = None, max_branches: int = 0, max_depth: int = 0) ‑> Iterator[BranchInfo]

Expand source code

def walk_branch_subvenance(
    self,
    *,
    start: Optional[List["BranchPicker"]] = None,
    max_branches: int = 0,
    max_depth: int = 0
) -> Iterator["BranchInfo"]:
    start = start or []

    request = WalkBranchSubvenanceRequest()
    if start is not None:
        request.start = start
    request.max_branches = max_branches
    request.max_depth = max_depth

    for response in self.__rpc_walk_branch_subvenance(request):
        yield response

def modify_file(self, request_iterator: Union[AsyncIterable[ForwardRef('ModifyFileRequest')], Iterable[ForwardRef('ModifyFileRequest')]]) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def modify_file(
    self,
    request_iterator: Union[
        AsyncIterable["ModifyFileRequest"], Iterable["ModifyFileRequest"]
    ],
) -> "betterproto_lib_google_protobuf.Empty":

    return self.__rpc_modify_file(request_iterator)

def get_file(self, *, file: File = None, url: str = '', offset: int = 0, path_range: PathRange = None) ‑> Iterator[betterproto.lib.google.protobuf.BytesValue]

Expand source code

def get_file(
    self,
    *,
    file: "File" = None,
    url: str = "",
    offset: int = 0,
    path_range: "PathRange" = None
) -> Iterator["betterproto_lib_google_protobuf.BytesValue"]:

    request = GetFileRequest()
    if file is not None:
        request.file = file
    request.url = url
    request.offset = offset
    if path_range is not None:
        request.path_range = path_range

    for response in self.__rpc_get_file(request):
        yield response

def get_file_tar(self, *, file: File = None, url: str = '', offset: int = 0, path_range: PathRange = None) ‑> Iterator[betterproto.lib.google.protobuf.BytesValue]

Expand source code

def get_file_tar(
    self,
    *,
    file: "File" = None,
    url: str = "",
    offset: int = 0,
    path_range: "PathRange" = None
) -> Iterator["betterproto_lib_google_protobuf.BytesValue"]:

    request = GetFileRequest()
    if file is not None:
        request.file = file
    request.url = url
    request.offset = offset
    if path_range is not None:
        request.path_range = path_range

    for response in self.__rpc_get_file_tar(request):
        yield response

def inspect_file(self, *, file: File = None) ‑> FileInfo

Expand source code

def inspect_file(self, *, file: "File" = None) -> "FileInfo":

    request = InspectFileRequest()
    if file is not None:
        request.file = file

    return self.__rpc_inspect_file(request)

def list_file(self, *, file: File = None, pagination_marker: File = None, number: int = 0, reverse: bool = False) ‑> Iterator[FileInfo]

Expand source code

def list_file(
    self,
    *,
    file: "File" = None,
    pagination_marker: "File" = None,
    number: int = 0,
    reverse: bool = False
) -> Iterator["FileInfo"]:

    request = ListFileRequest()
    if file is not None:
        request.file = file
    if pagination_marker is not None:
        request.pagination_marker = pagination_marker
    request.number = number
    request.reverse = reverse

    for response in self.__rpc_list_file(request):
        yield response

def walk_file(self, *, file: File = None, pagination_marker: File = None, number: int = 0, reverse: bool = False) ‑> Iterator[FileInfo]

Expand source code

def walk_file(
    self,
    *,
    file: "File" = None,
    pagination_marker: "File" = None,
    number: int = 0,
    reverse: bool = False
) -> Iterator["FileInfo"]:

    request = WalkFileRequest()
    if file is not None:
        request.file = file
    if pagination_marker is not None:
        request.pagination_marker = pagination_marker
    request.number = number
    request.reverse = reverse

    for response in self.__rpc_walk_file(request):
        yield response

def glob_file(self, *, commit: Commit = None, pattern: str = '', path_range: PathRange = None) ‑> Iterator[FileInfo]

Expand source code

def glob_file(
    self,
    *,
    commit: "Commit" = None,
    pattern: str = "",
    path_range: "PathRange" = None
) -> Iterator["FileInfo"]:

    request = GlobFileRequest()
    if commit is not None:
        request.commit = commit
    request.pattern = pattern
    if path_range is not None:
        request.path_range = path_range

    for response in self.__rpc_glob_file(request):
        yield response

def diff_file(self, *, new_file: File = None, old_file: File = None, shallow: bool = False) ‑> Iterator[DiffFileResponse]

Expand source code

def diff_file(
    self, *, new_file: "File" = None, old_file: "File" = None, shallow: bool = False
) -> Iterator["DiffFileResponse"]:

    request = DiffFileRequest()
    if new_file is not None:
        request.new_file = new_file
    if old_file is not None:
        request.old_file = old_file
    request.shallow = shallow

    for response in self.__rpc_diff_file(request):
        yield response

def activate_auth(self) ‑> ActivateAuthResponse

Expand source code

def activate_auth(self) -> "ActivateAuthResponse":

    request = ActivateAuthRequest()

    return self.__rpc_activate_auth(request)

def delete_all(self) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def delete_all(self) -> "betterproto_lib_google_protobuf.Empty":

    request = betterproto_lib_google_protobuf.Empty()

    return self.__rpc_delete_all(request)

def fsck(self, *, fix: bool = False, zombie_target: Commit = None, zombie_all: bool = False) ‑> Iterator[FsckResponse]

Expand source code

def fsck(
    self,
    *,
    fix: bool = False,
    zombie_target: "Commit" = None,
    zombie_all: bool = False
) -> Iterator["FsckResponse"]:

    request = FsckRequest()
    request.fix = fix
    if zombie_target is not None:
        request.zombie_target = zombie_target
    request.zombie_all = zombie_all

    for response in self.__rpc_fsck(request):
        yield response

def create_file_set(self, request_iterator: Union[AsyncIterable[ForwardRef('ModifyFileRequest')], Iterable[ForwardRef('ModifyFileRequest')]]) ‑> CreateFileSetResponse

Expand source code

def create_file_set(
    self,
    request_iterator: Union[
        AsyncIterable["ModifyFileRequest"], Iterable["ModifyFileRequest"]
    ],
) -> "CreateFileSetResponse":

    return self.__rpc_create_file_set(request_iterator)

def get_file_set(self, *, commit: Commit = None, type: GetFileSetRequestFileSetType = None) ‑> CreateFileSetResponse

Expand source code

def get_file_set(
    self, *, commit: "Commit" = None, type: "GetFileSetRequestFileSetType" = None
) -> "CreateFileSetResponse":

    request = GetFileSetRequest()
    if commit is not None:
        request.commit = commit
    request.type = type

    return self.__rpc_get_file_set(request)

def add_file_set(self, *, commit: Commit = None, file_set_id: str = '') ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def add_file_set(
    self, *, commit: "Commit" = None, file_set_id: str = ""
) -> "betterproto_lib_google_protobuf.Empty":

    request = AddFileSetRequest()
    if commit is not None:
        request.commit = commit
    request.file_set_id = file_set_id

    return self.__rpc_add_file_set(request)

def renew_file_set(self, *, file_set_id: str = '', ttl_seconds: int = 0) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def renew_file_set(
    self, *, file_set_id: str = "", ttl_seconds: int = 0
) -> "betterproto_lib_google_protobuf.Empty":

    request = RenewFileSetRequest()
    request.file_set_id = file_set_id
    request.ttl_seconds = ttl_seconds

    return self.__rpc_renew_file_set(request)

def compose_file_set(self, *, file_set_ids: Optional[List[str]] = None, ttl_seconds: int = 0, compact: bool = False) ‑> CreateFileSetResponse

Expand source code

def compose_file_set(
    self,
    *,
    file_set_ids: Optional[List[str]] = None,
    ttl_seconds: int = 0,
    compact: bool = False
) -> "CreateFileSetResponse":
    file_set_ids = file_set_ids or []

    request = ComposeFileSetRequest()
    request.file_set_ids = file_set_ids
    request.ttl_seconds = ttl_seconds
    request.compact = compact

    return self.__rpc_compose_file_set(request)

def shard_file_set(self, *, file_set_id: str = '', num_files: int = 0, size_bytes: int = 0) ‑> ShardFileSetResponse

Expand source code

def shard_file_set(
    self, *, file_set_id: str = "", num_files: int = 0, size_bytes: int = 0
) -> "ShardFileSetResponse":

    request = ShardFileSetRequest()
    request.file_set_id = file_set_id
    request.num_files = num_files
    request.size_bytes = size_bytes

    return self.__rpc_shard_file_set(request)

def check_storage(self, *, read_chunk_data: bool = False, chunk_begin: bytes = b'', chunk_end: bytes = b'') ‑> CheckStorageResponse

Expand source code

def check_storage(
    self,
    *,
    read_chunk_data: bool = False,
    chunk_begin: bytes = b"",
    chunk_end: bytes = b""
) -> "CheckStorageResponse":

    request = CheckStorageRequest()
    request.read_chunk_data = read_chunk_data
    request.chunk_begin = chunk_begin
    request.chunk_end = chunk_end

    return self.__rpc_check_storage(request)

def put_cache(self, *, key: str = '', value: betterproto_lib_google_protobuf.Any = None, file_set_ids: Optional[List[str]] = None, tag: str = '') ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def put_cache(
    self,
    *,
    key: str = "",
    value: "betterproto_lib_google_protobuf.Any" = None,
    file_set_ids: Optional[List[str]] = None,
    tag: str = ""
) -> "betterproto_lib_google_protobuf.Empty":
    file_set_ids = file_set_ids or []

    request = PutCacheRequest()
    request.key = key
    if value is not None:
        request.value = value
    request.file_set_ids = file_set_ids
    request.tag = tag

    return self.__rpc_put_cache(request)

def get_cache(self, *, key: str = '') ‑> GetCacheResponse

Expand source code

def get_cache(self, *, key: str = "") -> "GetCacheResponse":

    request = GetCacheRequest()
    request.key = key

    return self.__rpc_get_cache(request)

def clear_cache(self, *, tag_prefix: str = '') ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def clear_cache(
    self, *, tag_prefix: str = ""
) -> "betterproto_lib_google_protobuf.Empty":

    request = ClearCacheRequest()
    request.tag_prefix = tag_prefix

    return self.__rpc_clear_cache(request)

def list_task(self, *, group: Group = None) ‑> Iterator[_taskapi__.TaskInfo]

Expand source code

def list_task(self, *, group: "Group" = None) -> Iterator["_taskapi__.TaskInfo"]:

    request = _taskapi__.ListTaskRequest()
    if group is not None:
        request.group = group

    for response in self.__rpc_list_task(request):
        yield response

def egress(self, *, commit: Commit = None, object_storage: ObjectStorageEgress = None, sql_database: SqlDatabaseEgress = None) ‑> EgressResponse

Expand source code

def egress(
    self,
    *,
    commit: "Commit" = None,
    object_storage: "ObjectStorageEgress" = None,
    sql_database: "SqlDatabaseEgress" = None
) -> "EgressResponse":

    request = EgressRequest()
    if commit is not None:
        request.commit = commit
    if object_storage is not None:
        request.object_storage = object_storage
    if sql_database is not None:
        request.sql_database = sql_database

    return self.__rpc_egress(request)

def create_project(self, *, project: Project = None, description: str = '', update: bool = False) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def create_project(
    self, *, project: "Project" = None, description: str = "", update: bool = False
) -> "betterproto_lib_google_protobuf.Empty":

    request = CreateProjectRequest()
    if project is not None:
        request.project = project
    request.description = description
    request.update = update

    return self.__rpc_create_project(request)

def inspect_project(self, *, project: Project = None) ‑> ProjectInfo

Expand source code

def inspect_project(self, *, project: "Project" = None) -> "ProjectInfo":

    request = InspectProjectRequest()
    if project is not None:
        request.project = project

    return self.__rpc_inspect_project(request)

def inspect_project_v2(self, *, project: Project = None) ‑> InspectProjectV2Response

Expand source code

def inspect_project_v2(
    self, *, project: "Project" = None
) -> "InspectProjectV2Response":

    request = InspectProjectV2Request()
    if project is not None:
        request.project = project

    return self.__rpc_inspect_project_v2(request)

def list_project(self) ‑> Iterator[ProjectInfo]

Expand source code

def list_project(self) -> Iterator["ProjectInfo"]:

    request = ListProjectRequest()

    for response in self.__rpc_list_project(request):
        yield response

def delete_project(self, *, project: Project = None, force: bool = False) ‑> betterproto.lib.google.protobuf.Empty

Expand source code

def delete_project(
    self, *, project: "Project" = None, force: bool = False
) -> "betterproto_lib_google_protobuf.Empty":

    request = DeleteProjectRequest()
    if project is not None:
        request.project = project
    request.force = force

    return self.__rpc_delete_project(request)

def repos_summary(self, *, projects: Optional[List[ForwardRef('ProjectPicker')]] = None) ‑> ReposSummaryResponse

Expand source code

def repos_summary(
    self, *, projects: Optional[List["ProjectPicker"]] = None
) -> "ReposSummaryResponse":
    projects = projects or []

    request = ReposSummaryRequest()
    if projects is not None:
        request.projects = projects

    return self.__rpc_repos_summary(request)

def forget_commit(self, *, commit: CommitPicker = None) ‑> ForgetCommitResponse

Expand source code

def forget_commit(self, *, commit: "CommitPicker" = None) -> "ForgetCommitResponse":

    request = ForgetCommitRequest()
    if commit is not None:
        request.commit = commit

    return self.__rpc_forget_commit(request)