Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Get (GetRequest, GetResponse)

  Client.proto:462

  message GetRequest

  Client.proto:121

  * The get request. Perform a single Get operation.

  • required RegionSpecifier region = 1

  • required Get get = 2

  message GetResponse

  Client.proto:126

  • optional Result result = 1

• rpc Mutate (MutateRequest, MutateResponse)

  Client.proto:465

  message MutateRequest

  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 RegionSpecifier region = 1

  • required MutationProto mutation = 2

  • optional Condition condition = 3

  • optional uint64 nonce_group = 4

  message MutateResponse

  Client.proto:225

  • optional Result result = 1

  • optional bool processed = 2

    used for mutate to indicate processed only

• rpc Scan (ScanRequest, ScanResponse)

  Client.proto:468

  message ScanRequest

  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 RegionSpecifier region = 1

  • optional Scan 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 ScanResponse

  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 Result 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 ScanMetrics 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.

• rpc BulkLoadHFile (BulkLoadHFileRequest, BulkLoadHFileResponse)

  Client.proto:471

  message BulkLoadHFileRequest

  Client.proto:340

  * Atomically bulk load multiple HFiles (say from different column families) into an open region.

  • required RegionSpecifier region = 1

  • repeated BulkLoadHFileRequest.FamilyPath family_path = 2

  • optional bool assign_seq_num = 3

  message BulkLoadHFileResponse

  Client.proto:351

  • required bool loaded = 1

• rpc ExecService (CoprocessorServiceRequest, CoprocessorServiceResponse)

  Client.proto:474

• rpc ExecRegionServerService (CoprocessorServiceRequest, CoprocessorServiceResponse)

  Client.proto:477

• rpc Multi (MultiRequest, MultiResponse)

  Client.proto:480

  message MultiRequest

  Client.proto:447

  * 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 regionAction = 1

  • optional uint64 nonceGroup = 2

  • optional Condition condition = 3

  message MultiResponse

  Client.proto:453

  • repeated RegionActionResult regionActionResult = 1

  • optional bool processed = 2

    used for mutate to indicate processed only

  • optional MultiRegionLoadStats regionStatistics = 3

• rpc MutateRows (MutateRowsRequest, MutateRowsResponse)

  MultiRowMutation.proto:41

  message MutateRowsRequest

  MultiRowMutation.proto:31

  • repeated MutationProto mutation_request = 1

  • optional uint64 nonce_group = 2

  • optional uint64 nonce = 3

  message MutateRowsResponse

  MultiRowMutation.proto:37

  (message has no fields)

Either a Get or a Mutation

Used in: RegionAction

• optional uint32 index = 1

  If part of a multi action, useful aligning result with what was originally submitted.

• optional MutationProto mutation = 2

• optional Get get = 3

• optional CoprocessorServiceCall service_call = 4

* The protocol buffer version of Authorizations.

• repeated string label = 1

• required bytes bigdecimal_msg = 1

• required ByteArrayComparable comparable = 1

• required ByteArrayComparable comparable = 1

• required ByteArrayComparable comparable = 1

• required BitComparator.BitwiseOp bitwise_op = 2

Used in: BitComparator

• AND = 1

• OR = 2

• XOR = 3

Used in: BulkLoadHFileRequest

• required bytes family = 1

• required string path = 2

Used in: BinaryComparator, BinaryPrefixComparator, BitComparator, LongComparator

• optional bytes value = 1

Used in: ColumnFamilySchema, FuzzyRowFilter, ReplicationPeer, TableSchema

• required bytes first = 1

• required bytes second = 2

* Protocol buffer version of Cell.

Used in: Result

• 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

Optional Cell block Message. Included in client RequestHeader

Used in: RequestHeader, ResponseHeader

• 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: Cell, KeyValue

• 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.

* The protocol buffer version of CellVisibility.

• required string expression = 1

* Content of the '/hbase/hbaseid', cluster id, znode. Also cluster of the ${HBASE_ROOTDIR}/hbase.id file.

Used in: ClusterStatus

• required string cluster_id = 1

  This is the cluster id, a uuid as a String

• optional HBaseVersionFileContent hbase_version = 1

• repeated LiveServerInfo live_servers = 2

• repeated ServerName dead_servers = 3

• repeated RegionInTransition regions_in_transition = 4

• optional ClusterId cluster_id = 5

• repeated Coprocessor master_coprocessors = 6

• optional ServerName master = 7

• repeated ServerName backup_masters = 8

• optional bool balancer_on = 9

* 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.

* Container for a list of column qualifier names of a family.

Used in: Get, Scan

• required bytes family = 1

• repeated bytes qualifier = 2

• required int32 limit = 1

* Column Family Schema Inspired by the rest ColumSchemaMessage

Used in: TableSchema

• required bytes name = 1

• repeated BytesBytesPair attributes = 2

• repeated NameStringPair configuration = 3

ColumnFamily Specific TimeRange

Used in: Get, Scan

• required bytes column_family = 1

• required TimeRange time_range = 2

• required int32 limit = 1

• optional int32 offset = 2

• optional bytes column_offset = 3

• required bytes prefix = 1

• optional bytes min_column = 1

• optional bool min_column_inclusive = 2

• optional bytes max_column = 3

• optional bool max_column_inclusive = 4

Used in: CompareFilter, Condition, SingleColumnValueFilter

• required string name = 1

• optional bytes serialized_comparator = 2

Used in: DependentColumnFilter, FamilyFilter, QualifierFilter, RowFilter, ValueFilter

• required CompareType compare_op = 1

• optional Comparator comparator = 2

Comparison operators

Used in: CompareFilter, Condition, SingleColumnValueFilter

• LESS = 0

• LESS_OR_EQUAL = 1

• EQUAL = 2

• NOT_EQUAL = 3

• GREATER_OR_EQUAL = 4

• GREATER = 5

• NO_OP = 6

* 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: MultiRequest, MutateRequest

• required bytes row = 1

• required bytes family = 2

• required bytes qualifier = 3

• required CompareType compare_type = 4

• required Comparator comparator = 5

This is sent on connection setup after the connection preamble is sent.

• optional UserInformation 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 VersionInfo version_info = 5

* Consistency defines the expected consistency level for an operation.

Used in: Get, Scan

• STRONG = 0

• TIMELINE = 1

Used in: ClusterStatus, ServerLoad

• required string name = 1

Used in: Action, CoprocessorServiceRequest

• required bytes row = 1

• required string service_name = 2

• required string method_name = 3

• required bytes request = 4

Used as request type in: ClientService.ExecRegionServerService, ClientService.ExecService

• required RegionSpecifier region = 1

• required CoprocessorServiceCall call = 2

Used as response type in: ClientService.ExecRegionServerService, ClientService.ExecService

• required RegionSpecifier region = 1

• required NameBytesPair value = 2

Used in: ResultOrException

• optional NameBytesPair value = 1

• required CompareFilter compare_filter = 1

• optional bytes column_family = 2

• optional bytes column_qualifier = 3

• optional bool drop_dependent_column = 4

• required double double_msg = 1

(message has no fields)

At the RPC layer, this message is used to carry the server side exception to the RPC client.

Used in: ResponseHeader

• 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

• required CompareFilter compare_filter = 1

* Protocol buffer for favored nodes

• repeated ServerName favored_node = 1

Used in: FilterList, FilterWrapper, Get, Scan, SkipFilter, WhileMatchFilter

• required string name = 1

• optional bytes serialized_filter = 2

(message has no fields)

• required FilterList.Operator operator = 1

• repeated Filter filters = 2

Used in: FilterList

• MUST_PASS_ALL = 1

• MUST_PASS_ONE = 2

• required Filter filter = 1

(message has no fields)

• repeated bytes qualifiers = 1

* Exception sent across the wire when a remote task needs to notify other tasks that it failed and why

• optional string source = 1

• optional GenericExceptionMessage generic_exception = 2

• repeated BytesBytesPair fuzzy_keys_data = 1

* 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: ForeignExceptionMessage

• optional string class_name = 1

• optional string message = 2

• optional bytes error_info = 3

• repeated StackTraceElementMessage trace = 4

* 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: Action, GetRequest

• required bytes row = 1

• repeated Column column = 2

• repeated NameBytesPair attribute = 3

• optional Filter filter = 4

• optional TimeRange 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 ColumnFamilyTimeRange cf_time_range = 13

* The ${HBASE_ROOTDIR}/hbase.version file content

Used in: ClusterStatus

• required string version = 1

• optional bytes stop_row_key = 1

• required bool len_as_val = 1

* 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

Used in: ClusterStatus

• required ServerName server = 1

• required ServerLoad server_load = 2

• required ByteArrayComparable comparable = 1

• required int64 long_msg = 1

* Content of the master znode.

• required ServerName 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

* Content of the meta-region-server znode.

• required ServerName 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'

Used in: MultiResponse

• repeated RegionSpecifier region = 1

• repeated RegionLoadStats stat = 2

(message has no fields)

(message has no fields)

• repeated RowRange row_range_list = 1

• repeated bytes sorted_prefixes = 1

* 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: Action, MutateRequest, MutateRowsRequest

• optional bytes row = 1

• optional MutationProto.MutationType mutate_type = 2

• repeated MutationProto.ColumnValue column_value = 3

• optional uint64 timestamp = 4

• repeated NameBytesPair attribute = 5

• optional MutationProto.Durability durability = 6

• optional TimeRange 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

Used in: MutationProto

• required bytes family = 1

• repeated ColumnValue.QualifierValue qualifier_value = 2

Used in: ColumnValue

• optional bytes qualifier = 1

• optional bytes value = 2

• optional uint64 timestamp = 3

• optional DeleteType delete_type = 4

• optional bytes tags = 5

Used in: ColumnValue.QualifierValue

• DELETE_ONE_VERSION = 0

• DELETE_MULTIPLE_VERSIONS = 1

• DELETE_FAMILY = 2

• DELETE_FAMILY_VERSION = 3

Used in: MutationProto

• USE_DEFAULT = 0

• SKIP_WAL = 1

• ASYNC_WAL = 2

• SYNC_WAL = 3

• FSYNC_WAL = 4

Used in: MutationProto

• APPEND = 0

• INCREMENT = 1

• PUT = 2

• DELETE = 3

Used in: CoprocessorServiceResponse, CoprocessorServiceResult, Get, MutationProto, RegionActionResult, ResultOrException, Scan

• required string name = 1

• optional bytes value = 2

Used in: ScanMetrics

• optional string name = 1

• optional int64 value = 2

Used in: ColumnFamilySchema, NamespaceDescriptor, ProcedureDescription, ReplicationPeer, TableSchema

• required string name = 1

• required string value = 2

• required bytes name = 1

• repeated NameStringPair configuration = 2

(message has no fields)

• required int64 page_size = 1

• optional bytes prefix = 1

* Description of the distributed procedure to take

• required string signature = 1

  the unique signature of the procedure

• optional string instance = 2

  the procedure instance name

• optional int64 creation_time = 3

• repeated NameStringPair configuration = 4

• required CompareFilter compare_filter = 1

Used 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: RequestHeader

• optional int64 trace_id = 1

• optional int64 parent_id = 2

• required float chance = 1

* Reference file content used when we split an hfile under a region.

• required bytes splitkey = 1

• required Reference.Range range = 2

Used in: Reference

• TOP = 0

• BOTTOM = 1

• required string pattern = 1

• required int32 pattern_flags = 2

• required string charset = 3

• optional string engine = 4

* Actions to run against a Region.

Used in: MultiRequest

• required RegionSpecifier region = 1

• optional bool atomic = 2

  When set, run mutations as atomic unit.

• repeated Action action = 3

* The result of a RegionAction.

Used in: MultiResponse

• repeated ResultOrException resultOrException = 1

• optional NameBytesPair exception = 2

  If the operation failed globally for this region, this exception is set

Used in: ClusterStatus

• required RegionSpecifier spec = 1

• required RegionState region_state = 2

* Protocol buffer version of HRegionInfo.

Used in: RegionState, TableSnapshotRegionSplit

• required uint64 region_id = 1

• required TableName 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

Used in: ServerLoad

• required RegionSpecifier 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 StoreSequenceId store_complete_sequence_id = 18

  * the most recent sequence Id of store from cache flush

Statistics about the current load on the region

Used in: MultiRegionLoadStats, ResultOrException

• 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.

* Description of the region server info

• optional int32 infoPort = 1

• optional VersionInfo version_info = 2

* 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: BulkLoadHFileRequest, CoprocessorServiceRequest, CoprocessorServiceResponse, GetRequest, MultiRegionLoadStats, MutateRequest, RegionAction, RegionInTransition, RegionLoad, ScanRequest

• required RegionSpecifier.RegionSpecifierType type = 1

• required bytes value = 2

Used in: RegionSpecifier

• REGION_NAME = 1

  <tablename>,<startkey>,<regionId>.<encodedName>

• ENCODED_REGION_NAME = 2

  hash of <tablename>,<startkey>,<regionId>

Used in: RegionInTransition

• required RegionInfo region_info = 1

• required RegionState.State state = 2

• optional uint64 stamp = 3

Used in: MetaRegionServer, RegionState

• 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

* 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 StoreSequenceId store_sequence_id = 2

* 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 ServerName server_name = 4

  The region server where the transition will happen or is happening

• optional bytes payload = 5

* Used by replication. Holds the current position in an WAL file.

• required int64 position = 1

Used in: ServerLoad

• required uint64 ageOfLastAppliedOp = 1

• required uint64 timeStampsOfLastAppliedOp = 2

Used in: ServerLoad

• required string peerID = 1

• required uint64 ageOfLastShippedOp = 2

• required uint32 sizeOfLogQueue = 3

• required uint64 timeStampOfLastShippedOp = 4

• required uint64 replicationLag = 5

* Used by replication. Used to lock a region server during failover.

• required string lock_owner = 1

* 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 BytesBytesPair data = 3

• repeated NameStringPair configuration = 4

* Used by replication. Holds whether enabled or disabled

• required ReplicationState.State state = 1

Used in: ReplicationState

• ENABLED = 0

• DISABLED = 1

Header sent making a request.

• optional uint32 call_id = 1

  Monotonically increasing call_id to keep track of RPC requests and their response

• optional RPCTInfo trace_info = 2

• optional string method_name = 3

• optional bool request_param = 4

  If true, then a pb Message param follows.

• optional CellBlockMeta 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.

• optional uint32 timeout = 7

• optional uint32 call_id = 1

• optional ExceptionResponse exception = 2

  If present, then request threw an exception and no response message (else we presume one)

• optional CellBlockMeta cell_block_meta = 3

  If present, then an encoded data block follows.

Used in: GetResponse, MutateResponse, ResultOrException, ScanResponse

• repeated Cell 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

* 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: RegionActionResult

• 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 result = 2

• optional NameBytesPair exception = 3

• optional CoprocessorServiceResult service_result = 4

  result if this was a coprocessor service call

• optional RegionLoadStats loadStats = 5

  current load on the region

• required CompareFilter compare_filter = 1

Used in: MultiRowRangeFilter

• optional bytes start_row = 1

• optional bool start_row_inclusive = 2

• optional bytes stop_row = 3

• optional bool stop_row_inclusive = 4

* 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: ScanRequest

• repeated Column column = 1

• repeated NameBytesPair attribute = 2

• optional bytes start_row = 3

• optional bytes stop_row = 4

• optional Filter filter = 5

• optional TimeRange 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 ColumnFamilyTimeRange cf_time_range = 19

Used in: ScanResponse

• repeated NameInt64Pair metrics = 1

Used in: LiveServerInfo

• 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 RegionLoad region_loads = 5

  * Information on the load of individual regions.

• repeated Coprocessor 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 ReplicationLoadSource replLoadSource = 10

  * The replicationLoadSource for the replication Source status of this region server.

• optional ReplicationLoadSink replLoadSink = 11

  * The replicationLoadSink for the replication Sink status of this region server.

* Protocol buffer version of ServerName

Used in: ClusterStatus, FavoredNodes, LiveServerInfo, Master, MetaRegionServer, RegionTransition, SplitLogTask, TableLock

• required string host_name = 1

• optional uint32 port = 2

• optional uint64 start_code = 3

• required SingleColumnValueFilter single_column_value_filter = 1

Used in: SingleColumnValueExcludeFilter

• optional bytes column_family = 1

• optional bytes column_qualifier = 2

• required CompareType compare_op = 3

• required Comparator comparator = 4

• optional bool filter_if_missing = 5

• optional bool latest_version_only = 6

• required Filter filter = 1

* Description of the snapshot to take

• 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: SnapshotDescription

• DISABLED = 0

• FLUSH = 1

• SKIPFLUSH = 2

* 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 ServerName server_name = 2

• optional SplitLogTask.RecoveryMode mode = 3

Used in: SplitLogTask

• UNKNOWN = 0

• LOG_SPLITTING = 1

• LOG_REPLAY = 2

Used in: SplitLogTask

• UNASSIGNED = 0

• OWNED = 1

• RESIGNED = 2

• DONE = 3

• ERR = 4

* Protobuf version of a java.lang.StackTraceElement so we can serialize exceptions.

Used in: GenericExceptionMessage

• optional string declaring_class = 1

• optional string method_name = 2

• optional string file_name = 3

• optional int32 line_number = 4

* sequence Id of a store

Used in: RegionLoad, RegionStoreSequenceIds

• required bytes family_name = 1

• required uint64 sequence_id = 2

• required string substr = 1

* State of the switch.

• optional bool enabled = 1

* 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: Table

• ENABLED = 0

• DISABLED = 1

• DISABLING = 2

• ENABLING = 3

* Metadata associated with a table lock in zookeeper

• optional TableName table_name = 1

• optional ServerName lock_owner = 2

• optional int64 thread_id = 3

• optional bool is_shared = 4

• optional string purpose = 5

• optional int64 create_time = 6

* Table Name

Used in: RegionInfo, TableLock, TableSchema

• required bytes namespace = 1

• required bytes qualifier = 2

* Table Schema Inspired by the rest TableSchema

Used in: TableSnapshotRegionSplit

• optional TableName table_name = 1

• repeated BytesBytesPair attributes = 2

• repeated ColumnFamilySchema column_families = 3

• repeated NameStringPair configuration = 4

• repeated string locations = 2

• optional TableSchema table = 3

• optional RegionInfo region = 4

* 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: ColumnFamilyTimeRange, Get, MutationProto, Scan

• optional uint64 from = 1

• optional uint64 to = 2

• NANOSECONDS = 1

• MICROSECONDS = 2

• MILLISECONDS = 3

• SECONDS = 4

• MINUTES = 5

• HOURS = 6

• DAYS = 7

• repeated int64 timestamps = 1

• optional bool can_hint = 2

• required uint64 least_sig_bits = 1

• required uint64 most_sig_bits = 2

User Information proto. Included in ConnectionHeader on connection setup

Used in: ConnectionHeader

• required string effective_user = 1

• optional string real_user = 2

• required CompareFilter compare_filter = 1

Rpc client version info proto. Included in ConnectionHeader on connection setup

Used in: ConnectionHeader, RegionServerInfo

• 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

• optional uint32 version_major = 7

• optional uint32 version_minor = 8

• required Filter filter = 1