python_pachyderm.experimental.proto.v2.pfs_v2 package

Module contents

class ActivateAuthRequest[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ActivateAuthResponse[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class AddFile(path: str = <object object at 0x7f2cabcb78b0>, datum: str = <object object at 0x7f2cabcb78b0>, raw: Union[bytes, NoneType] = <object object at 0x7f2cabcb78b0>, url: 'AddFileUrlSource' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class AddFileSetRequest(commit: 'Commit' = <object object at 0x7f2cabcb78b0>, file_set_id: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class AddFileUrlSource(url: str = <object object at 0x7f2cabcb78b0>, recursive: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ApiBase[source]

Methods

activate_auth
add_file_set
clear_commit
compose_file_set
create_branch
create_file_set
create_repo
delete_all
delete_branch
delete_repo
diff_file
drop_commit_set
finish_commit
fsck
get_file
get_file_set
get_file_tar
glob_file
inspect_branch
inspect_commit
inspect_commit_set
inspect_file
inspect_repo
list_branch
list_commit
list_commit_set
list_file
list_repo
modify_file
renew_file_set
run_load_test
run_load_test_default
squash_commit_set
start_commit
subscribe_commit
walk_file

class ApiStub(channel, *, timeout=None, deadline=None, metadata=None)[source]

Methods

activate_auth
add_file_set
clear_commit
compose_file_set
create_branch
create_file_set
create_repo
delete_all
delete_branch
delete_repo
diff_file
drop_commit_set
finish_commit
fsck
get_file
get_file_set
get_file_tar
glob_file
inspect_branch
inspect_commit
inspect_commit_set
inspect_file
inspect_repo
list_branch
list_commit
list_commit_set
list_file
list_repo
modify_file
renew_file_set
run_load_test
run_load_test_default
squash_commit_set
start_commit
subscribe_commit
walk_file

class Branch(repo: 'Repo' = <object object at 0x7f2cabcb78b0>, name: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class BranchInfo(branch: 'Branch' = <object object at 0x7f2cabcb78b0>, head: 'Commit' = <object object at 0x7f2cabcb78b0>, provenance: List[ForwardRef('Branch')] = <object object at 0x7f2cabcb78b0>, subvenance: List[ForwardRef('Branch')] = <object object at 0x7f2cabcb78b0>, direct_provenance: List[ForwardRef('Branch')] = <object object at 0x7f2cabcb78b0>, trigger: 'Trigger' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ClearCommitRequest(commit: 'Commit' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class Commit(branch=<object object>, id=<object object>)[source]

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)

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CommitInfo(commit=<object object>, origin=<object object>, description=<object object>, parent_commit=<object object>, child_commits=<object object>, started=<object object>, finishing=<object object>, finished=<object object>, direct_provenance=<object object>, error=<object object>, size_bytes_upper_bound=<object object>, details=<object object>)[source]

CommitInfo is the main data structure representing a commit in etcd

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CommitInfoDetails(size_bytes=<object object>, compacting_time=<object object>, validating_time=<object object>)[source]

Details are only provided when explicitly requested

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CommitOrigin(kind: 'OriginKind' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CommitSet(id: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CommitSetInfo(commit_set: 'CommitSet' = <object object at 0x7f2cabcb78b0>, commits: List[ForwardRef('CommitInfo')] = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CommitState(value)[source]: 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.

class ComposeFileSetRequest(file_set_ids: List[str] = <object object at 0x7f2cabcb78b0>, ttl_seconds: int = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CopyFile(dst: str = <object object at 0x7f2cabcb78b0>, datum: str = <object object at 0x7f2cabcb78b0>, src: 'File' = <object object at 0x7f2cabcb78b0>, append: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CreateBranchRequest(head: 'Commit' = <object object at 0x7f2cabcb78b0>, branch: 'Branch' = <object object at 0x7f2cabcb78b0>, provenance: List[ForwardRef('Branch')] = <object object at 0x7f2cabcb78b0>, trigger: 'Trigger' = <object object at 0x7f2cabcb78b0>, new_commit_set: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CreateFileSetResponse(file_set_id: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class CreateRepoRequest(repo: 'Repo' = <object object at 0x7f2cabcb78b0>, description: str = <object object at 0x7f2cabcb78b0>, update: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DeleteBranchRequest(branch: 'Branch' = <object object at 0x7f2cabcb78b0>, force: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DeleteFile(path: str = <object object at 0x7f2cabcb78b0>, datum: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DeleteRepoRequest(repo: 'Repo' = <object object at 0x7f2cabcb78b0>, force: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class Delimiter(value)[source]: An enumeration.

class DiffFileRequest(new_file: 'File' = <object object at 0x7f2cabcb78b0>, old_file: 'File' = <object object at 0x7f2cabcb78b0>, shallow: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DiffFileResponse(new_file: 'FileInfo' = <object object at 0x7f2cabcb78b0>, old_file: 'FileInfo' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class DropCommitSetRequest(commit_set: 'CommitSet' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class File(commit: 'Commit' = <object object at 0x7f2cabcb78b0>, path: str = <object object at 0x7f2cabcb78b0>, datum: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class FileInfo(file: 'File' = <object object at 0x7f2cabcb78b0>, file_type: 'FileType' = <object object at 0x7f2cabcb78b0>, committed: datetime.datetime = <object object at 0x7f2cabcb78b0>, size_bytes: int = <object object at 0x7f2cabcb78b0>, hash: bytes = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class FileType(value)[source]: An enumeration.

class FinishCommitRequest(commit: 'Commit' = <object object at 0x7f2cabcb78b0>, description: str = <object object at 0x7f2cabcb78b0>, error: str = <object object at 0x7f2cabcb78b0>, force: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class FsckRequest(fix: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class FsckResponse(fix: str = <object object at 0x7f2cabcb78b0>, error: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class GetFileRequest(file: 'File' = <object object at 0x7f2cabcb78b0>, url: str = <object object at 0x7f2cabcb78b0>, offset: int = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class GetFileSetRequest(commit: 'Commit' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class GlobFileRequest(commit: 'Commit' = <object object at 0x7f2cabcb78b0>, pattern: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class InspectBranchRequest(branch: 'Branch' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class InspectCommitRequest(commit: 'Commit' = <object object at 0x7f2cabcb78b0>, wait: 'CommitState' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class InspectCommitSetRequest(commit_set: 'CommitSet' = <object object at 0x7f2cabcb78b0>, wait: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class InspectFileRequest(file: 'File' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class InspectRepoRequest(repo: 'Repo' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ListBranchRequest(repo: 'Repo' = <object object at 0x7f2cabcb78b0>, reverse: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ListCommitRequest(repo: 'Repo' = <object object at 0x7f2cabcb78b0>, from_: 'Commit' = <object object at 0x7f2cabcb78b0>, to: 'Commit' = <object object at 0x7f2cabcb78b0>, number: int = <object object at 0x7f2cabcb78b0>, reverse: bool = <object object at 0x7f2cabcb78b0>, all: bool = <object object at 0x7f2cabcb78b0>, origin_kind: 'OriginKind' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ListCommitSetRequest[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ListFileRequest(file: 'File' = <object object at 0x7f2cabcb78b0>, details: bool = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ListRepoRequest(type: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ModifyFileRequest(set_commit: 'Commit' = <object object at 0x7f2cabcb78b0>, add_file: 'AddFile' = <object object at 0x7f2cabcb78b0>, delete_file: 'DeleteFile' = <object object at 0x7f2cabcb78b0>, copy_file: 'CopyFile' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class OriginKind(value)[source]: These are the different places where a commit may be originated from

class RenewFileSetRequest(file_set_id: str = <object object at 0x7f2cabcb78b0>, ttl_seconds: int = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class Repo(name: str = <object object at 0x7f2cabcb78b0>, type: str = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class RepoAuthInfo(permissions=<object object>, roles=<object object>)[source]

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)

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class RepoInfo(repo=<object object>, created=<object object>, size_bytes_upper_bound=<object object>, description=<object object>, branches=<object object>, auth_info=<object object>, details=<object object>)[source]

RepoInfo is the main data structure representing a Repo in etcd

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class RepoInfoDetails(size_bytes=<object object>)[source]

Details are only provided when explicitly requested

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class RunLoadTestRequest(spec: str = <object object at 0x7f2cabcb78b0>, branch: 'Branch' = <object object at 0x7f2cabcb78b0>, seed: int = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class RunLoadTestResponse(spec: str = <object object at 0x7f2cabcb78b0>, branch: 'Branch' = <object object at 0x7f2cabcb78b0>, seed: int = <object object at 0x7f2cabcb78b0>, error: str = <object object at 0x7f2cabcb78b0>, duration: datetime.timedelta = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class SquashCommitSetRequest(commit_set: 'CommitSet' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class StartCommitRequest(parent: 'Commit' = <object object at 0x7f2cabcb78b0>, description: str = <object object at 0x7f2cabcb78b0>, branch: 'Branch' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class SubscribeCommitRequest(repo: 'Repo' = <object object at 0x7f2cabcb78b0>, branch: str = <object object at 0x7f2cabcb78b0>, from_: 'Commit' = <object object at 0x7f2cabcb78b0>, state: 'CommitState' = <object object at 0x7f2cabcb78b0>, all: bool = <object object at 0x7f2cabcb78b0>, origin_kind: 'OriginKind' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class Trigger(branch=<object object>, all=<object object>, cron_spec=<object object>, size=<object object>, commits=<object object>)[source]

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

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class WalkFileRequest(file: 'File' = <object object at 0x7f2cabcb78b0>)[source]

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.