hbase-protocol-shaded/src/main/protobuf/BucketCacheEntry.proto

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 syntax = "proto2";
  19
  20 package hbase.pb;
  21
  22 option java_package = "org.apache.hadoop.hbase.shaded.protobuf.generated";
  23 option java_outer_classname = "BucketCacheProtos";
  24 option java_generic_services = true;
  25 option java_generate_equals_and_hash = true;
  26 option optimize_for = SPEED;
  27
  28 message BucketCacheEntry {
  29   required int64 cache_capacity = 1;
  30   required string io_class = 2;
  31   required string map_class = 3;
  32   map<int32, string> deserializers = 4;
  33   required BackingMap backing_map = 5;
  34   optional bytes checksum = 6;
  35 }
  36
  37 message BackingMap {
  38   repeated BackingMapEntry entry = 1;
  39 }
  40
  41 message BackingMapEntry {
  42   required BlockCacheKey key = 1;
  43   required BucketEntry value = 2;
  44 }
  45
  46 message BlockCacheKey {
  47   required string hfilename = 1;
  48   required int64 offset = 2;
  49   required BlockType block_type = 3;
  50   required bool primary_replica_block = 4;
  51 }
  52
  53 enum BlockType {
  54   data = 0;
  55   encoded_data = 1;
  56   leaf_index = 2;
  57   bloom_chunk = 3;
  58   meta = 4;
  59   intermediate_index = 5;
  60   root_index = 6;
  61   file_info = 7;
  62   general_bloom_meta = 8;
  63   delete_family_bloom_meta = 9;
  64   trailer = 10;
  65   index_v1 = 11;
  66 }
  67
  68 message BucketEntry {
  69   required int64 offset = 1;
  70   required int32 length = 2;
  71   required int64 access_counter = 3;
  72   required int32 deserialiser_index = 4;
  73   required BlockPriority priority = 5;
  74 }
  75
  76 enum BlockPriority {
  77   single = 0;
  78   multi = 1;
  79   memory = 2;
  80 }