package alluxio.grpc.block
Get desktop application:
View/edit binary Protocol Buffers messages
* This interface contains block master service endpoints for Alluxio clients.
rpc GetBlockInfo (, )
block_master.proto:140* Returns the block information for the given block id.
message
block_master.proto:34optional int64 blockId = 1
* the id of the block
optional options = 2
message
block_master.proto:40optional blockInfo = 1
* Returns block master information.
message
block_master.proto:49repeated BlockMasterInfoField filters = 1
message
block_master.proto:52optional blockMasterInfo = 1
* Returns the capacity (in bytes).
message
block_master.proto:44(message has no fields)
message
block_master.proto:45optional int64 bytes = 1
rpc GetUsedBytes (, )
block_master.proto:155* Returns the used storage (in bytes).
message
block_master.proto:56(message has no fields)
message
block_master.proto:57optional int64 bytes = 1
* Returns a list of workers information.
message
block_master.proto:104(message has no fields)
* If target worker is in the decommissioned worker set, return true, remove target worker from decommissioned worker set; else, return false.
message
block_master.proto:114required string workerHostname = 1
optional int64 workerWebPort = 2
message
block_master.proto:118(message has no fields)
* Returns a list of workers information for report CLI.
message
block_master.proto:98repeated string addresses = 1
* addresses are only valid when workerRange is SPECIFIED
repeated WorkerInfoField fieldRanges = 2
optional WorkerRange workerRange = 3
* Returns a list of worker lost storage information
message
block_master.proto:120(message has no fields)
message
block_master.proto:121repeated workerLostStorageInfo = 1
* Decommission the specific worker from Alluxio.
message
block_master.proto:126required string workerHostname = 1
optional int64 workerWebPort = 2
optional bool canRegisterAgain = 3
message
block_master.proto:125(message has no fields)
* This interface contains block master service endpoints for Alluxio workers.
rpc BlockHeartbeat (, )
block_master.proto:324* Periodic block worker heartbeat returns an optional command for the block worker to execute.
message
block_master.proto:210optional int64 workerId = 1
* the id of the worker
map<string, int64> usedBytesOnTiers = 2
* the map of space used in bytes on all tiers
repeated int64 removedBlockIds = 3
* the list of removed block ids
map<string, > addedBlocksOnTiers = 4
* the map of added blocks on all tiers (deprecated since 2.0, replaced by addedBlocks)
optional options = 5
map<string, > lostStorage = 6
* the map of lost storage paths on all tiers
repeated addedBlocks = 7
* use repeated fields to represent mapping from BlockStoreLocationProto to TierList
message
block_master.proto:226optional command = 1
rpc CommitBlock (, )
block_master.proto:329* Marks the given block as committed.
message
block_master.proto:231optional int64 workerId = 1
* the id of the worker
optional int64 usedBytesOnTier = 2
* the space used in bytes on the target tier
optional string tierAlias = 3
* the alias of the target tier
optional int64 blockId = 4
* the id of the block being committed
optional int64 length = 5
* the length of the block being committed
optional options = 6
optional string mediumType = 7
message
block_master.proto:230(message has no fields)
* Marks the given block as committed which resides in UFS.
message
block_master.proto:247optional int64 blockId = 1
* the id of the worker
optional int64 length = 2
* the space used in bytes on the target tier
optional options = 3
message
block_master.proto:256(message has no fields)
rpc GetWorkerId (, )
block_master.proto:339* Returns a worker id for the given network address.
message
block_master.proto:269optional workerNetAddress = 1
* the worker network address
optional options = 2
message
block_master.proto:274optional int64 workerId = 1
rpc NotifyWorkerId (, )
block_master.proto:344* Notify all masters about the worker ID.
message
block_master.proto:259optional int64 workerId = 1
optional workerNetAddress = 2
* the worker network address
optional options = 3
message
block_master.proto:265(message has no fields)
rpc RegisterWorker (, )
block_master.proto:349* Registers a worker.
rpc RegisterWorkerStream (stream , stream )
block_master.proto:354* Registers a worker in a streaming way
* Requests a lease for registration
message
block_master.proto:278optional int64 workerId = 1
optional int64 blockCount = 2
* This may not accurate because the worker can add/delete blocks before sending the RegisterWorkerPRequest
message
block_master.proto:284optional int64 workerId = 1
optional bool allowed = 2
optional int64 expiryMs = 3
optional options = 4
service BlockWorker
block_worker.proto:13The block worker service
rpc ReadBlock (stream , stream )
block_worker.proto:14message
block_worker.proto:57The read request. next available id: 9
optional int64 block_id = 1
optional int64 offset = 2
optional int64 length = 3
optional bool promote = 4
Whether the block should be promoted before reading
optional int64 chunk_size = 5
optional open_ufs_block_options = 6
This is only set for UFS block read.
optional int64 offset_received = 7
Read receipt
optional bool position_short = 8
Is position read to a small buffer
message
block_worker.proto:77The read response. next available id: 2
optional chunk = 1
rpc WriteBlock (stream , stream )
block_worker.proto:15message
block_worker.proto:101The write request. next available id: 3
oneof value
command = 1
chunk = 2
message
block_worker.proto:110The write response. next available id: 3
optional int64 offset = 1
optional string contentHash = 2
Errors will be handled by standard gRPC stream APIs.
rpc OpenLocalBlock (stream , stream )
block_worker.proto:18Replaces ShortCircuitBlockReadHandler.
message
block_worker.proto:199next available id: 3
optional int64 block_id = 1
optional bool promote = 2
message
block_worker.proto:205next available id: 2
optional string path = 1
rpc CreateLocalBlock (stream , stream )
block_worker.proto:21Replaces ShortCircuitBlockWriteHandler.
message
block_worker.proto:210next available id: 9
optional int64 block_id = 1
optional int32 tier = 3
optional int64 space_to_reserve = 4
optional bool only_reserve_space = 5
If set, only reserve space for the block.
optional bool cleanup_on_failure = 6
optional string medium_type = 7
optional bool pin_on_create = 8
message
block_worker.proto:222next available id: 2
optional string path = 1
rpc AsyncCache (, )
block_worker.proto:22message
block_worker.proto:118Request for caching a block asynchronously Deprecated and will be removed in v3.0
optional int64 block_id = 1
optional string source_host = 2
TODO(calvin): source host and port should be replace with WorkerNetAddress
optional int32 source_port = 3
optional open_ufs_block_options = 4
optional int64 length = 5
message
block_worker.proto:193Response for an async cache request
(message has no fields)
rpc Cache (, )
block_worker.proto:23message
block_worker.proto:129Request for caching a block synchronously/asynchronously next available id: 7
optional int64 block_id = 1
optional string source_host = 2
TODO(calvin): source host and port should be replace with WorkerNetAddress
optional int32 source_port = 3
optional open_ufs_block_options = 4
optional int64 length = 5
optional bool async = 6
message
block_worker.proto:196Response for an async cache request
(message has no fields)
rpc Load (, )
block_worker.proto:24message
block_worker.proto:141Request for load a block into alluxio next available id: 3
repeated blocks = 1
required options = 2
message
block_worker.proto:168required TaskStatus status = 1
repeated block_status = 2
rpc RemoveBlock (, )
block_worker.proto:25message
block_worker.proto:227next available id: 2
optional int64 block_id = 1
message
block_worker.proto:231(message has no fields)
rpc MoveBlock (, )
block_worker.proto:26message
block_worker.proto:233optional int64 block_id = 1
optional string medium_type = 2
message
block_worker.proto:238(message has no fields)
message
block_worker.proto:244repeated int64 block_ids = 1
message
block_worker.proto:253map<int64, > checksum = 1
rpc ClearMetrics (, )
block_worker.proto:30TODO(lu) Move to metrics worker
message
block_worker.proto:240(message has no fields)
message
block_worker.proto:242(message has no fields)
rpc FreeWorker (, )
block_worker.proto:32message
block_worker.proto:179(message has no fields)
message
block_worker.proto:181(message has no fields)
message
block_worker.proto:158Used in: ,
required int64 block_id = 1
required int64 length = 2
The block length.
optional string ufs_path = 3
optional int64 offset_in_file = 4
The offset of the block in within ufs the file.
optional int64 mountId = 5
message
block_worker.proto:247Used in:
optional int64 block_id = 1
optional int64 block_length = 2
optional string checksum = 3
message
block_master.proto:200Used in:
repeated metrics = 1
map<string, int64> capacityBytesOnTiers = 2
message
block_master.proto:189Used in:
repeated int64 blockId = 1
message
block_master.proto:22Used in:
optional int64 capacityBytes = 1
map<string, int64> capacityBytesOnTiers = 2
optional int64 freeBytes = 3
optional int32 liveWorkerNum = 4
optional int32 lostWorkerNum = 5
optional int64 usedBytes = 6
map<string, int64> usedBytesOnTiers = 7
optional int32 decommissionedWorkerNum = 8
Used in:
CAPACITY_BYTES = 1
CAPACITY_BYTES_ON_TIERS = 2
FREE_BYTES = 3
LIVE_WORKER_NUM = 4
LOST_WORKER_NUM = 5
USED_BYTES = 6
USED_BYTES_ON_TIERS = 7
DECOMMISSIONED_WORKER_NUM = 8
message
block_worker.proto:183Used in:
required block = 1
required int32 code = 2
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
optional string message = 3
A developer-facing error message
optional bool retryable = 4
message
block_worker.proto:36The check request
(message has no fields)
message
block_worker.proto:39The check response
(message has no fields)
message
block_worker.proto:43The data chunk. next available id: 2
Used in: ,
optional bytes data = 1
message
block_master.proto:255Used in:
(message has no fields)
message
block_master.proto:246Used in:
(message has no fields)
message
block_master.proto:33Used in:
(message has no fields)
message
block_master.proto:283Used in:
(message has no fields)
message
block_master.proto:268Used in:
(message has no fields)
message
block_master.proto:105Used as response type in: BlockMasterClientService.GetWorkerInfoList, BlockMasterClientService.GetWorkerReport
repeated workerInfos = 1
message
block_master.proto:205Used in: ,
optional key = 1
optional value = 2
message
block_master.proto:258Used in:
(message has no fields)
message
block_master.proto:291Used in:
repeated configs = 1
optional buildVersion = 2
* the worker version to display in info pages (useful for rolling upgrades)
optional int32 numVCpu = 3
message
block_master.proto:297Used as request type in: BlockMasterWorkerService.RegisterWorker, BlockMasterWorkerService.RegisterWorkerStream
optional int64 workerId = 1
* the id of the worker
repeated string storageTiers = 2
* the list of storage tiers
map<string, int64> totalBytesOnTiers = 3
* the map of total bytes on each tier
map<string, int64> usedBytesOnTiers = 4
* the map of used bytes on each tier
map<string, > currentBlocksOnTiers = 5
* the map of list of blocks on each tier (deprecated since 2.0, replaced by currentBlocks
optional options = 6
map<string, > lostStorage = 7
* the map of tier alias to a list of lost storage paths.
repeated currentBlocks = 8
* use repeated fields to represent mapping from BlockStoreLocationProto to TierList
message
block_master.proto:314Used as response type in: BlockMasterWorkerService.RegisterWorker, BlockMasterWorkerService.RegisterWorkerStream
(message has no fields)
The read/write request type. It can either be an Alluxio block operation or a UFS file operation. next available id: 3
Used in:
ALLUXIO_BLOCK = 0
UFS_FILE = 1
UFS_FALLBACK_BLOCK = 2
message
block_master.proto:195* A list of lost storage paths inside a worker
Used in: , ,
repeated string storage = 1
* a lost storage path
Used in:
SUCCESS = 0
FAILURE = 1
PARTIAL_FAILURE = 2
message
block_master.proto:185Used in: ,
repeated int64 tiers = 1
message
block_worker.proto:146Used in:
required string tag = 1
required bool position_short = 2
is position short or not, used for HDFS performance optimization. When the client buffer size is large ( > 2MB) and reads are guaranteed to be somewhat sequential, the `pread` API to HDFS is not as efficient as simple `read`. We introduce a heuristic to choose which API to use.
optional int64 bandwidth = 3
optional string user = 4
message
block_master.proto:61Used in:
optional int64 id = 1
optional address = 2
optional int32 lastContactSec = 3
optional string state = 4
optional int64 capacityBytes = 5
optional int64 usedBytes = 6
optional int64 startTimeMs = 7
map<string, int64> capacityBytesOnTiers = 8
map<string, int64> usedBytesOnTiers = 9
optional buildVersion = 10
optional int32 numVCpu = 11
Used in:
ADDRESS = 1
WORKER_CAPACITY_BYTES = 2
WORKER_CAPACITY_BYTES_ON_TIERS = 3
ID = 4
LAST_CONTACT_SEC = 5
START_TIME_MS = 6
STATE = 7
WORKER_USED_BYTES = 8
WORKER_USED_BYTES_ON_TIERS = 9
BLOCK_COUNT = 10
BUILD_VERSION = 11
NUM_VCPU = 12
message
block_master.proto:109Used in:
optional address = 1
map<string, > lostStorage = 2
* a map from tier alias to the lost storage paths
Used in:
ALL = 1
LIVE = 2
LOST = 3
SPECIFIED = 4
DECOMMISSIONED = 5
message
block_worker.proto:83The write request command. next available id: 11
Used in:
optional RequestType type = 1
optional int64 id = 2
The block ID or UFS file ID.
optional int64 offset = 3
optional int32 tier = 4
This is only applicable for block write.
optional bool flush = 5
optional create_ufs_file_options = 6
Cancel, close and error will be handled by standard gRPC stream APIs.
optional create_ufs_block_options = 7
optional string medium_type = 8
optional bool pin_on_create = 9
optional int64 space_to_reserve = 10