hbase-protocol-shaded/src/main/protobuf/ErrorHandling.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 // This file contains protocol buffers that are used for error handling
  21 package hbase.pb;
  22
  23 option java_package = "org.apache.hadoop.hbase.shaded.protobuf.generated";
  24 option java_outer_classname = "ErrorHandlingProtos";
  25 option java_generate_equals_and_hash = true;
  26 option optimize_for = SPEED;
  27
  28 /**
  29  * Protobuf version of a java.lang.StackTraceElement
  30  * so we can serialize exceptions.
  31  */
  32 message StackTraceElementMessage {
  33   optional string declaring_class = 1;
  34   optional string method_name = 2;
  35   optional string file_name = 3;
  36   optional int32 line_number = 4;
  37 }
  38
  39 /**
  40  * Cause of a remote failure for a generic exception. Contains
  41  * all the information for a generic exception as well as
  42  * optional info about the error for generic info passing
  43  * (which should be another protobuffed class).
  44  */
  45 message GenericExceptionMessage {
  46   optional string class_name = 1;
  47   optional string message = 2;
  48   optional bytes error_info = 3;
  49   repeated StackTraceElementMessage trace = 4;
  50 }
  51
  52 /**
  53  * Exception sent across the wire when a remote task needs
  54  * to notify other tasks that it failed and why
  55  */
  56 message ForeignExceptionMessage {
  57   optional string source = 1;
  58   optional GenericExceptionMessage generic_exception = 2;
  59 }