[][src]Module pachyderm::pfs

Modules

api_client

Generated client implementations.

file_operation_request_v2
object_api_client

Generated client implementations.

Structs

Block
BlockRef
Branch
BranchInfo
BranchInfos
BuildCommitRequest
ByteRange
CheckObjectRequest
CheckObjectResponse
Commit

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)

CommitInfo

CommitInfo is the main data structure representing a commit in etcd

CommitInfos
CommitOrigin
CommitProvenance

CommitProvenance keeps track of where (i.e. which branch) a certain commit originated from. A commit's provenance consists of the commits of the commits which are in its causal history.

CommitRange

CommitRange represents chain of commits with Lower being an ancestor of Upper or, in the case of a range of size 1, the same commit.

Compaction
CopyFileRequest
CreateBranchRequest
CreateObjectRequest
CreateRepoRequest
DeleteBranchRequest
DeleteCommitRequest
DeleteFileRequest
DeleteFilesRequestV2
DeleteObjectsRequest
DeleteObjectsResponse
DeleteRepoRequest
DeleteTagsRequest
DeleteTagsResponse
DiffFileRequest
DiffFileResponse
File
FileInfo
FileInfoV2
FileInfos

FileInfos is the result of both ListFile and GlobFile

FileOperationRequestV2
FinishCommitRequest
FlushCommitRequest
FsckRequest
FsckResponse
GetBlockRequest
GetBlocksRequest
GetFileRequest
GetObjDirectRequest
GetObjectsRequest
GetTarConditionalRequestV2
GetTarConditionalResponseV2
GetTarRequestV2
GlobFileRequest
InspectBranchRequest
InspectCommitRequest
InspectFileRequest
InspectRepoRequest
ListBlockRequest
ListBranchRequest
ListCommitRequest
ListFileRequest
ListObjectsRequest
ListRepoRequest
ListRepoResponse
ListTagsRequest
ListTagsResponse
Object
ObjectIndex
ObjectInfo
Objects
OverwriteIndex

An OverwriteIndex specifies the index of objects from which new writes are applied to. Existing objects starting from the index are deleted. We want a separate message for ObjectIndex because we want to be able to distinguish between a zero index and a non-existent index.

PathRange
PutBlockRequest
PutFileRecord

PutFileRecord is used to record PutFile requests in etcd temporarily.

PutFileRecords
PutFileRequest
PutObjDirectRequest
PutObjectRequest
PutTarRequestV2
Repo
RepoAuthInfo

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

RepoInfo

RepoInfo is the main data structure representing a Repo in etcd

Shard
StartCommitRequest
SubscribeCommitRequest
Tag
TagObjectRequest
WalkFileRequest

Enums

CommitState

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.

Delimiter
FileType
OriginKind

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