Default package
Get desktop application:
View/edit binary Protocol Buffers messages
message
AccessControl.proto:103repeated permission = 1
message
AccessControl.proto:107(message has no fields)
message
AccessControl.proto:93optional Permission.Type type = 1
optional table_name = 2
optional bytes namespace_name = 3
message
AccessControl.proto:99repeated user_permission = 1
rpc Grant (, )
AccessControl.proto:111message
AccessControl.proto:79required user_permission = 1
message
AccessControl.proto:83(message has no fields)
rpc Revoke (, )
AccessControl.proto:114message
AccessControl.proto:86required user_permission = 1
message
AccessControl.proto:90(message has no fields)
service AdminService
Admin.proto:255rpc CloseRegion (, )
Admin.proto:271message
Admin.proto:107* Closes the specified region and will use or not use ZK during the close according to the specified flag.
required region = 1
optional uint32 version_of_closing_node = 2
optional bool transition_in_ZK = 3
optional destination_server = 4
optional uint64 serverStartCode = 5
the intended server for this RPC.
message
Admin.proto:116required bool closed = 1
rpc CompactRegion (, )
Admin.proto:280message
Admin.proto:157* Compacts the specified region. Performs a major compaction if specified. <p> This method is asynchronous.
required region = 1
optional bool major = 2
optional bytes family = 3
message
Admin.proto:163(message has no fields)
rpc FlushRegion (, )
Admin.proto:274message
Admin.proto:125* Flushes the MemStore of the specified region. <p> This method is synchronous.
required region = 1
optional uint64 if_older_than_ts = 2
optional bool write_flush_wal_marker = 3
whether to write a marker to WAL even if not flushed
message
Admin.proto:131required uint64 last_flush_time = 1
optional bool flushed = 2
optional bool wrote_flush_wal_marker = 3
rpc GetOnlineRegion (, )
Admin.proto:262message
Admin.proto:62(message has no fields)
message
Admin.proto:65repeated region_info = 1
rpc GetRegionInfo (, )
Admin.proto:256message
Admin.proto:31required region = 1
optional bool compaction_state = 2
message
Admin.proto:36required region_info = 1
optional GetRegionInfoResponse.CompactionState compaction_state = 2
optional bool isRecovering = 3
rpc GetServerInfo (, )
Admin.proto:295message
Admin.proto:237(message has no fields)
message
Admin.proto:245required server_info = 1
rpc GetStoreFile (, )
Admin.proto:259message
Admin.proto:53* Get a list of store files for a set of column families in a particular region. If no column family is specified, get the store files for all column families.
required region = 1
repeated bytes family = 2
message
Admin.proto:58repeated string store_file = 1
rpc MergeRegions (, )
Admin.proto:283message
Admin.proto:184* Merges the specified regions. <p> This method currently closes the regions and then merges them
required region_a = 1
required region_b = 2
optional bool forcible = 3
optional uint64 master_system_time = 4
wall clock time from master
message
Admin.proto:192(message has no fields)
rpc OpenRegion (, )
Admin.proto:265message
Admin.proto:69repeated open_info = 1
optional uint64 serverStartCode = 2
the intended server for this RPC.
optional uint64 master_system_time = 5
wall clock time from master
message
Admin.proto:85repeated OpenRegionResponse.RegionOpeningState opening_state = 1
rpc Replay (, )
Admin.proto:289rpc ReplicateWALEntry (, )
Admin.proto:286rpc RollWALWriter (, )
Admin.proto:292message
Admin.proto:218(message has no fields)
message
Admin.proto:225Roll request responses no longer include regions to flush this list will always be empty when talking to a 1.0 server
repeated bytes region_to_flush = 1
A list of encoded name of regions to flush
rpc SplitRegion (, )
Admin.proto:277message
Admin.proto:144* Splits the specified region. <p> This method currently flushes the region and then forces a compaction which will then trigger a split. The flush is done synchronously but the compaction is asynchronous.
required region = 1
optional bytes split_point = 2
message
Admin.proto:149(message has no fields)
rpc StopServer (, )
Admin.proto:298message
Admin.proto:230required string reason = 1
message
Admin.proto:234(message has no fields)
rpc UpdateConfiguration (, )
Admin.proto:304message
Admin.proto:249(message has no fields)
message
Admin.proto:252(message has no fields)
rpc UpdateFavoredNodes (, )
Admin.proto:301message
Admin.proto:166repeated update_info = 1
message
Admin.proto:175optional uint32 response = 1
rpc WarmupRegion (, )
Admin.proto:268message
Admin.proto:95required regionInfo = 1
message
Admin.proto:100(message has no fields)
* Refer to the AggregateImplementation class for an overview of the AggregateService method implementations and their functionality.
rpc GetAvg (, )
Aggregate.proto:59rpc GetMax (, )
Aggregate.proto:55rpc GetMedian (, )
Aggregate.proto:61rpc GetMin (, )
Aggregate.proto:56rpc GetRowNum (, )
Aggregate.proto:58rpc GetStd (, )
Aggregate.proto:60rpc GetSum (, )
Aggregate.proto:57
RPC service
message
Authentication.proto:58RPC request & response messages
(message has no fields)
message
Authentication.proto:61optional token = 1
rpc WhoAmI (, )
Authentication.proto:79message
Authentication.proto:65(message has no fields)
message
Authentication.proto:68optional string username = 1
optional string auth_method = 2
service ClientService
Client.proto:455rpc BulkLoadHFile (, )
Client.proto:465message
Client.proto:340* Atomically bulk load multiple HFiles (say from different column families) into an open region.
required region = 1
repeated family_path = 2
optional bool assign_seq_num = 3
message
Client.proto:351required bool loaded = 1
rpc ExecService (, )
Client.proto:468rpc Get (, )
Client.proto:456message
Client.proto:121* The get request. Perform a single Get operation.
required region = 1
required get = 2
message
Client.proto:126optional result = 1
rpc Multi (, )
Client.proto:474message
Client.proto:442* Execute a list of actions on a given region in order. Nothing prevents a request to contains a set of RegionAction on the same region. For this reason, the matching between the MultiRequest and the MultiResponse is not done by the region specifier but by keeping the order of the RegionActionResult vs. the order of the RegionAction.
repeated regionAction = 1
optional uint64 nonceGroup = 2
optional condition = 3
message
Client.proto:448repeated regionActionResult = 1
optional bool processed = 2
used for mutate to indicate processed only
rpc Mutate (, )
Client.proto:459message
Client.proto:218* The mutate request. Perform a single Mutate operation. Optionally, you can specify a condition. The mutate will take place only if the condition is met. Otherwise, the mutate will be ignored. In the response result, parameter processed is used to indicate if the mutate actually happened.
required region = 1
required mutation = 2
optional condition = 3
optional uint64 nonce_group = 4
message
Client.proto:225optional result = 1
optional bool processed = 2
used for mutate to indicate processed only
rpc Scan (, )
Client.proto:462message
Client.proto:274* A scan request. Initially, it should specify a scan. Later on, you can use the scanner id returned to fetch result batches with a different scan request. The scanner will remain open if there are more results, and it's not asked to be closed explicitly. You can fetch the results and ask the scanner to be closed to save a trip if you are not interested in remaining results.
optional region = 1
optional scan = 2
optional uint64 scanner_id = 3
optional uint32 number_of_rows = 4
optional bool close_scanner = 5
optional uint64 next_call_seq = 6
optional bool client_handles_partials = 7
optional bool client_handles_heartbeats = 8
optional bool track_scan_metrics = 9
optional bool renew = 10
message
Client.proto:291* The scan response. If there are no more results, more_results will be false. If it is not specified, it means there are more.
repeated uint32 cells_per_result = 1
This field is filled in if we are doing cellblocks. A cellblock is made up of all Cells serialized out as one cellblock BUT responses from a server have their Cells grouped by Result. So we can reconstitute the Results on the client-side, this field is a list of counts of Cells in each Result that makes up the response. For example, if this field has 3, 3, 3 in it, then we know that on the client, we are to make three Results each of three Cells each.
optional uint64 scanner_id = 2
optional bool more_results = 3
optional uint32 ttl = 4
repeated results = 5
If cells are not carried in an accompanying cellblock, then they are pb'd here. This field is mutually exclusive with cells_per_result (since the Cells will be inside the pb'd Result)
optional bool stale = 6
repeated bool partial_flag_per_result = 7
This field is filled in if we are doing cellblocks. In the event that a row could not fit all of its cells into a single RPC chunk, the results will be returned as partials, and reconstructed into a complete result on the client side. This field is a list of flags indicating whether or not the result that the cells belong to is a partial result. For example, if this field has false, false, true in it, then we know that on the client side, we need to make another RPC request since the last result was only a partial.
optional bool more_results_in_region = 8
A server may choose to limit the number of results returned to the client for reasons such as the size in bytes or quantity of results accumulated. This field will true when more results exist in the current region.
optional bool heartbeat_message = 9
This field is filled in if the server is sending back a heartbeat message. Heartbeat messages are sent back to the client to prevent the scanner from timing out. Seeing a heartbeat message communicates to the Client that the server would have continued to scan had the time limit not been reached.
optional scan_metrics = 10
This field is filled in if the client has requested that scan metrics be tracked. The metrics tracked here are sent back to the client to be tracked together with the existing client side metrics.
service MasterService
Master.proto:496rpc AbortProcedure (, )
Master.proto:747* Abort a procedure
message
Master.proto:439required uint64 proc_id = 1
optional bool mayInterruptIfRunning = 2
message
Master.proto:444required bool is_procedure_aborted = 1
rpc AddColumn (, )
Master.proto:517* Adds a column to the specified table.
message
Master.proto:37required table_name = 1
required column_families = 2
optional uint64 nonce_group = 3
optional uint64 nonce = 4
message
Master.proto:44(message has no fields)
rpc AssignRegion (, )
Master.proto:537* Assign a region to a server chosen at random.
message
Master.proto:89required region = 1
message
Master.proto:93(message has no fields)
rpc Balance (, )
Master.proto:595* Run the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. Can NOT run for various reasons. Check logs.
message
Master.proto:243(message has no fields)
message
Master.proto:246required bool balancer_ran = 1
rpc CreateNamespace (, )
Master.proto:705* Creates a new namespace synchronously
message
Master.proto:176required namespaceDescriptor = 1
message
Master.proto:180(message has no fields)
rpc CreateTable (, )
Master.proto:579* Creates a new table asynchronously
message
Master.proto:113required table_schema = 1
repeated bytes split_keys = 2
optional uint64 nonce_group = 3
optional uint64 nonce = 4
message
Master.proto:120optional uint64 proc_id = 1
rpc DeleteColumn (, )
Master.proto:521* Deletes a column from the specified table. Table must be disabled.
message
Master.proto:47required table_name = 1
required bytes column_name = 2
optional uint64 nonce_group = 3
optional uint64 nonce = 4
message
Master.proto:54(message has no fields)
rpc DeleteNamespace (, )
Master.proto:709* Deletes namespace synchronously
message
Master.proto:183required string namespaceName = 1
message
Master.proto:187(message has no fields)
rpc DeleteSnapshot (, )
Master.proto:665* Delete an existing snapshot. This method can also be used to clean up an aborted snapshot.
message
Master.proto:325required snapshot = 1
message
Master.proto:329(message has no fields)
rpc DeleteTable (, )
Master.proto:559* Deletes a table
message
Master.proto:124required table_name = 1
optional uint64 nonce_group = 2
optional uint64 nonce = 3
message
Master.proto:130optional uint64 proc_id = 1
rpc DisableTable (, )
Master.proto:571* Take table offline
message
Master.proto:154required table_name = 1
optional uint64 nonce_group = 2
optional uint64 nonce = 3
message
Master.proto:160optional uint64 proc_id = 1
* Master dispatch merging the regions
message
Master.proto:80* Dispatch merging the specified regions.
required region_a = 1
required region_b = 2
optional bool forcible = 3
message
Master.proto:86(message has no fields)
rpc EnableCatalogJanitor (, )
Master.proto:636* Enable the catalog janitor on or off.
message
Master.proto:295required bool enable = 1
message
Master.proto:299optional bool prev_value = 1
rpc EnableTable (, )
Master.proto:567* Puts the table on-line (only needed if table has been previously taken offline)
message
Master.proto:144required table_name = 1
optional uint64 nonce_group = 2
optional uint64 nonce = 3
message
Master.proto:150optional uint64 proc_id = 1
rpc ExecMasterService (, )
Master.proto:648* Call a master coprocessor endpoint
rpc ExecProcedure (, )
Master.proto:685* Execute a distributed procedure.
rpc ExecProcedureWithRet (, )
Master.proto:690* Execute a distributed procedure with return data.
rpc GetClusterStatus (, )
Master.proto:510* Return cluster status.
message
Master.proto:389(message has no fields)
message
Master.proto:392required cluster_status = 1
* Get completed snapshots. Returns a list of snapshot descriptors for completed snapshots
message
Master.proto:318(message has no fields)
message
Master.proto:321repeated snapshots = 1
* Get a namespace descriptor by name
message
Master.proto:197required string namespaceName = 1
message
Master.proto:201required namespaceDescriptor = 1
rpc GetSchemaAlterStatus (, )
Master.proto:498* Used by the client to get the number of regions that have received the updated schema
message
Master.proto:359required table_name = 1
message
Master.proto:363optional uint32 yet_to_update_regions = 1
optional uint32 total_regions = 2
rpc GetTableDescriptors (, )
Master.proto:502* Get list of TableDescriptors for requested tables.
message
Master.proto:368repeated table_names = 1
optional string regex = 2
optional bool include_sys_tables = 3
optional string namespace = 4
message
Master.proto:375repeated table_schema = 1
rpc GetTableNames (, )
Master.proto:506* Get the list of table names.
message
Master.proto:379optional string regex = 1
optional bool include_sys_tables = 2
optional string namespace = 3
message
Master.proto:385repeated table_names = 1
rpc IsBalancerEnabled (, )
Master.proto:608* Query whether the Region Balancer is running.
message
Master.proto:259(message has no fields)
message
Master.proto:262required bool enabled = 1
* Query whether the catalog janitor is enabled.
message
Master.proto:303(message has no fields)
message
Master.proto:306required bool value = 1
rpc IsMasterRunning (, )
Master.proto:514* return true if master is available
message
Master.proto:396(message has no fields)
message
Master.proto:399required bool is_master_running = 1
rpc IsNormalizerEnabled (, )
Master.proto:626* Query whether region normalizer is enabled.
message
Master.proto:281(message has no fields)
message
Master.proto:284required bool enabled = 1
rpc IsProcedureDone (, )
Master.proto:695* Determine if the procedure is done yet.
message
Master.proto:412optional procedure = 1
message
Master.proto:416optional bool done = 1
optional snapshot = 2
* Determine if the snapshot restore is done yet.
message
Master.proto:351optional snapshot = 1
message
Master.proto:355optional bool done = 1
rpc IsSnapshotDone (, )
Master.proto:670* Determine if the snapshot is done yet.
message
Master.proto:342if you don't send the snapshot, then you will get it back in the response (if the snapshot is done) so you can check the snapshot
optional snapshot = 1
message
Master.proto:346optional bool done = 1
optional snapshot = 2
* returns a list of namespaces
message
Master.proto:205(message has no fields)
message
Master.proto:208repeated namespaceDescriptor = 1
rpc ListProcedures (, )
Master.proto:751* returns a list of procedures
message
Master.proto:448(message has no fields)
message
Master.proto:451repeated procedure = 1
* returns a list of tables for a given namespace
message
Master.proto:212required string namespaceName = 1
message
Master.proto:216repeated tableSchema = 1
* returns a list of tables for a given namespace
message
Master.proto:220required string namespaceName = 1
message
Master.proto:224repeated tableName = 1
rpc ModifyColumn (, )
Master.proto:525* Modifies an existing column on the specified table.
message
Master.proto:57required table_name = 1
required column_families = 2
optional uint64 nonce_group = 3
optional uint64 nonce = 4
message
Master.proto:64(message has no fields)
rpc ModifyNamespace (, )
Master.proto:701* Modify a namespace's metadata
message
Master.proto:190required namespaceDescriptor = 1
message
Master.proto:194(message has no fields)
rpc ModifyTable (, )
Master.proto:575* Modify a table's metadata
message
Master.proto:164required table_name = 1
required table_schema = 2
optional uint64 nonce_group = 3
optional uint64 nonce = 4
message
Master.proto:171(message has no fields)
rpc MoveRegion (, )
Master.proto:529* Move the region region to the destination server.
message
Master.proto:69required region = 1
optional dest_server_name = 2
message
Master.proto:74(message has no fields)
rpc Normalize (, )
Master.proto:614* Run region normalizer. Can NOT run for various reasons. Check logs.
message
Master.proto:266(message has no fields)
message
Master.proto:269required bool normalizer_ran = 1
rpc OfflineRegion (, )
Master.proto:555* Offline a region from the assignment manager's in-memory state. The region should be in a closed state and there will be no attempt to automatically reassign the region as in unassign. This is a special method, and should only be used by experts or hbck.
message
Master.proto:104required region = 1
message
Master.proto:108(message has no fields)
rpc RestoreSnapshot (, )
Master.proto:675* Restore a snapshot
message
Master.proto:332required snapshot = 1
message
Master.proto:336(message has no fields)
rpc RunCatalogScan (, )
Master.proto:630* Get a run of the catalog janitor
message
Master.proto:288(message has no fields)
message
Master.proto:291optional int32 scan_result = 1
rpc SetBalancerRunning (, )
Master.proto:602* Turn the load balancer on or off. If synchronous is true, it waits until current balance() call, if outstanding, to return.
message
Master.proto:250required bool on = 1
optional bool synchronous = 2
message
Master.proto:255optional bool prev_balance_value = 1
rpc SetNormalizerRunning (, )
Master.proto:620* Turn region normalizer on or off.
message
Master.proto:273required bool on = 1
message
Master.proto:277optional bool prev_normalizer_value = 1
rpc SetQuota (, )
Master.proto:729* Apply the new quota settings
message
Master.proto:455optional string user_name = 1
optional string user_group = 2
optional string namespace = 3
optional table_name = 4
optional bool remove_all = 5
optional bool bypass_globals = 6
optional throttle = 7
message
Master.proto:466(message has no fields)
rpc Shutdown (, )
Master.proto:583* Shutdown an HBase cluster.
message
Master.proto:231(message has no fields)
message
Master.proto:234(message has no fields)
rpc Snapshot (, )
Master.proto:654* Create a snapshot for the given table.
message
Master.proto:310required snapshot = 1
message
Master.proto:314required int64 expected_timeout = 1
rpc StopMaster (, )
Master.proto:587* Stop HBase Master only. Does not shutdown the cluster.
message
Master.proto:237(message has no fields)
message
Master.proto:240(message has no fields)
rpc UnassignRegion (, )
Master.proto:546* Unassign a region from current hosting regionserver. Region will then be assigned to a regionserver chosen at random. Region could be reassigned back to the same server. Use MoveRegion if you want to control the region movement.
message
Master.proto:96required region = 1
optional bool force = 2
message
Master.proto:101(message has no fields)
* Returns the timestamp of the last major compaction
message
Master.proto:469required table_name = 1
* Returns the timestamp of the last major compaction
message
Master.proto:473required region = 1
rpc getProcedureResult (, )
Master.proto:739message
Master.proto:421required uint64 proc_id = 1
message
Master.proto:425required GetProcedureResultResponse.State state = 1
optional uint64 start_time = 2
optional uint64 last_update = 3
optional bytes result = 4
optional exception = 5
* Returns the security capabilities in effect on the cluster
message
Master.proto:481(message has no fields)
message
Master.proto:484repeated SecurityCapabilitiesResponse.Capability capabilities = 1
rpc truncateTable (, )
Master.proto:563* Truncate a table
message
Master.proto:134required tableName = 1
optional bool preserveSplits = 2
optional uint64 nonce_group = 3
optional uint64 nonce = 4
message
Master.proto:141(message has no fields)
rpc MutateRows (, )
MultiRowMutation.proto:41message
MultiRowMutation.proto:31repeated mutation_request = 1
optional uint64 nonce_group = 2
optional uint64 nonce = 3
message
MultiRowMutation.proto:37(message has no fields)
* Called to get the sequence id of the last MemStore entry flushed to an HFile for a specified region. Used by the region server to speed up log splitting.
message
RegionServerStatus.proto:74required bytes region_name = 1
* region name
message
RegionServerStatus.proto:79required uint64 last_flushed_sequence_id = 1
* the last WAL sequence id flushed from MemStore to HFile for the region
repeated store_last_flushed_sequence_id = 2
* the last WAL sequence id flushed from MemStore to HFile for stores of the region
* Called to report the load the RegionServer is under.
message
RegionServerStatus.proto:53required server = 1
optional load = 2
* load the server is under
message
RegionServerStatus.proto:60(message has no fields)
* Called when a region server first starts.
message
RegionServerStatus.proto:30required uint32 port = 1
* Port number this regionserver is up on
required uint64 server_start_code = 2
* This servers' startcode
required uint64 server_current_time = 3
* Current time of the region server in ms
optional string use_this_hostname_instead = 4
* hostname for region server, optional
message
RegionServerStatus.proto:44repeated map_entries = 1
* Configuration for the regionserver to use: e.g. filesystem, hbase rootdir, the hostname to use creating the RegionServer ServerName, etc
* Called by a region server to report a fatal error that is causing it to abort.
message
RegionServerStatus.proto:63required server = 1
* name of the server experiencing the error
required string error_message = 2
* informative text to expose in the master logs and UI
message
RegionServerStatus.proto:71(message has no fields)
* Called by a region server to report the progress of a region transition. If the request fails, the transition should be aborted.
message
RegionServerStatus.proto:116required server = 1
* This region server's server name
repeated transition = 2
message
RegionServerStatus.proto:123optional string error_message = 1
* Error message if failed to update the region state
rpc Process (, )
RowProcessor.proto:42message
RowProcessor.proto:29required string row_processor_class_name = 1
optional string row_processor_initializer_message_name = 2
optional bytes row_processor_initializer_message = 3
optional uint64 nonce_group = 4
optional uint64 nonce = 5
message
RowProcessor.proto:37required bytes row_processor_result = 1
message
SecureBulkLoad.proto:54required string bulk_token = 1
message
SecureBulkLoad.proto:59(message has no fields)
message
SecureBulkLoad.proto:46required table_name = 1
message
SecureBulkLoad.proto:50required string bulk_token = 1
message
SecureBulkLoad.proto:28repeated family_path = 1
optional bool assign_seq_num = 2
required fs_token = 3
required string bulk_token = 4
message
SecureBulkLoad.proto:35required bool loaded = 1
rpc addLabels (, )
VisibilityLabels.proto:72message
VisibilityLabels.proto:27repeated visLabel = 1
rpc clearAuths (, )
VisibilityLabels.proto:76rpc getAuths (, )
VisibilityLabels.proto:78message
VisibilityLabels.proto:54required bytes user = 1
message
VisibilityLabels.proto:58required bytes user = 1
repeated bytes auth = 2
rpc listLabels (, )
VisibilityLabels.proto:80message
VisibilityLabels.proto:63optional string regex = 1
message
VisibilityLabels.proto:67repeated bytes label = 1
rpc setAuths (, )
VisibilityLabels.proto:74
message
Client.proto:377Either a Get or a Mutation
Used in:
optional uint32 index = 1
If part of a multi action, useful aligning result with what was originally submitted.
optional mutation = 2
optional get = 3
optional service_call = 4
ADD_COLUMN_FAMILY_PREPARE = 1
ADD_COLUMN_FAMILY_PRE_OPERATION = 2
ADD_COLUMN_FAMILY_UPDATE_TABLE_DESCRIPTOR = 3
ADD_COLUMN_FAMILY_POST_OPERATION = 4
ADD_COLUMN_FAMILY_REOPEN_ALL_REGIONS = 5
message
MasterProcedure.proto:119required user_info = 1
required table_name = 2
required columnfamily_schema = 3
optional unmodified_table_schema = 4
message
Aggregate.proto:27Used as request type in: AggregateService.GetAvg, AggregateService.GetMax, AggregateService.GetMedian, AggregateService.GetMin, AggregateService.GetRowNum, AggregateService.GetStd, AggregateService.GetSum
required string interpreter_class_name = 1
* The request passed to the AggregateService consists of three parts (1) the (canonical) classname of the ColumnInterpreter implementation (2) the Scan query (3) any bytes required to construct the ColumnInterpreter object properly
required scan = 2
optional bytes interpreter_specific_bytes = 3
message
Aggregate.proto:39Used as response type in: AggregateService.GetAvg, AggregateService.GetMax, AggregateService.GetMedian, AggregateService.GetMin, AggregateService.GetRowNum, AggregateService.GetStd, AggregateService.GetSum
repeated bytes first_part = 1
* The AggregateService methods all have a response that either is a Pair or a simple object. When it is a Pair both first_part and second_part have defined values (and the second_part is not present in the response when the response is not a pair). Refer to the AggregateImplementation class for an overview of the AggregateResponse object constructions.
optional bytes second_part = 2
message
Authentication.proto:25required int32 id = 1
required int64 expiration_date = 2
required bytes key = 3
message
Client.proto:36* The protocol buffer version of Authorizations.
repeated string label = 1
message
HBase.proto:207required bytes bigdecimal_msg = 1
message
Comparator.proto:38required comparable = 1
message
Comparator.proto:46required comparable = 1
message
Comparator.proto:50required comparable = 1
required BitComparator.BitwiseOp bitwise_op = 2
Used in:
AND = 1
OR = 2
XOR = 3
message
WAL.proto:138* Special WAL entry used for writing bulk load events to WAL
required table_name = 1
required bytes encoded_region_name = 2
repeated stores = 3
required int64 bulkload_seq_num = 4
message
Client.proto:345Used in: ,
required bytes family = 1
required string path = 2
message
Comparator.proto:34Used in: , , ,
optional bytes value = 1
message
HBase.proto:149Used in: , , , ,
required bytes first = 1
required bytes second = 2
message
Cell.proto:44* Protocol buffer version of Cell.
Used in:
optional bytes row = 1
optional bytes family = 2
optional bytes qualifier = 3
optional uint64 timestamp = 4
optional CellType cell_type = 5
optional bytes value = 6
optional bytes tags = 7
message
RPC.proto:93Optional Cell block Message. Included in client RequestHeader
Used in: ,
optional uint32 length = 1
Length of the following cell block. Could calculate it but convenient having it too hand.
* The type of the key in a Cell
Used in: ,
MINIMUM = 0
PUT = 4
DELETE = 8
DELETE_COLUMN = 12
DELETE_FAMILY = 14
MAXIMUM = 255
MAXIMUM is used when searching; you look from maximum on down.
message
Client.proto:43* The protocol buffer version of CellVisibility.
required string expression = 1
message
ClusterId.proto:30* Content of the '/hbase/hbaseid', cluster id, znode. Also cluster of the ${HBASE_ROOTDIR}/hbase.id file.
Used in:
required string cluster_id = 1
This is the cluster id, a uuid as a String
message
ClusterStatus.proto:213Used in:
optional hbase_version = 1
repeated live_servers = 2
repeated dead_servers = 3
repeated regions_in_transition = 4
optional cluster_id = 5
repeated master_coprocessors = 6
optional master = 7
repeated backup_masters = 8
optional bool balancer_on = 9
message
ZooKeeper.proto:61* Content of the '/hbase/running', cluster state, znode.
required string start_date = 1
If this znode is present, cluster is up. Currently the data is cluster start_date.
message
Client.proto:50* Container for a list of column qualifier names of a family.
Used in: ,
required bytes family = 1
repeated bytes qualifier = 2
message
Filter.proto:35required int32 limit = 1
message
HBase.proto:51* Column Family Schema Inspired by the rest ColumSchemaMessage
Used in: , , , ,
required bytes name = 1
repeated attributes = 2
repeated configuration = 3
message
HBase.proto:108ColumnFamily Specific TimeRange
Used in: ,
required bytes column_family = 1
required time_range = 2
message
Filter.proto:39required int32 limit = 1
optional int32 offset = 2
optional bytes column_offset = 3
message
Filter.proto:45required bytes prefix = 1
message
Filter.proto:49optional bytes min_column = 1
optional bool min_column_inclusive = 2
optional bytes max_column = 3
optional bool max_column_inclusive = 4
message
WAL.proto:94* Special WAL entry to hold all related to a compaction. Written to WAL before completing compaction. There is sufficient info in the below message to complete later the * compaction should we fail the WAL write.
required bytes table_name = 1
TODO: WALKey already stores these, might remove
required bytes encoded_region_name = 2
required bytes family_name = 3
repeated string compaction_input = 4
relative to store dir
repeated string compaction_output = 5
required string store_home_dir = 6
relative to region dir
optional bytes region_name = 7
full region name
message
Comparator.proto:29Used in: , ,
required string name = 1
optional bytes serialized_comparator = 2
message
Filter.proto:56Used in: , , , ,
required CompareType compare_op = 1
optional comparator = 2
Comparison operators
Used in: , ,
LESS = 0
LESS_OR_EQUAL = 1
EQUAL = 2
NOT_EQUAL = 3
GREATER_OR_EQUAL = 4
GREATER = 5
NO_OP = 6
message
Client.proto:136* Condition to check if the value of a given cell (row, family, qualifier) matches a value via a given comparator. Condition is used in check and mutate operations.
Used in: ,
required bytes row = 1
required bytes family = 2
required bytes qualifier = 3
required CompareType compare_type = 4
required comparator = 5
message
RPC.proto:80This is sent on connection setup after the connection preamble is sent.
optional user_info = 1
optional string service_name = 2
optional string cell_block_codec_class = 3
Cell block codec we will use sending over optional cell blocks. Server throws exception if cannot deal. Null means no codec'ing going on so we are pb all the time (SLOW!!!)
optional string cell_block_compressor_class = 4
Compressor we will use if cell block is compressed. Server will throw exception if not supported. Class must implement hadoop's CompressionCodec Interface. Can't compress if no codec.
optional version_info = 5
* Consistency defines the expected consistency level for an operation.
Used in: ,
STRONG = 0
TIMELINE = 1
message
HBase.proto:135Used in: ,
required string name = 1
message
Client.proto:355Used in: ,
required bytes row = 1
required string service_name = 2
required string method_name = 3
required bytes request = 4
message
Client.proto:366Used as request type in: ClientService.ExecRegionServerService, ClientService.ExecService, MasterService.ExecMasterService
required region = 1
required call = 2
message
Client.proto:371Used as response type in: ClientService.ExecRegionServerService, ClientService.ExecService, MasterService.ExecMasterService
required region = 1
required value = 2
message
Client.proto:362Used in:
optional value = 1
CREATE_TABLE_PRE_OPERATION = 1
CREATE_TABLE_WRITE_FS_LAYOUT = 2
CREATE_TABLE_ADD_TO_META = 3
CREATE_TABLE_ASSIGN_REGIONS = 4
CREATE_TABLE_UPDATE_DESC_CACHE = 5
CREATE_TABLE_POST_OPERATION = 6
message
MasterProcedure.proto:55required user_info = 1
required table_schema = 2
repeated region_info = 3
message
SecureBulkLoad.proto:39Used in:
optional bytes identifier = 1
optional bytes password = 2
optional string kind = 3
optional string service = 4
DELETE_COLUMN_FAMILY_PREPARE = 1
DELETE_COLUMN_FAMILY_PRE_OPERATION = 2
DELETE_COLUMN_FAMILY_UPDATE_TABLE_DESCRIPTOR = 3
DELETE_COLUMN_FAMILY_DELETE_FS_LAYOUT = 4
DELETE_COLUMN_FAMILY_POST_OPERATION = 5
DELETE_COLUMN_FAMILY_REOPEN_ALL_REGIONS = 6
message
MasterProcedure.proto:150required user_info = 1
required table_name = 2
required bytes columnfamily_name = 3
optional unmodified_table_schema = 4
DELETE_TABLE_PRE_OPERATION = 1
DELETE_TABLE_REMOVE_FROM_META = 2
DELETE_TABLE_CLEAR_FS_LAYOUT = 3
DELETE_TABLE_UPDATE_DESC_CACHE = 4
DELETE_TABLE_UNASSIGN_REGIONS = 5
DELETE_TABLE_POST_OPERATION = 6
message
MasterProcedure.proto:105required user_info = 1
required table_name = 2
repeated region_info = 3
message
Filter.proto:61required compare_filter = 1
optional bytes column_family = 2
optional bytes column_qualifier = 3
optional bool drop_dependent_column = 4
DISABLE_TABLE_PREPARE = 1
DISABLE_TABLE_PRE_OPERATION = 2
DISABLE_TABLE_SET_DISABLING_TABLE_STATE = 3
DISABLE_TABLE_MARK_REGIONS_OFFLINE = 4
DISABLE_TABLE_SET_DISABLED_TABLE_STATE = 5
DISABLE_TABLE_POST_OPERATION = 6
message
MasterProcedure.proto:181required user_info = 1
required table_name = 2
required bool skip_table_state_check = 3
message
HBase.proto:203required double double_msg = 1
message
HBase.proto:186(message has no fields)
ENABLE_TABLE_PREPARE = 1
ENABLE_TABLE_PRE_OPERATION = 2
ENABLE_TABLE_SET_ENABLING_TABLE_STATE = 3
ENABLE_TABLE_MARK_REGIONS_ONLINE = 4
ENABLE_TABLE_SET_ENABLED_TABLE_STATE = 5
ENABLE_TABLE_POST_OPERATION = 6
message
MasterProcedure.proto:166required user_info = 1
required table_name = 2
required bool skip_table_state_check = 3
message
RPC.proto:100At the RPC layer, this message is used to carry the server side exception to the RPC client.
Used in:
optional string exception_class_name = 1
Class name of the exception thrown from the server
optional string stack_trace = 2
Exception stack trace from the server side
optional string hostname = 3
Optional hostname. Filled in for some exceptions such as region moved where exception gives clue on where the region may have moved.
optional int32 port = 4
optional bool do_not_retry = 5
Set if we are NOT to retry on receipt of this exception
message
Master.proto:403Used as request type in: MasterService.ExecProcedure, MasterService.ExecProcedureWithRet
required procedure = 1
message
Master.proto:407Used as response type in: MasterService.ExecProcedure, MasterService.ExecProcedureWithRet
optional int64 expected_timeout = 1
optional bytes return_data = 2
message
Filter.proto:68required compare_filter = 1
message
WAL.proto:79Used in:
required bytes family = 1
required ScopeType scope_type = 2
message
HBase.proto:73* Protocol buffer for favored nodes
repeated favored_node = 1
message
HFile.proto:27Map of name/values
repeated map_entry = 1
message
HFile.proto:32HFile file trailer
optional uint64 file_info_offset = 1
optional uint64 load_on_open_data_offset = 2
optional uint64 uncompressed_data_index_size = 3
optional uint64 total_uncompressed_bytes = 4
optional uint32 data_index_count = 5
optional uint32 meta_index_count = 6
optional uint64 entry_count = 7
optional uint32 num_data_index_levels = 8
optional uint64 first_data_block_offset = 9
optional uint64 last_data_block_offset = 10
optional string comparator_class_name = 11
optional uint32 compression_codec = 12
optional bytes encryption_key = 13
message
Filter.proto:30Used in: , , , , ,
required string name = 1
optional bytes serialized_filter = 2
message
Filter.proto:157(message has no fields)
message
Filter.proto:72required FilterList.Operator operator = 1
repeated filters = 2
Used in:
MUST_PASS_ALL = 1
MUST_PASS_ONE = 2
message
Filter.proto:82required filter = 1
message
Filter.proto:86(message has no fields)
message
Filter.proto:89repeated bytes qualifiers = 1
message
WAL.proto:107* Special WAL entry to hold all related to a flush.
required FlushDescriptor.FlushAction action = 1
required bytes table_name = 2
required bytes encoded_region_name = 3
optional uint64 flush_sequence_number = 4
repeated store_flushes = 5
optional bytes region_name = 6
full region name
Used in:
START_FLUSH = 0
COMMIT_FLUSH = 1
ABORT_FLUSH = 2
CANNOT_FLUSH = 3
marker for indicating that a flush has been requested but cannot complete
message
WAL.proto:115Used in:
required bytes family_name = 1
required string store_home_dir = 2
relative to region dir
repeated string flush_output = 3
relative to store dir (if this is a COMMIT_FLUSH)
message
ErrorHandling.proto:54* Exception sent across the wire when a remote task needs to notify other tasks that it failed and why
Used in: ,
optional string source = 1
optional generic_exception = 2
message
Filter.proto:93repeated fuzzy_keys_data = 1
message
ErrorHandling.proto:43* Cause of a remote failure for a generic exception. Contains all the information for a generic exception as well as optional info about the error for generic info passing (which should be another protobuffed class).
Used in:
optional string class_name = 1
optional string message = 2
optional bytes error_info = 3
repeated trace = 4
message
Client.proto:69* The protocol buffer version of Get. Unless existence_only is specified, return all the requested data for the row that matches exactly, or the one that immediately precedes it if closest_row_before is specified.
Used in: ,
required bytes row = 1
repeated column = 2
repeated attribute = 3
optional filter = 4
optional time_range = 5
optional uint32 max_versions = 6
optional bool cache_blocks = 7
optional uint32 store_limit = 8
optional uint32 store_offset = 9
optional bool existence_only = 10
The result isn't asked for, just check for the existence.
optional bool closest_row_before = 11
If the row to get doesn't exist, return the closest row before.
optional Consistency consistency = 12
repeated cf_time_range = 13
Used in:
NOT_FOUND = 0
RUNNING = 1
FINISHED = 2
Used in:
NONE = 0
MINOR = 1
MAJOR = 2
MAJOR_AND_MINOR = 3
message
AccessControl.proto:58Used in:
repeated Permission.Action action = 1
message
FS.proto:29* The ${HBASE_ROOTDIR}/hbase.version file content
Used in:
required string version = 1
message
Filter.proto:97optional bytes stop_row_key = 1
message
Filter.proto:101required bool len_as_val = 1
message
Cell.proto:58* Protocol buffer version of KeyValue. It doesn't have those transient parameters
required bytes row = 1
required bytes family = 2
required bytes qualifier = 3
optional uint64 timestamp = 4
optional CellType key_type = 5
optional bytes value = 6
optional bytes tags = 7
message
ClusterStatus.proto:208Used in:
required server = 1
required server_load = 2
message
LoadBalancer.proto:26optional bool balancer_on = 1
message
Comparator.proto:42required comparable = 1
message
HBase.proto:199required int64 long_msg = 1
message
Master.proto:477Used as response type in: MasterService.getLastMajorCompactionTimestamp, MasterService.getLastMajorCompactionTimestampForRegion
required int64 compaction_timestamp = 1
message
ZooKeeper.proto:50* Content of the master znode.
required master = 1
The ServerName of the current Master
optional uint32 rpc_version = 2
Major RPC version so that clients can know what version the master can accept.
optional uint32 info_port = 3
message
ZooKeeper.proto:34* Content of the meta-region-server znode.
required server = 1
The ServerName hosting the meta region currently, or destination server, if meta region is in transition.
optional uint32 rpc_version = 2
The major version of the rpc the server speaks. This is used so that clients connecting to the cluster can have prior knowledge of what version to send to a RegionServer. AsyncHBase will use this to detect versions.
optional RegionState.State state = 3
State of the region transition. OPEN means fully operational 'hbase:meta'
MODIFY_COLUMN_FAMILY_PREPARE = 1
MODIFY_COLUMN_FAMILY_PRE_OPERATION = 2
MODIFY_COLUMN_FAMILY_UPDATE_TABLE_DESCRIPTOR = 3
MODIFY_COLUMN_FAMILY_POST_OPERATION = 4
MODIFY_COLUMN_FAMILY_REOPEN_ALL_REGIONS = 5
message
MasterProcedure.proto:134required user_info = 1
required table_name = 2
required columnfamily_schema = 3
optional unmodified_table_schema = 4
MODIFY_TABLE_PREPARE = 1
MODIFY_TABLE_PRE_OPERATION = 2
MODIFY_TABLE_UPDATE_TABLE_DESCRIPTOR = 3
MODIFY_TABLE_REMOVE_REPLICA_COLUMN = 4
MODIFY_TABLE_DELETE_FS_LAYOUT = 5
MODIFY_TABLE_POST_OPERATION = 6
MODIFY_TABLE_REOPEN_ALL_REGIONS = 7
message
MasterProcedure.proto:71required user_info = 1
optional unmodified_table_schema = 2
required modified_table_schema = 3
required bool delete_column_family_in_modify = 4
message
MultiRowMutation.proto:25(message has no fields)
message
MultiRowMutation.proto:28(message has no fields)
message
Filter.proto:167repeated row_range_list = 1
message
VisibilityLabels.proto:50repeated userAuths = 1
message
Filter.proto:105repeated bytes sorted_prefixes = 1
message
Client.proto:152* A specific mutation inside a mutate request. It can be an append, increment, put or delete based on the mutation type. It can be fully filled in or only metadata present because data is being carried elsewhere outside of pb.
Used in: , ,
optional bytes row = 1
optional MutationProto.MutationType mutate_type = 2
repeated column_value = 3
optional uint64 timestamp = 4
repeated attribute = 5
optional MutationProto.Durability durability = 6
optional time_range = 7
For some mutations, a result may be returned, in which case, time range can be specified for potential performance gain
optional int32 associated_cell_count = 8
The below count is set when the associated cells are NOT part of this protobuf message; they are passed alongside and then this Message is a placeholder with metadata. The count is needed to know how many to peel off the block of Cells as ours. NOTE: This is different from the pb managed cell_count of the 'cell' field above which is non-null when the cells are pb'd.
optional uint64 nonce = 9
message
Client.proto:195Used in:
required bytes family = 1
repeated qualifier_value = 2
message
Client.proto:199Used in:
optional bytes qualifier = 1
optional bytes value = 2
optional uint64 timestamp = 3
optional DeleteType delete_type = 4
optional bytes tags = 5
Used in:
DELETE_ONE_VERSION = 0
DELETE_MULTIPLE_VERSIONS = 1
DELETE_FAMILY = 2
DELETE_FAMILY_VERSION = 3
Used in:
USE_DEFAULT = 0
SKIP_WAL = 1
ASYNC_WAL = 2
SYNC_WAL = 3
FSYNC_WAL = 4
Used in:
APPEND = 0
INCREMENT = 1
PUT = 2
DELETE = 3
message
HBase.proto:144Used in: , , , , , ,
required string name = 1
optional bytes value = 2
message
HBase.proto:154Used in:
optional string name = 1
optional int64 value = 2
message
HBase.proto:139Used in: , , , , ,
required string name = 1
required string value = 2
message
HBase.proto:216Used in: , , ,
required bytes name = 1
repeated configuration = 2
message
AccessControl.proto:53Used in:
optional bytes namespace_name = 1
repeated Permission.Action action = 2
message
Comparator.proto:61(message has no fields)
message
Admin.proto:76Used in:
required region = 1
optional uint32 version_of_offline_node = 2
repeated favored_nodes = 3
optional bool openForDistributedLogReplay = 4
open region for distributedLogReplay
Used in:
OPENED = 0
ALREADY_OPENED = 1
FAILED_OPENING = 2
message
Filter.proto:109required int64 page_size = 1
message
AccessControl.proto:27Used in: , ,
required Permission.Type type = 1
optional global_permission = 2
optional namespace_permission = 3
optional table_permission = 4
Used in: , ,
READ = 0
WRITE = 1
EXEC = 2
CREATE = 3
ADMIN = 4
Used in: ,
Global = 1
Namespace = 2
Table = 3
message
Filter.proto:113optional bytes prefix = 1
message
Procedure.proto:39* Procedure metadata, serialized by the ProcedureStore to be able to recover the old state.
Used in: ,
required string class_name = 1
internal "static" state
full classname to be able to instantiate the procedure
optional uint64 parent_id = 2
parent if not a root-procedure otherwise not set
required uint64 proc_id = 3
required uint64 start_time = 4
optional string owner = 5
required ProcedureState state = 6
internal "runtime" state
repeated uint32 stack_id = 7
stack indices in case the procedure was running
required uint64 last_update = 8
optional uint32 timeout = 9
optional exception = 10
user state/results
optional bytes result = 11
opaque (user) result structure
optional bytes state_data = 12
opaque (user) procedure internal-state
optional uint64 nonce_group = 13
Nonce to prevent same procedure submit by multiple times
optional uint64 nonce = 14
message
HBase.proto:179* Description of the distributed procedure to take
Used in: , ,
required string signature = 1
the unique signature of the procedure
optional string instance = 2
the procedure instance name
optional int64 creation_time = 3
repeated configuration = 4
Used in:
INITIALIZING = 1
Procedure in construction, not yet added to the executor
RUNNABLE = 2
Procedure added to the executor, and ready to be executed
WAITING = 3
The procedure is waiting on children to be completed
WAITING_TIMEOUT = 4
The procedure is waiting a timout or an external event
ROLLEDBACK = 5
The procedure failed and was rolledback
FINISHED = 6
The procedure execution is completed. may need a rollback if failed.
message
Procedure.proto:95repeated node = 1
message
Procedure.proto:96Used in:
required uint64 start_id = 1
repeated uint64 updated = 2
repeated uint64 deleted = 3
message
Procedure.proto:105required ProcedureWALEntry.Type type = 1
repeated procedure = 2
optional uint64 proc_id = 3
Used in:
EOF = 1
INIT = 2
INSERT = 3
UPDATE = 4
DELETE = 5
COMPACT = 6
message
Procedure.proto:80* Procedure WAL header
required uint32 version = 1
required uint32 type = 2
required uint64 log_id = 3
required uint64 min_proc_id = 4
message
Procedure.proto:90* Procedure WAL trailer
required uint32 version = 1
required uint64 tracker_pos = 2
message
Filter.proto:117required compare_filter = 1
Used in:
CLUSTER = 1
MACHINE = 2
THROTTLE = 1
message
Quota.proto:72(message has no fields)
message
Quota.proto:67optional bool bypass_globals = 1
optional throttle = 2
message
Tracing.proto:28Used to pass through the information necessary to continue a trace after an RPC is made. All we need is the traceid (so we know the overarching trace this message is a part of), and the id of the current span when this message was sent, so we know what span caused the new span we will create when this message is received.
Used in:
optional int64 trace_id = 1
optional int64 parent_id = 2
message
Filter.proto:121required float chance = 1
message
FS.proto:36* Reference file content used when we split an hfile under a region.
Used in:
required bytes splitkey = 1
required Reference.Range range = 2
Used in:
TOP = 0
BOTTOM = 1
message
Comparator.proto:64required string pattern = 1
required int32 pattern_flags = 2
required string charset = 3
optional string engine = 4
message
Client.proto:389* Actions to run against a Region.
Used in:
required region = 1
optional bool atomic = 2
When set, run mutations as atomic unit.
repeated action = 3
message
Client.proto:429* The result of a RegionAction.
Used in: ,
repeated resultOrException = 1
optional exception = 2
If the operation failed globally for this region, this exception is set
message
WAL.proto:148* Special WAL entry to hold all related to a region event (open/close).
required RegionEventDescriptor.EventType event_type = 1
required bytes table_name = 2
required bytes encoded_region_name = 3
optional uint64 log_sequence_number = 4
repeated stores = 5
optional server = 6
Server who opened the region
optional bytes region_name = 7
full region name
Used in:
REGION_OPEN = 0
REGION_CLOSE = 1
message
ClusterStatus.proto:57Used in:
required spec = 1
required region_state = 2
message
HBase.proto:60* Protocol buffer version of HRegionInfo.
Used in: , , , , , , , , , , , ,
required uint64 region_id = 1
required table_name = 2
optional bytes start_key = 3
optional bytes end_key = 4
optional bool offline = 5
optional bool split = 6
optional int32 replica_id = 7
message
ClusterStatus.proto:79Used in:
required region_specifier = 1
* the region specifier
optional uint32 stores = 2
* the number of stores for the region
optional uint32 storefiles = 3
* the number of storefiles for the region
optional uint32 store_uncompressed_size_MB = 4
* the total size of the store files for the region, uncompressed, in MB
optional uint32 storefile_size_MB = 5
* the current total size of the store files for the region, in MB
optional uint32 memstore_size_MB = 6
* the current size of the memstore for the region, in MB
optional uint32 storefile_index_size_MB = 7
* The current total size of root-level store file indexes for the region, in MB. The same as {@link #rootIndexSizeKB} but in MB.
optional uint64 read_requests_count = 8
* the current total read requests made to region
optional uint64 write_requests_count = 9
* the current total write requests made to region
optional uint64 total_compacting_KVs = 10
* the total compacting key values in currently running compaction
optional uint64 current_compacted_KVs = 11
* the completed count of key values in currently running compaction
optional uint32 root_index_size_KB = 12
* The current total size of root-level indexes for the region, in KB.
optional uint32 total_static_index_size_KB = 13
* The total size of all index blocks, not just the root level, in KB.
optional uint32 total_static_bloom_size_KB = 14
* The total size of all Bloom filter blocks, not just loaded into the block cache, in KB.
optional uint64 complete_sequence_id = 15
* the most recent sequence Id from cache flush
optional float data_locality = 16
* The current data locality for region in the regionserver
optional uint64 last_major_compaction_ts = 17
repeated store_complete_sequence_id = 18
* the most recent sequence Id of store from cache flush
message
Client.proto:399Statistics about the current load on the region
Used in:
optional int32 memstoreLoad = 1
Percent load on the memstore. Guaranteed to be positive, between 0 and 100.
optional int32 heapOccupancy = 2
Percent JVM heap occupancy. Guaranteed to be positive, between 0 and 100. We can move this to "ServerLoadStats" should we develop them.
optional int32 compactionPressure = 3
Compaction pressure. Guaranteed to be positive, between 0 and 100.
message
RegionNormalizer.proto:26optional bool normalizer_on = 1
message
HBase.proto:234* Description of the region server info
optional int32 infoPort = 1
optional version_info = 2
message
HBase.proto:83* Container protocol buffer to specify a region. You can specify region by region name, or the hash of the region name, which is known as encoded region name.
Used in: , , , , , , , , , , , , , , , , , , , , ,
required RegionSpecifier.RegionSpecifierType type = 1
required bytes value = 2
Used in:
REGION_NAME = 1
<tablename>,<startkey>,<regionId>.<encodedName>
ENCODED_REGION_NAME = 2
hash of <tablename>,<startkey>,<regionId>
message
ClusterStatus.proto:30Used in:
required region_info = 1
required RegionState.State state = 2
optional uint64 stamp = 3
Used in: ,
OFFLINE = 0
region is in an offline state
PENDING_OPEN = 1
sent rpc to server to open but has not begun
OPENING = 2
server has begun to open but not yet done
OPEN = 3
server opened region and updated meta
PENDING_CLOSE = 4
sent rpc to server to close but has not begun
CLOSING = 5
server has begun to close but not yet done
CLOSED = 6
server closed region and updated meta
SPLITTING = 7
server started split of a region
SPLIT = 8
server completed split of a region
FAILED_OPEN = 9
failed to open, and won't retry any more
FAILED_CLOSE = 10
failed to close, and won't retry any more
MERGING = 11
server started merge a region
MERGED = 12
server completed merge of a region
SPLITTING_NEW = 13
new region to be created when RS splits a parent
MERGING_NEW = 14
region but hasn't be created yet, or master doesn't know it's already created
new region to be created when RS merges two
message
RegionServerStatus.proto:87Used in:
required RegionStateTransition.TransitionCode transition_code = 1
repeated region_info = 2
* Mutliple regions are involved during merging/splitting
optional uint64 open_seq_num = 3
* For newly opened region, the open seq num is needed
Used in:
OPENED = 0
FAILED_OPEN = 1
CLOSED = 2
* No failed_close, in which case region server will abort
READY_TO_SPLIT = 3
* Ask master for ok to split/merge region(s)
READY_TO_MERGE = 4
SPLIT_PONR = 5
MERGE_PONR = 6
SPLIT = 7
MERGED = 8
SPLIT_REVERTED = 9
MERGE_REVERTED = 10
message
ClusterStatus.proto:74* contains a sequence id of a region which should be the minimum of its store sequence ids and list of sequence ids of the region's stores
required uint64 last_flushed_sequence_id = 1
repeated store_sequence_id = 2
message
ZooKeeper.proto:71* What we write under unassigned up in zookeeper as a region moves through open/close, etc., regions. Details a region in transition.
required uint32 event_type_code = 1
Code for EventType gotten by doing o.a.h.h.EventHandler.EventType.getCode()
required bytes region_name = 2
Full regionname in bytes
required uint64 create_time = 3
required server_name = 4
The region server where the transition will happen or is happening
optional bytes payload = 5
message
Admin.proto:211* Replicates the given entries. The guarantee is that the given entries will be durable on the slave cluster if this method returns without any exception. hbase.replication has to be set to true for this to work.
Used as request type in: AdminService.Replay, AdminService.ReplicateWALEntry
repeated entry = 1
message
Admin.proto:215Used as response type in: AdminService.Replay, AdminService.ReplicateWALEntry
(message has no fields)
message
ZooKeeper.proto:147* Used by replication. Holds the current position in an WAL file.
required int64 position = 1
message
ClusterStatus.proto:142Used in:
required uint64 ageOfLastAppliedOp = 1
required uint64 timeStampsOfLastAppliedOp = 2
message
ClusterStatus.proto:147Used in:
required string peerID = 1
required uint64 ageOfLastShippedOp = 2
required uint32 sizeOfLogQueue = 3
required uint64 timeStampOfLastShippedOp = 4
required uint64 replicationLag = 5
message
ZooKeeper.proto:154* Used by replication. Used to lock a region server during failover.
required string lock_owner = 1
message
ZooKeeper.proto:124* Used by replication. Holds a replication peer key.
required string clusterkey = 1
clusterkey is the concatenation of the slave cluster's hbase.zookeeper.quorum:hbase.zookeeper.property.clientPort:zookeeper.znode.parent
optional string replicationEndpointImpl = 2
repeated data = 3
repeated configuration = 4
message
ZooKeeper.proto:136* Used by replication. Holds whether enabled or disabled
required ReplicationState.State state = 1
Used in:
ENABLED = 0
DISABLED = 1
message
RPC.proto:114Header sent making a request.
optional uint32 call_id = 1
Monotonically increasing call_id to keep track of RPC requests and their response
optional trace_info = 2
optional string method_name = 3
optional bool request_param = 4
If true, then a pb Message param follows.
optional cell_block_meta = 5
If present, then an encoded data block follows.
optional uint32 priority = 6
0 is NORMAL priority. 200 is HIGH. If no priority, treat it as NORMAL. See HConstants.
message
RPC.proto:128optional uint32 call_id = 1
optional exception = 2
If present, then request threw an exception and no response message (else we presume one)
optional cell_block_meta = 3
If present, then an encoded data block follows.
message
Client.proto:92Used in: , , ,
repeated cell = 1
Result includes the Cells or else it just has a count of Cells that are carried otherwise.
optional int32 associated_cell_count = 2
The below count is set when the associated cells are not part of this protobuf message; they are passed alongside and then this Message is just a placeholder with metadata. The count is needed to know how many to peel off the block of Cells as ours. NOTE: This is different from the pb managed cell_count of the 'cell' field above which is non-null when the cells are pb'd.
optional bool exists = 3
used for Get to check existence only. Not set if existence_only was not set to true in the query.
optional bool stale = 4
Whether or not the results are coming from possibly stale data
optional bool partial = 5
Whether or not the entire result could be returned. Results will be split when the RPC chunk size limit is reached. Partial results contain only a subset of the cells for a row and must be combined with a result containing the remaining cells to form a complete result
message
Client.proto:414* Either a Result or an Exception NameBytesPair (keyed by exception name whose value is the exception stringified) or maybe empty if no result and no exception.
Used in:
optional uint32 index = 1
If part of a multi call, save original index of the list of all passed so can align this response w/ original request.
optional result = 2
optional exception = 3
optional service_result = 4
result if this was a coprocessor service call
optional loadStats = 5
current load on the region
message
Filter.proto:125required compare_filter = 1
message
Filter.proto:160Used in:
optional bytes start_row = 1
optional bool start_row_inclusive = 2
optional bytes stop_row = 3
optional bool stop_row_inclusive = 4
message
Client.proto:241* Instead of get from a table, you can scan it with optional filters. You can specify the row key range, time range, the columns/families to scan and so on. This scan is used the first time in a scan request. The response of the initial scan will return a scanner id, which should be used to fetch result batches later on before it is closed.
Used in: ,
repeated column = 1
repeated attribute = 2
optional bytes start_row = 3
optional bytes stop_row = 4
optional filter = 5
optional time_range = 6
optional uint32 max_versions = 7
optional bool cache_blocks = 8
optional uint32 batch_size = 9
optional uint64 max_result_size = 10
optional uint32 store_limit = 11
optional uint32 store_offset = 12
optional bool load_column_families_on_demand = 13
DO NOT add defaults to load_column_families_on_demand.
optional bool small = 14
optional bool reversed = 15
optional Consistency consistency = 16
optional uint32 caching = 17
optional bool allow_partial_results = 18
repeated cf_time_range = 19
message
MapReduce.proto:28Used in:
repeated metrics = 1
Used in:
REPLICATION_SCOPE_LOCAL = 0
REPLICATION_SCOPE_GLOBAL = 1
Used in:
SIMPLE_AUTHENTICATION = 0
SECURE_AUTHENTICATION = 1
AUTHORIZATION = 2
CELL_AUTHORIZATION = 3
CELL_VISIBILITY = 4
message
Procedure.proto:66* SequentialProcedure data
required bool executed = 1
SERVER_CRASH_START = 1
SERVER_CRASH_PROCESS_META = 2
SERVER_CRASH_GET_REGIONS = 3
SERVER_CRASH_NO_SPLIT_LOGS = 4
SERVER_CRASH_SPLIT_LOGS = 5
SERVER_CRASH_PREPARE_LOG_REPLAY = 6
SERVER_CRASH_ASSIGN = 8
Removed SERVER_CRASH_CALC_REGIONS_TO_ASSIGN = 7;
SERVER_CRASH_WAIT_ON_ASSIGN = 9
SERVER_CRASH_FINISH = 100
message
MasterProcedure.proto:187required server_name = 1
optional bool distributed_log_replay = 2
repeated regions_on_crashed_server = 3
repeated regions_assigned = 4
optional bool carrying_meta = 5
optional bool should_split_wal = 6
message
Admin.proto:240Used in:
required server_name = 1
optional uint32 webui_port = 2
message
ClusterStatus.proto:155Used in: ,
optional uint64 number_of_requests = 1
* Number of requests since last report.
optional uint64 total_number_of_requests = 2
* Total Number of requests from the start of the region server.
optional uint32 used_heap_MB = 3
* the amount of used heap, in MB.
optional uint32 max_heap_MB = 4
* the maximum allowable size of the heap, in MB.
repeated region_loads = 5
* Information on the load of individual regions.
repeated coprocessors = 6
* Regionserver-level coprocessors, e.g., WALObserver implementations. Region-level coprocessors, on the other hand, are stored inside RegionLoad objects.
optional uint64 report_start_time = 7
* Time when incremental (non-total) counts began being calculated (e.g. number_of_requests) time is measured as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
optional uint64 report_end_time = 8
* Time when report was generated. time is measured as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
optional uint32 info_server_port = 9
* The port number that this region server is hosing an info server on.
repeated replLoadSource = 10
* The replicationLoadSource for the replication Source status of this region server.
optional replLoadSink = 11
* The replicationLoadSink for the replication Sink status of this region server.
message
HBase.proto:127* Protocol buffer version of ServerName
Used in: , , , , , , , , , , , , , , , , ,
required string host_name = 1
optional uint32 port = 2
optional uint64 start_code = 3
message
VisibilityLabels.proto:40Used as request type in: VisibilityLabelsService.clearAuths, VisibilityLabelsService.setAuths
required bytes user = 1
repeated bytes auth = 2
message
Filter.proto:129required single_column_value_filter = 1
message
Filter.proto:133Used in:
optional bytes column_family = 1
optional bytes column_qualifier = 2
required CompareType compare_op = 3
required comparator = 4
optional bool filter_if_missing = 5
optional bool latest_version_only = 6
message
Filter.proto:142required filter = 1
message
Snapshot.proto:61required table_schema = 1
repeated region_manifests = 2
message
HBase.proto:162* Description of the snapshot to take
Used in: , , , , , ,
required string name = 1
optional string table = 2
not needed for delete, but checked for in taking snapshot
optional int64 creation_time = 3
optional SnapshotDescription.Type type = 4
optional int32 version = 5
optional string owner = 6
Used in:
DISABLED = 0
FLUSH = 1
SKIPFLUSH = 2
message
Snapshot.proto:27required SnapshotFileInfo.Type type = 1
optional string hfile = 3
optional string wal_server = 4
optional string wal_name = 5
Used in:
HFILE = 1
WAL = 2
message
Snapshot.proto:41Used in:
optional int32 version = 1
required region_info = 2
repeated family_files = 3
message
Snapshot.proto:55Used in:
required bytes family_name = 1
repeated store_files = 2
message
Snapshot.proto:47Used in:
required string name = 1
optional reference = 2
optional uint64 file_size = 3
TODO: Add checksums or other fields to verify the file
message
ZooKeeper.proto:86* WAL SplitLog directory znodes have this for content. Used doing distributed WAL splitting. Holds current state and name of server that originated split.
required SplitLogTask.State state = 1
required server_name = 2
optional SplitLogTask.RecoveryMode mode = 3
Used in:
UNKNOWN = 0
LOG_SPLITTING = 1
LOG_REPLAY = 2
Used in:
UNASSIGNED = 0
OWNED = 1
RESIGNED = 2
DONE = 3
ERR = 4
message
ErrorHandling.proto:30* Protobuf version of a java.lang.StackTraceElement so we can serialize exceptions.
Used in:
optional string declaring_class = 1
optional string method_name = 2
optional string file_name = 3
optional int32 line_number = 4
message
Procedure.proto:73* StateMachineProcedure data
repeated uint32 state = 1
message
WAL.proto:129Used in: ,
required bytes family_name = 1
required string store_home_dir = 2
relative to region dir
repeated string store_file = 3
relative to store dir
message
ClusterStatus.proto:65* sequence Id of a store
Used in: , ,
required bytes family_name = 1
required uint64 sequence_id = 2
message
Comparator.proto:71required string substr = 1
message
ZooKeeper.proto:107* The znode that holds state of table.
required Table.State state = 1
This is the table's state. If no znode for a table, its state is presumed enabled. See o.a.h.h.zookeeper.ZKTable class for more.
Table's current state
Used in:
ENABLED = 0
DISABLED = 1
DISABLING = 2
ENABLING = 3
message
ZooKeeper.proto:161* Metadata associated with a table lock in zookeeper
optional table_name = 1
optional lock_owner = 2
optional int64 thread_id = 3
optional bool is_shared = 4
optional string purpose = 5
optional int64 create_time = 6
message
HBase.proto:31* Table Name
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , ,
required bytes namespace = 1
required bytes qualifier = 2
message
AccessControl.proto:46Used in:
optional table_name = 1
optional bytes family = 2
optional bytes qualifier = 3
repeated Permission.Action action = 4
message
HBase.proto:40* Table Schema Inspired by the rest TableSchema
Used in: , , , , , , , , , , ,
optional table_name = 1
repeated attributes = 2
repeated column_families = 3
repeated configuration = 4
message
MapReduce.proto:32repeated string locations = 2
optional table = 3
optional region = 4
message
Quota.proto:47Used in:
optional req_num = 1
optional req_size = 2
optional write_num = 3
optional write_size = 4
optional read_num = 5
optional read_size = 6
message
Quota.proto:58Used in:
optional ThrottleType type = 1
optional timed_quota = 2
Used in:
REQUEST_NUMBER = 1
REQUEST_SIZE = 2
WRITE_NUMBER = 3
WRITE_SIZE = 4
READ_NUMBER = 5
READ_SIZE = 6
message
HBase.proto:102* A range of time. Both from and to are Java time stamp in milliseconds. If you don't specify a time range, it means all time. By default, if not specified, from = 0, and to = Long.MAX_VALUE
Used in: , , ,
optional uint64 from = 1
optional uint64 to = 2
Used in:
NANOSECONDS = 1
MICROSECONDS = 2
MILLISECONDS = 3
SECONDS = 4
MINUTES = 5
HOURS = 6
DAYS = 7
message
Quota.proto:31Used in: ,
required TimeUnit time_unit = 1
optional uint64 soft_limit = 2
optional float share = 3
optional QuotaScope scope = 4
message
Filter.proto:146repeated int64 timestamps = 1
message
Authentication.proto:47Serialization of the org.apache.hadoop.security.token.Token class Note that this is a Hadoop class, so fields may change!
Used in:
optional bytes identifier = 1
the TokenIdentifier in serialized form Note: we can't use the protobuf directly because the Hadoop Token class only stores the serialized bytes
optional bytes password = 2
optional bytes service = 3
message
Authentication.proto:32required TokenIdentifier.Kind kind = 1
required bytes username = 2
required int32 key_id = 3
optional int64 issue_date = 4
optional int64 expiration_date = 5
optional int64 sequence_number = 6
Used in:
HBASE_AUTH_TOKEN = 0
TRUNCATE_TABLE_PRE_OPERATION = 1
TRUNCATE_TABLE_REMOVE_FROM_META = 2
TRUNCATE_TABLE_CLEAR_FS_LAYOUT = 3
TRUNCATE_TABLE_CREATE_FS_LAYOUT = 4
TRUNCATE_TABLE_ADD_TO_META = 5
TRUNCATE_TABLE_ASSIGN_REGIONS = 6
TRUNCATE_TABLE_POST_OPERATION = 7
message
MasterProcedure.proto:88required user_info = 1
required bool preserve_splits = 2
optional table_name = 3
optional table_schema = 4
repeated region_info = 5
message
HBase.proto:211Used in:
required uint64 least_sig_bits = 1
required uint64 most_sig_bits = 2
message
Admin.proto:169Used in:
required region = 1
repeated favored_nodes = 2
message
VisibilityLabels.proto:45Used in:
required bytes user = 1
repeated uint32 auth = 2
message
RPC.proto:74User Information proto. Included in ConnectionHeader on connection setup
Used in: , , , , , , , , ,
required string effective_user = 1
optional string real_user = 2
message
AccessControl.proto:62Used in: , ,
required bytes user = 1
required permission = 3
message
AccessControl.proto:70* Content of the /hbase/acl/<table or namespace> znode.
repeated user_permissions = 1
message
AccessControl.proto:71Used in:
required bytes user = 1
repeated permissions = 2
message
Filter.proto:150required compare_filter = 1
message
HBase.proto:222Rpc client version info proto. Included in ConnectionHeader on connection setup
Used in: ,
required string version = 1
required string url = 2
required string revision = 3
required string user = 4
required string date = 5
required string src_checksum = 6
message
VisibilityLabels.proto:31Used in:
required bytes label = 1
optional uint32 ordinal = 2
message
VisibilityLabels.proto:36Used as response type in: VisibilityLabelsService.addLabels, VisibilityLabelsService.clearAuths, VisibilityLabelsService.setAuths
repeated result = 1
message
Admin.proto:196Protocol buffer version of WAL for replication
Used in:
required key = 1
repeated bytes key_value_bytes = 2
Following may be null if the KVs/Cells are carried along the side in a cellblock (See RPC for more on cellblocks). If Cells/KVs are in a cellblock, this next field is null and associated_cell_count has count of Cells associated w/ this WALEntry
optional int32 associated_cell_count = 3
If Cell data is carried alongside in a cellblock, this is count of Cells in the cellblock.
message
WAL.proto:27optional bool has_compression = 1
optional bytes encryption_key = 2
optional bool has_tag_compression = 3
optional string writer_cls_name = 4
optional string cell_codec_cls_name = 5
message
WAL.proto:39Protocol buffer version of WALKey; see WALKey comment, not really a key but WALEdit header for some KVs
Used in:
required bytes encoded_region_name = 1
required bytes table_name = 2
required uint64 log_sequence_number = 3
required uint64 write_time = 4
optional cluster_id = 5
This parameter is deprecated in favor of clusters which contains the list of clusters that have consumed the change. It is retained so that the log created by earlier releases (0.94) can be read by the newer releases.
repeated scopes = 6
optional uint32 following_kv_count = 7
repeated cluster_ids = 8
This field contains the list of clusters that have consumed the change
optional uint64 nonceGroup = 9
optional uint64 nonce = 10
optional uint64 orig_sequence_number = 11
message
WAL.proto:169* A trailer that is appended to the end of a properly closed WAL file. If missing, this is either a legacy or a corrupted WAL file. N.B. This trailer currently doesn't contain any information and we purposefully don't expose it in the WAL APIs. It's for future growth.
(message has no fields)
message
Filter.proto:154required filter = 1
message
Encryption.proto:26required string algorithm = 1
required uint32 length = 2
required bytes data = 3
optional bytes iv = 4
optional bytes hash = 5