package LocalFile

Get desktop application:
View/edit binary Protocol Buffers messages

The LocalFile service definition.

• rpc Read (ReadActionRequest, stream ReadReply)

  localfile.proto:29

  Read reads a file from the disk and returns it contents.

  message ReadActionRequest

  localfile.proto:85

  ReadActionRequest indicates the type of read we're performing. Either a file read which then terminates or a tail based read that continues forever (i.e. as tail -f on the command line would do).

  • oneof request

    • ReadRequest file = 1

    • TailRequest tail = 2

  • string grep = 3

  • bool ignore_case = 4

  • bool invert_match = 5

  message ReadReply

  localfile.proto:115

  ReadResponse contains the contents of the file

  • bytes contents = 1

• rpc Stat (stream StatRequest, stream StatReply)

  localfile.proto:32

  Stat returns metadata about a filesystem path.

  message StatRequest

  localfile.proto:118

  StatRequest specifies the filename for which to retrieve metadata.

  • string filename = 1

    absolute path to the target file

  • bool follow_links = 2

    If true, use stat instead of lstat so that symlinks are followed

• rpc Sum (stream SumRequest, stream SumReply)

  localfile.proto:35

  Sum calculates a sum over the data in a single file.

  message SumRequest

  localfile.proto:160

  SumRequest specifies a type and filename for a sum operation.

  • string filename = 1

    Absoloute path to the target file.

  • SumType sum_type = 2

    The requested sum type. If not set, or SUM_TYPE_UNKNOWN, an implementation-default value will be chosen automatically, and indicated in the reply.

  message SumReply

  localfile.proto:170

  SumReply contains the sum output for the given filename.

  • string filename = 1

    Filename, as provided in SumRequest

  • SumType sum_type = 2

    The type of sum used to calculate `sum`

  • string sum = 3

    The sum value, as a hex-encoded string

• rpc Write (stream WriteRequest, google.protobuf.Empty)

  localfile.proto:38

  Write writes a file from the incoming RPC to a local file.

  message WriteRequest

  localfile.proto:218

  WriteRequest streams the data for the filename to be written. The first request must contain a description and all future requests must contain contents. Each write request will append contents into the file until the stream is closed. Then the file is moved to it's final location.

  • oneof request

    • FileWrite description = 1

    • bytes contents = 2

• rpc Copy (CopyRequest, google.protobuf.Empty)

  localfile.proto:42

  Copy retrieves a file from the given blob URL and writes it to a local file.

  message CopyRequest

  localfile.proto:227

  CopyRequest contains the URL and filename destination to copy the file from.

  • optional FileWrite destination = 1

  • string bucket = 2

    The source bucket to copy from. See implementations for details on schemes but will at a minimum support file://<path> for local copies.

  • string key = 3

    The key to reference inside of the bucket.

  • bytes blob_data = 4

    Any additional data the URL destination may need in order to succeed (such as an auth token for a blob service).

• rpc List (ListRequest, stream ListReply)

  localfile.proto:45

  List returns StatReply entries for the entities contained at a given path.

  message ListRequest

  localfile.proto:241

  ListRequest will do an expansion on the entry given to list all things located there. If entry is a file only that data will be returned.

  • string entry = 1

    The entry to list.

  message ListReply

  localfile.proto:248

  ListReply will begin with the entry followed by N entries (if a directory) until that level of the tree is exhausted.

  • optional StatReply entry = 1

• rpc SetFileAttributes (SetFileAttributesRequest, google.protobuf.Empty)

  localfile.proto:48

  SetFileAttributes takes a given filename and sets the given attributes.

  message SetFileAttributesRequest

  localfile.proto:254

  SetFileAttributesRequest processes attrs and attempts to set the path given to those attributes. As this is N steps (owner, group, permissions, etc) it is not transactional and can leave an entity in a partial state if errors occur.

  • optional FileAttributes attrs = 1

• rpc Rm (RmRequest, google.protobuf.Empty)

  localfile.proto:52

  Rm removes the given file.

  message RmRequest

  localfile.proto:256

  • string filename = 1

    The fully qualified path to the file to remove.

• rpc Rmdir (RmdirRequest, google.protobuf.Empty)

  localfile.proto:55

  Rmdir removes the given directory (must be empty).

  message RmdirRequest

  localfile.proto:261

  • string directory = 1

    The fully qualified path to the directory to remove. Must be empty of any entries.

• rpc Rename (RenameRequest, google.protobuf.Empty)

  localfile.proto:61

  Rename renames (moves) the given file to a new name. If the destination is not a directory it will be replaced if it already exists. OS restrictions may apply if the old and new names are outside of the same directory.

  message RenameRequest

  localfile.proto:267

  • string original_name = 1

  • string destination_name = 2

• rpc Readlink (ReadlinkRequest, ReadlinkReply)

  localfile.proto:64

  Readlink prints the value of a symbolic link

  message ReadlinkRequest

  localfile.proto:272

  • string filename = 1

    The fully qualified path to the file to readlink.

  message ReadlinkReply

  localfile.proto:277

  • string linkvalue = 1

    The resolved link.

• rpc Symlink (SymlinkRequest, google.protobuf.Empty)

  localfile.proto:67

  Symlink creates a symbolic link

  message SymlinkRequest

  localfile.proto:282

  • string target = 1

  • string linkname = 2

• rpc Mkdir (MkdirRequest, google.protobuf.Empty)

  localfile.proto:70

  Mkdir create a new directory.

  message MkdirRequest

  localfile.proto:288

  MkdirRequest describes the directory

  • optional FileAttributes dir_attrs = 1

• rpc DataGet (DataGetRequest, DataGetReply)

  localfile.proto:73

  Get data from a file of specified type by provided key

  message DataGetRequest

  localfile.proto:300

  DataGetRequest is request to read data from a specific file in specific format

  • string filename = 1

  • FileFormat file_format = 2

  • string data_key = 3

  message DataGetReply

  localfile.proto:307

  DataGetReply contains the value of read from file

  • string value = 1

• rpc DataSet (DataSetRequest, google.protobuf.Empty)

  localfile.proto:76

  Set data value to a file of specified type by provided key

  message DataSetRequest

  localfile.proto:319

  DataSetRequest is request to set property in a specific file in specific format

  • string filename = 1

  • FileFormat file_format = 2

  • string data_key = 3

  • string value = 4

  • DataSetValueType value_type = 5

• rpc Shred (ShredRequest, google.protobuf.Empty)

  localfile.proto:79

  Perform Shred on a single file

  message ShredRequest

  localfile.proto:328

  ShredRequest is a request to perform Shred operation on a specific file

  • string filename = 1

    absolute path to the file to be shredded

  • bool force = 2

    force permissions change if necessary

  • bool zero = 3

    add final zero-ing pass to mask presence of shredding

  • bool remove = 4

    remove file after shredding

DataSetValueType enum what represents how represent value in a file

Used in: DataSetRequest

• UNKNOWN_VAL = 0

• STRING_VAL = 1

• INT_VAL = 2

• FLOAT_VAL = 3

• BOOL_VAL = 4

FileAttributes describes a file/directory and an attributed of it. It's used together with repeated fields and a path to describe an entire entity.

Used in: FileAttributes

• oneof value

  • uint32 uid = 1

  • string username = 5

    Use in place of uid and server will lookup.

  • uint32 gid = 2

  • string group = 6

    Use in place of gid and server will lookup.

  • uint32 mode = 3

    Only the lower 12 bits are used per unix conventions.

  • bool immutable = 4

FileAttributes describes everything about a given file/directory.

Used in: FileWrite, MkdirRequest, SetFileAttributesRequest

• string filename = 1

• repeated FileAttribute attributes = 2

  A given attributes (uid, gid, etc) can only be set once.

FileFormat enum what represents file formats

Used in: DataGetRequest, DataSetRequest

• UNKNOWN = 0

• YML = 1

• DOTENV = 2

FileWrite describes everything about a file to be written.

Used in: CopyRequest, WriteRequest

• optional FileAttributes attrs = 1

  For a newly written file uid/gid/mode are required attributes while immutable is optional.

• bool overwrite = 2

  If true allow to truncate and overwrite an existing file. Otherwise the file must not exist. This is still subject to races as all incoming data is written to a tempfile before moved to the final destination so multiple system calls will take place.

ReadRequest describes the filename to be read

Used in: ReadActionRequest

• string filename = 1

• int64 offset = 2

  If non-zero skip N bytes into the file before returning data. Negative implies based from end of file.

• int64 length = 3

  If positive and non-zero return only this many total bytes.

StatReply contains stat information for a single file.

Used as response type in: LocalFile.Stat

Used as field type in: ListReply

• string filename = 1

  The file path, as provided in StatRequest

• int64 size = 2

  size of the file, in bytes

• uint32 mode = 3

  NB: the file mode here is represented using Go's fs.FileMode scheme which combines permissions with additional data such as the type (directory, symlink, etc)

• optional google.protobuf.Timestamp modtime = 4

  File modification time

• uint32 uid = 5

  UID of owner

• uint32 gid = 6

  GID of owner

• bool immutable = 7

  Whether the immutable flag is set. This only applies to systems which support immutable file bits. For systems which support multiple types (OS/X) this refers only to system level immutability and not user. i.e. even root is unable to modify these files.

SumType specifies a hashing function to use when calculating file sums.

Used in: SumReply, SumRequest

• SUM_TYPE_UNKNOWN = 0

• SUM_TYPE_CRC32IEEE = 1

• SUM_TYPE_MD5 = 2

• SUM_TYPE_SHA256 = 3

• SUM_TYPE_SHA512_256 = 4

TailRequest describes the filename to be tailed.

Used in: ReadActionRequest

• string filename = 1

• int64 offset = 2

  If non-zero skip N bytes into the file before returning data. Negative implies based from end of file.