package alluxio.grpc.file
Get desktop application:
View/edit binary Protocol Buffers messages
* This interface contains file system master service endpoints for Alluxio clients.
* Checks access to path.
message
file_system_master.proto:49optional string path = 1
optional options = 2
message
file_system_master.proto:54(message has no fields)
* Checks the consistency of the files and directores with the path as the root of the subtree
message
file_system_master.proto:66optional string path = 1
* the root of the subtree to check
optional options = 2
message
file_system_master.proto:60repeated string inconsistentPaths = 1
rpc Exists (, )
file_system_master.proto:753* Checks the existence of the file or directory.
message
file_system_master.proto:72optional string path = 1
optional options = 2
message
file_system_master.proto:76optional bool exists = 1
* Marks a file as completed.
message
file_system_master.proto:87optional string path = 1
* the path of the file
optional options = 2
message
file_system_master.proto:80(message has no fields)
* Creates a directory.
message
file_system_master.proto:125optional string path = 1
* the path of the directory
optional options = 2
message
file_system_master.proto:114(message has no fields)
* Creates a file.
message
file_system_master.proto:152optional string path = 1
* the path of the file
optional options = 2
message
file_system_master.proto:131optional fileInfo = 1
rpc Free (, )
file_system_master.proto:773* Frees the given file or directory from Alluxio.
message
file_system_master.proto:179optional string path = 1
* the path of the file or directory
optional options = 2
message
file_system_master.proto:173(message has no fields)
* Returns the file path of a file id
message
file_system_master.proto:405optional int64 fileId = 1
message
file_system_master.proto:402optional string path = 1
* Returns a map from each Alluxio path to information of corresponding mount point
message
file_system_master.proto:428optional bool checkUfs = 1
message
file_system_master.proto:425map<string, > mountPoints = 1
* Returns a list of paths that are being actively synced by Alluxio
message
file_system_master.proto:233(message has no fields)
message
file_system_master.proto:230repeated syncPaths = 1
* Generates a new block id for the given file.
message
file_system_master.proto:191optional string path = 1
* the path of the file
optional options = 2
message
file_system_master.proto:185optional int64 id = 1
* Returns the status of the file or directory.
message
file_system_master.proto:208optional string path = 1
* the path of the file or directory
optional options = 2
message
file_system_master.proto:197optional fileInfo = 1
rpc ListStatus (, stream )
file_system_master.proto:805* If the path points to a file, the method returns a singleton with its file information. If the path points to a directory, the method returns a list with file information for the directory contents.
message
file_system_master.proto:258optional string path = 1
* the path of the file or directory
optional options = 2
message
file_system_master.proto:235repeated fileInfos = 1
* If the path points to a file, the method returns a singleton with its file information. If the path points to a directory, the method returns a list with file information for the directory contents. This operation takes additional options for partial listing of files.
message
file_system_master.proto:263optional string path = 1
* the path of the file or directory
optional options = 2
message
file_system_master.proto:305repeated fileInfos = 1
optional bool isTruncated = 2
True if the partial listing was truncated.
optional int64 fileCount = 3
The total number of files in the listing directory, (i.e. the size of the result if partial listing was not used) or -1 if the listing was recursive.
rpc Mount (, )
file_system_master.proto:818* Creates a new "mount point", mounts the given UFS path in the Alluxio namespace at the given path. The path should not exist and should not be nested under any existing mount point.
message
file_system_master.proto:417optional string alluxioPath = 1
* the path of alluxio mount point
optional string ufsPath = 2
* the path of the under file system
optional options = 3
message
file_system_master.proto:409(message has no fields)
rpc Remove (, )
file_system_master.proto:823* Deletes a file or a directory and returns whether the remove operation succeeded.
message
file_system_master.proto:167optional string path = 1
* the path of the file or directory
optional options = 2
message
file_system_master.proto:158(message has no fields)
rpc Rename (, )
file_system_master.proto:828* Renames a file or a directory.
message
file_system_master.proto:472optional string path = 1
* the source path of the file or directory
optional string dstPath = 2
* the destination path
optional options = 3
message
file_system_master.proto:466(message has no fields)
* Reverse resolve a ufs path.
message
file_system_master.proto:480optional string ufsUri = 1
message
file_system_master.proto:483optional string alluxioPath = 1
* Schedules async persistence.
message
file_system_master.proto:539optional string path = 1
* the path of the file
optional options = 2
message
file_system_master.proto:534(message has no fields)
rpc SetAcl (, )
file_system_master.proto:843* Sets ACL for the path.
message
file_system_master.proto:523optional string path = 1
* the path of the file or directory
optional SetAclAction action = 2
* the set action to perform
repeated entries = 3
* the list of ACL entries
optional options = 4
* the method options
message
file_system_master.proto:518(message has no fields)
* Sets file or directory attributes.
message
file_system_master.proto:504optional string path = 1
* the path of the file
optional options = 2
message
file_system_master.proto:488(message has no fields)
* Start the active syncing of the directory or file
message
file_system_master.proto:549optional string path = 1
optional options = 2
message
file_system_master.proto:545(message has no fields)
rpc StopSync (, )
file_system_master.proto:858* Start the active syncing of the directory or file
message
file_system_master.proto:558optional string path = 1
optional options = 2
message
file_system_master.proto:554(message has no fields)
rpc Unmount (, )
file_system_master.proto:865* Deletes an existing "mount point", voiding the Alluxio namespace at the given path. The path should correspond to an existing mount point. Any files in its subtree that are backed by UFS will be persisted before they are removed from the Alluxio namespace.
message
file_system_master.proto:567optional string alluxioPath = 1
* the path of the alluxio mount point
optional options = 2
message
file_system_master.proto:563(message has no fields)
* Updates an existing "mount point", changing its mount properties
message
file_system_master.proto:584optional string alluxioPath = 1
* the path of alluxio mount point
optional options = 3
message
file_system_master.proto:589(message has no fields)
* Updates the ufs mode for a ufs path under one or more mount points.
message
file_system_master.proto:595optional string ufsPath = 1
* the ufs path
optional options = 2
message
file_system_master.proto:591(message has no fields)
message
file_system_master.proto:605optional options = 1
message
file_system_master.proto:601repeated string threads = 1
message
file_system_master.proto:609required string path = 1
message
file_system_master.proto:613(message has no fields)
* Load a directory into Alluxio.
message
file_system_master.proto:615optional bytes request_body = 1
message
file_system_master.proto:619optional string jobId = 1
rpc StopJob (, )
file_system_master.proto:886message
file_system_master.proto:636required jobDescription = 1
message
file_system_master.proto:640optional bool jobStopped = 1
message
file_system_master.proto:659required jobDescription = 1
optional options = 2
message
file_system_master.proto:664optional string progressReport = 1
optional JobProgressReportFormat format = 2
* Load metadata from up into Alluxio.
message
file_system_master.proto:705repeated task = 1
optional string debugInfo = 1000
message
file_system_master.proto:711optional bool submitted = 1
optional int64 taskGroupId = 2
repeated int64 taskIds = 3
message
file_system_master.proto:717optional int64 taskGroupId = 1
message
file_system_master.proto:721repeated task = 1
optional string debugInfo = 1000
message
file_system_master.proto:727optional int64 taskGroupId = 1
message
file_system_master.proto:731optional bool success = 1
* This interface contains file system master service endpoints for Alluxio workers.
Returns the file information for a file or directory identified by the given file id.
* Returns the UFS information for the given mount point identified by its id.
* This interface contains file system master service endpoints for Alluxio workers.
* Periodic file system worker heartbeat. Returns the command for persisting the blocks of a file.
message
file_system_master.proto:905optional int64 workerId = 1
* the id of the worker
repeated int64 persistedFiles = 2
* the list of persisted files
optional options = 3
message
file_system_master.proto:899optional command = 1
Returns the file information for a file or directory identified by the given file id.
* Returns the set of pinned file ids.
message
file_system_master.proto:928optional options = 1
message
file_system_master.proto:923repeated int64 pinnedFileIds = 1
TODO(adit): set replacement?
* Returns the UFS information for the given mount point identified by its id.
message
file_system_master.proto:55Used in:
optional Bits bits = 1
optional commonOptions = 2
message
file_system_master.proto:63Used in:
optional commonOptions = 1
message
file_system_master.proto:81Used in:
optional int64 ufsLength = 1
optional asyncPersistOptions = 2
optional commonOptions = 3
optional string contentHash = 4
message
file_system_master.proto:629optional int64 bandwidth = 1
optional bool verify = 2
optional bool partialListing = 3
optional bool overwrite = 4
message
file_system_master.proto:115Used in:
optional bool recursive = 1
optional bool allowExists = 2
optional mode = 3
optional WritePType writeType = 4
optional commonOptions = 5
map<string, bytes> xattr = 6
optional XAttrPropagationStrategy xattrPropStrat = 7
optional bool checkS3BucketPath = 8
message
file_system_master.proto:134Used in:
optional int64 blockSizeBytes = 1
optional bool recursive = 2
optional mode = 3
optional int32 replicationMax = 4
optional int32 replicationMin = 5
optional int32 replicationDurable = 6
optional int32 writeTier = 7
optional WritePType writeType = 8
optional commonOptions = 9
optional int64 persistenceWaitTime = 10
map<string, bytes> xattr = 11
optional XAttrPropagationStrategy xattrPropStrat = 12
optional bool overwrite = 13
optional bool checkS3BucketPath = 14
optional workerLocation = 15
If specified, the data will be written to the certain worker
message
file_system_master.proto:159Used in:
optional bool recursive = 1
optional bool alluxioOnly = 2
optional bool unchecked = 3
optional commonOptions = 4
optional bool syncParentNextTime = 5
optional bool deleteMountPoint = 6
message
file_system_master.proto:214Used in:
optional LoadMetadataPType loadMetadataType = 1
optional commonOptions = 2
message
file_system_master.proto:359* Contains the information of a block in a file. In addition to the BlockInfo, it includes the offset in the file, and the under file system locations of the block replicas.
Used in:
optional blockInfo = 1
optional int64 offset = 2
repeated ufsLocations = 3
deprecated since 1.1 will be removed in 2.0 (replaced by ufsStringLocations)
repeated string ufsStringLocations = 4
message
file_system_master.proto:366Used in: , , , ,
optional int64 fileId = 1
optional string name = 2
optional string path = 3
optional string ufsPath = 4
optional int64 length = 5
optional int64 blockSizeBytes = 6
optional int64 creationTimeMs = 7
optional bool completed = 8
optional bool folder = 9
optional bool pinned = 10
optional bool cacheable = 11
optional bool persisted = 12
repeated int64 blockIds = 13
optional int64 lastModificationTimeMs = 14
optional int64 ttl = 15
optional string owner = 16
optional string group = 17
optional int32 mode = 18
optional string persistenceState = 19
optional bool mountPoint = 20
repeated fileBlockInfos = 21
optional TtlAction ttlAction = 22
optional int64 mountId = 23
optional int32 inAlluxioPercentage = 24
optional int32 inMemoryPercentage = 25
optional string ufsFingerprint = 26
optional acl = 27
optional defaultAcl = 28
optional int32 replicationMax = 29
optional int32 replicationMin = 30
optional int64 lastAccessTimeMs = 31
map<string, bytes> xattr = 32
repeated string mediumType = 33
message
file_system_master.proto:456Used in:
optional CommandType commandType = 1
optional commandOptions = 2
message
file_system_master.proto:443Used in:
optional persistOptions = 1
message
file_system_master.proto:902Used in:
repeated string persistedFileFingerprints = 1
message
file_system_master.proto:42Used in: , , , , , , , , , , , , , , , , , , , ,
optional int64 syncIntervalMs = 1
optional int64 ttl = 2
optional TtlAction ttlAction = 3
optional operationId = 4
message
file_system_master.proto:174Used in:
optional bool recursive = 1
optional bool forced = 2
optional commonOptions = 3
message
file_system_master.proto:37* Unique operation id.
Used in:
optional int64 mostSignificantBits = 1
optional int64 leastSignificantBits = 2
message
file_system_master.proto:916Used in:
(message has no fields)
message
file_system_master.proto:917Used as request type in: FileSystemMasterJobService.GetFileInfo, FileSystemMasterWorkerService.GetFileInfo
optional int64 fileId = 1
* the id of the file
optional options = 2
message
file_system_master.proto:913Used as response type in: FileSystemMasterJobService.GetFileInfo, FileSystemMasterWorkerService.GetFileInfo
optional fileInfo = 1
message
file_system_master.proto:188Used in:
optional commonOptions = 1
message
file_system_master.proto:927Used in:
(message has no fields)
message
file_system_master.proto:604Used in:
(message has no fields)
message
file_system_master.proto:200Used in:
optional LoadMetadataPType loadMetadataType = 1
optional commonOptions = 2
optional Bits accessMode = 3
optional bool updateTimestamps = 4
optional bool includeRealContentHash = 5
optional bool directUfsAccess = 6
message
file_system_master.proto:935Used in:
(message has no fields)
message
file_system_master.proto:936Used as request type in: FileSystemMasterJobService.GetUfsInfo, FileSystemMasterWorkerService.GetUfsInfo
optional int64 mountId = 1
* the id of the ufs
optional options = 2
message
file_system_master.proto:932Used as response type in: FileSystemMasterJobService.GetUfsInfo, FileSystemMasterWorkerService.GetUfsInfo
optional ufsInfo = 1
message
file_system_master.proto:649Used in: ,
required string type = 1
optional string path = 2
message
file_system_master.proto:654Used in:
optional JobProgressReportFormat format = 1
optional bool verbose = 2
Used in: ,
TEXT = 1
JSON = 2
message
file_system_master.proto:238Used in: ,
optional bool loadDirectChildren = 1
This is deprecated since 1.1.1 and will be removed in 2.0. Use loadMetadataType.
optional LoadMetadataPType loadMetadataType = 2
optional commonOptions = 3
optional bool recursive = 4
optional bool loadMetadataOnly = 5
No data will be transferred.
optional bool disableAreDescendantsLoadedCheck = 6
Setting this to true will disable checking during metadata sync to see if the children of a directory has been loaded. This will avoid a costly full traversal of the file system during recursive listings, but may result in the children of directories not being loaded. It is recommended to set this to true after the first call of a recursive partial listing.
optional bool excludeMountInfo = 7
Mount info will be excluded from the list status response if this field is set to true. Resolving a path and obtain the mount info is an expensive operation. For clients that do not need this information such as hadoop-compatible clients, excluding mount info improves the endpoint performance.
message
file_system_master.proto:268Used in:
optional options = 1
oneof OffsetType
An offset type can be chosen as from where to start the listing. If none are set the listing will start from the beginning.
int64 offsetId = 2
Start listing after the given FileId, the FileId can be calculated from the result of a previous listing's FileInfo or URIStatus results using the getFileId method. If the file with the given ID has been moved or deleted then the call will return an error.
string startAfter = 3
Start the listing after this path. If startAfter starts with "/", then it is expected that the path given in the ListStatusPartialPRequest is a prefix of startAfter (e.g. if listing "/dir", then startAfter could be "/dir/next"). Otherwise if start after does not start with "/", then startAfter is appended to the path given in the ListStatusPartialPRequest (e.g. if the listing path is "/dir" and startAfter is "after" then files that start after "/dir/after" in lexicographic order will be listed). The full path itself does not need to exist. This offset type is recommended to use if POSIX compatible listings are needed.
int32 offsetCount = 4
Only start listing items after this many items have been processed. This will count from the start of the listing up to offsetCont before listing items. This can be useful for example to show individual pages in a UI. Note that this listing type may be more expensive than the others as it must traverse offsetCount items, while the others reach the listing point by querying a skip list.
optional int32 batchSize = 5
Batch size for partial listings.
optional string prefix = 6
Only match files with a given prefix. The prefix starts after the given listing path (e.g. if "/dir" is being listed and prefix is "/pre", then any file with path having a prefix of "/dir/pre" will be listed).
message
file_system_master.proto:623optional int64 bandwidth = 1
optional bool verify = 2
optional bool partialListing = 3
message
file_system_master.proto:315optional bool recursive = 1
* whether to load metadata recursively
optional bool createAncestors = 2
optional fscommon.LoadDescendantPType loadDescendantType = 3
optional commonOptions = 4
optional LoadMetadataPType loadType = 5
Used in: , , ,
NEVER = 0
Never load metadata.
ONCE = 1
Load metadata only once.
ALWAYS = 2
Always load metadata.
message
file_system_master.proto:410Used in: , ,
optional bool readOnly = 1
map<string, string> properties = 2
optional bool shared = 3
optional commonOptions = 4
optional bool remount = 5
message
file_system_master.proto:432Used in:
optional string ufsUri = 1
optional string ufsType = 2
optional int64 ufsCapacityBytes = 3
optional int64 ufsUsedBytes = 4
optional bool readOnly = 5
map<string, string> properties = 6
optional bool shared = 7
optional int64 mountId = 8
message
file_system_master.proto:93optional ReadPType readType = 1
optional int32 maxUfsReadConcurrency = 2
optional commonOptions = 3
optional bool updateLastAccessTime = 4
optional ufsReadWorkerLocation = 15
If specified and the blocks are not cached in any worker, the data will be read and cached to the certain worker. If the blocks have been cached in some alluxio workers, this field will be ignored.
message
file_system_master.proto:346Used in:
optional string owner = 1
optional string owningGroup = 2
repeated entries = 3
optional int32 mode = 4
optional bool isDefault = 5
optional bool isDefaultEmpty = 6
Used in:
Read = 0
Write = 1
Execute = 2
message
file_system_master.proto:339Used in: ,
optional PAclEntryType type = 1
optional string subject = 2
repeated PAclAction actions = 3
optional bool isDefault = 4
Used in:
Owner = 0
NamedUser = 1
OwningGroup = 2
NamedGroup = 3
Mask = 4
Other = 5
message
file_system_master.proto:447Used in:
repeated persistFiles = 1
message
file_system_master.proto:451Used in:
optional int64 fileId = 1
repeated int64 blockIds = 2
Used in:
NO_CACHE = 1
CACHE = 2
CACHE_PROMOTE = 3
message
file_system_master.proto:467Used in:
optional commonOptions = 1
optional bool persist = 2
optional s3SyntaxOptions = 3
message
file_system_master.proto:461Used in:
optional bool overwrite = 1
optional bool isMultipartUpload = 2
message
file_system_master.proto:535Used in: ,
optional commonOptions = 1
optional int64 persistenceWaitTime = 2
Used in:
REPLACE = 0
MODIFY = 1
REMOVE = 2
REMOVE_ALL = 3
REMOVE_DEFAULT = 4
message
file_system_master.proto:519Used in:
optional commonOptions = 1
optional bool recursive = 2
message
file_system_master.proto:489Used in:
optional bool pinned = 1
optional bool persisted = 2
optional string owner = 3
optional string group = 4
optional mode = 5
optional bool recursive = 6
optional int32 replicationMax = 7
optional int32 replicationMin = 8
optional commonOptions = 9
repeated string pinnedMedia = 10
map<string, bytes> xattr = 11
optional proto.journal.XAttrUpdateStrategy xattrUpdateStrategy = 12
optional bool directChildrenLoaded = 13
message
file_system_master.proto:546Used in:
optional commonOptions = 1
message
file_system_master.proto:555Used in:
optional commonOptions = 1
message
file_system_master.proto:669Used in:
optional fscommon.LoadDescendantPType loadDescendantType = 1
optional fscommon.DirectoryLoadPType directoryLoadType = 2
message
file_system_master.proto:674Used as request type in: FileSystemMasterClientService.SyncMetadata, FileSystemMasterClientService.SyncMetadataAsync
required string path = 1
optional options = 2
Used in:
UNKNOWN = 0
RUNNING = 1
SUCCEEDED = 2
FAILED = 3
CANCELED = 4
message
file_system_master.proto:687Used in: ,
optional int64 id = 1
optional SyncMetadataState state = 2
optional int64 syncDurationMs = 3
optional exception = 4
optional int64 successOpCount = 5
optional string taskInfoString = 100
optional string taskStatString = 101
message
file_system_master.proto:688Used in:
optional string exceptionType = 1
optional string exceptionMessage = 2
optional string stacktrace = 3
message
file_system_master.proto:225Used in:
optional string syncPointUri = 1
optional SyncPointStatus syncStatus = 2
Used in:
Not_Initially_Synced = 0
Syncing = 1
Initially_Synced = 2
message
file_system_master.proto:573Used in:
optional string uri = 1
optional properties = 2
Used in:
NO_ACCESS = 1
READ_ONLY = 2
READ_WRITE = 3
message
file_system_master.proto:564Used in:
optional commonOptions = 1
message
file_system_master.proto:592Used in:
optional UfsPMode ufsMode = 1
Used in: ,
MUST_CACHE = 1
TRY_CACHE = 2
CACHE_THROUGH = 3
THROUGH = 4
ASYNC_THROUGH = 5
NONE = 6
XAttrPropagationStrategy controls the behaviour for assigning xAttr on Inodes within nested directories - NEW_PATHS: Assign xAttr for any missing nodes along the filepath - LEAF_NODE: Only assign xAttr on the leaf node of the filepath
Used in: ,
NEW_PATHS = 1
LEAF_NODE = 2