Struct pachyderm::pfs::api_client::ApiClient

pub struct ApiClient<T> { /* fields omitted */ }

Implementations

impl ApiClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> ApiClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

pub async fn create_repo<'_>(
    &'_ mut self,
    request: impl IntoRequest<CreateRepoRequest>
) -> Result<Response<()>, Status>

Repo rpcs CreateRepo creates a new repo. An error is returned if the repo already exists.

pub async fn inspect_repo<'_>(
    &'_ mut self,
    request: impl IntoRequest<InspectRepoRequest>
) -> Result<Response<RepoInfo>, Status>

InspectRepo returns info about a repo.

pub async fn list_repo<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListRepoRequest>
) -> Result<Response<ListRepoResponse>, Status>

ListRepo returns info about all repos.

pub async fn delete_repo<'_>(
    &'_ mut self,
    request: impl IntoRequest<DeleteRepoRequest>
) -> Result<Response<()>, Status>

DeleteRepo deletes a repo.

pub async fn start_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<StartCommitRequest>
) -> Result<Response<Commit>, Status>

Commit rpcs StartCommit creates a new write commit from a parent commit.

pub async fn finish_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<FinishCommitRequest>
) -> Result<Response<()>, Status>

FinishCommit turns a write commit into a read commit.

pub async fn inspect_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<InspectCommitRequest>
) -> Result<Response<CommitInfo>, Status>

InspectCommit returns the info about a commit.

pub async fn list_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListCommitRequest>
) -> Result<Response<CommitInfos>, Status>

ListCommit returns info about all commits. This is deprecated in favor of ListCommitStream.

pub async fn list_commit_stream<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListCommitRequest>
) -> Result<Response<Streaming<CommitInfo>>, Status>

ListCommitStream is like ListCommit, but returns its results in a GRPC stream

pub async fn delete_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<DeleteCommitRequest>
) -> Result<Response<()>, Status>

DeleteCommit deletes a commit.

pub async fn flush_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<FlushCommitRequest>
) -> Result<Response<Streaming<CommitInfo>>, Status>

FlushCommit waits for downstream commits to finish

pub async fn subscribe_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<SubscribeCommitRequest>
) -> Result<Response<Streaming<CommitInfo>>, Status>

SubscribeCommit subscribes for new commits on a given branch

pub async fn build_commit<'_>(
    &'_ mut self,
    request: impl IntoRequest<BuildCommitRequest>
) -> Result<Response<Commit>, Status>

BuildCommit builds a commit that's backed by the given tree

pub async fn create_branch<'_>(
    &'_ mut self,
    request: impl IntoRequest<CreateBranchRequest>
) -> Result<Response<()>, Status>

CreateBranch creates a new branch

pub async fn inspect_branch<'_>(
    &'_ mut self,
    request: impl IntoRequest<InspectBranchRequest>
) -> Result<Response<BranchInfo>, Status>

InspectBranch returns info about a branch.

pub async fn list_branch<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListBranchRequest>
) -> Result<Response<BranchInfos>, Status>

ListBranch returns info about the heads of branches.

pub async fn delete_branch<'_>(
    &'_ mut self,
    request: impl IntoRequest<DeleteBranchRequest>
) -> Result<Response<()>, Status>

DeleteBranch deletes a branch; note that the commits still exist.

pub async fn put_file<'_>(
    &'_ mut self,
    request: impl IntoStreamingRequest<Message = PutFileRequest>
) -> Result<Response<()>, Status>

File rpcs PutFile writes the specified file to pfs.

pub async fn copy_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<CopyFileRequest>
) -> Result<Response<()>, Status>

CopyFile copies the contents of one file to another.

pub async fn get_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<GetFileRequest>
) -> Result<Response<Streaming<Vec<u8>>>, Status>

GetFile returns a byte stream of the contents of the file.

pub async fn inspect_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<InspectFileRequest>
) -> Result<Response<FileInfo>, Status>

InspectFile returns info about a file.

pub async fn list_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListFileRequest>
) -> Result<Response<FileInfos>, Status>

ListFile returns info about all files. This is deprecated in favor of ListFileStream

pub async fn list_file_stream<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListFileRequest>
) -> Result<Response<Streaming<FileInfo>>, Status>

ListFileStream is a streaming version of ListFile TODO(msteffen): When the dash has been updated to use ListFileStream, replace ListFile with this RPC (https://github.com/pachyderm/dash/issues/201)

pub async fn walk_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<WalkFileRequest>
) -> Result<Response<Streaming<FileInfo>>, Status>

WalkFile walks over all the files under a directory, including children of children.

pub async fn glob_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<GlobFileRequest>
) -> Result<Response<FileInfos>, Status>

GlobFile returns info about all files. This is deprecated in favor of GlobFileStream

pub async fn glob_file_stream<'_>(
    &'_ mut self,
    request: impl IntoRequest<GlobFileRequest>
) -> Result<Response<Streaming<FileInfo>>, Status>

GlobFileStream is a streaming version of GlobFile TODO(msteffen): When the dash has been updated to use GlobFileStream, replace GlobFile with this RPC (https://github.com/pachyderm/dash/issues/201)

pub async fn diff_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<DiffFileRequest>
) -> Result<Response<DiffFileResponse>, Status>

DiffFile returns the differences between 2 paths at 2 commits.

pub async fn delete_file<'_>(
    &'_ mut self,
    request: impl IntoRequest<DeleteFileRequest>
) -> Result<Response<()>, Status>

DeleteFile deletes a file.

pub async fn delete_all<'_>(
    &'_ mut self,
    request: impl IntoRequest<()>
) -> Result<Response<()>, Status>

DeleteAll deletes everything

pub async fn fsck<'_>(
    &'_ mut self,
    request: impl IntoRequest<FsckRequest>
) -> Result<Response<Streaming<FsckResponse>>, Status>

Fsck does a file system consistency check for pfs

pub async fn file_operation_v2<'_>(
    &'_ mut self,
    request: impl IntoStreamingRequest<Message = FileOperationRequestV2>
) -> Result<Response<()>, Status>

RPCs specific to Pachyderm 2.

pub async fn get_tar_v2<'_>(
    &'_ mut self,
    request: impl IntoRequest<GetTarRequestV2>
) -> Result<Response<Streaming<Vec<u8>>>, Status>

pub async fn get_tar_conditional_v2<'_>(
    &'_ mut self,
    request: impl IntoStreamingRequest<Message = GetTarConditionalRequestV2>
) -> Result<Response<Streaming<GetTarConditionalResponseV2>>, Status>

Refer to the GetTarConditionalRequest / GetTarConditionalResponse message definitions for the protocol.

pub async fn list_file_v2<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListFileRequest>
) -> Result<Response<Streaming<FileInfoV2>>, Status>

pub async fn glob_file_v2<'_>(
    &'_ mut self,
    request: impl IntoRequest<GlobFileRequest>
) -> Result<Response<Streaming<FileInfoV2>>, Status>

Trait Implementations

impl<T: Clone> Clone for ApiClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for ApiClient<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.