Interface Protocol.ErrorMessageOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Protocol.ErrorMessage, Protocol.ErrorMessage.Builder
    Enclosing class:
    Protocol

    public static interface Protocol.ErrorMessageOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getCode()
      The code can be any HTTP status code, as described https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml.
      java.lang.String getDescription()
      Contains a verbose error description, e.g.
      com.google.protobuf.ByteString getDescriptionBytes()
      Contains a verbose error description, e.g.
      java.lang.String getMessage()
      Contains a concise error message, e.g.
      com.google.protobuf.ByteString getMessageBytes()
      Contains a concise error message, e.g.
      int getRelatedEntryIndex()
      Entry that caused the failure.
      java.lang.String getRelatedEntryName()
      Name of the entry that caused the failure.
      com.google.protobuf.ByteString getRelatedEntryNameBytes()
      Name of the entry that caused the failure.
      int getRelatedEntryType()
      Entry type.
      boolean hasRelatedEntryIndex()
      Entry that caused the failure.
      boolean hasRelatedEntryName()
      Name of the entry that caused the failure.
      boolean hasRelatedEntryType()
      Entry type.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getCode

        int getCode()
         The code can be any HTTP status code, as described https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml.
         In addition, we define the following error codes that MAY be used by the SDK for better error reporting:
         * JOURNAL_MISMATCH = 570, that is when the SDK cannot replay a journal due to the mismatch between the journal and the actual code.
         * PROTOCOL_VIOLATION = 571, that is when the SDK receives an unexpected message or an expected message variant, given its state.
         
        uint32 code = 1;
        Returns:
        The code.
      • getMessage

        java.lang.String getMessage()
         Contains a concise error message, e.g. Throwable#getMessage() in Java.
         
        string message = 2;
        Returns:
        The message.
      • getMessageBytes

        com.google.protobuf.ByteString getMessageBytes()
         Contains a concise error message, e.g. Throwable#getMessage() in Java.
         
        string message = 2;
        Returns:
        The bytes for message.
      • getDescription

        java.lang.String getDescription()
         Contains a verbose error description, e.g. the exception stacktrace.
         
        string description = 3;
        Returns:
        The description.
      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Contains a verbose error description, e.g. the exception stacktrace.
         
        string description = 3;
        Returns:
        The bytes for description.
      • hasRelatedEntryIndex

        boolean hasRelatedEntryIndex()
         Entry that caused the failure. This may be outside the current stored journal size.
         If no specific entry caused the failure, the current replayed/processed entry can be used.
         
        optional uint32 related_entry_index = 4;
        Returns:
        Whether the relatedEntryIndex field is set.
      • getRelatedEntryIndex

        int getRelatedEntryIndex()
         Entry that caused the failure. This may be outside the current stored journal size.
         If no specific entry caused the failure, the current replayed/processed entry can be used.
         
        optional uint32 related_entry_index = 4;
        Returns:
        The relatedEntryIndex.
      • hasRelatedEntryName

        boolean hasRelatedEntryName()
         Name of the entry that caused the failure.
         
        optional string related_entry_name = 5;
        Returns:
        Whether the relatedEntryName field is set.
      • getRelatedEntryName

        java.lang.String getRelatedEntryName()
         Name of the entry that caused the failure.
         
        optional string related_entry_name = 5;
        Returns:
        The relatedEntryName.
      • getRelatedEntryNameBytes

        com.google.protobuf.ByteString getRelatedEntryNameBytes()
         Name of the entry that caused the failure.
         
        optional string related_entry_name = 5;
        Returns:
        The bytes for relatedEntryName.
      • hasRelatedEntryType

        boolean hasRelatedEntryType()
         Entry type.
         
        optional uint32 related_entry_type = 6;
        Returns:
        Whether the relatedEntryType field is set.
      • getRelatedEntryType

        int getRelatedEntryType()
         Entry type.
         
        optional uint32 related_entry_type = 6;
        Returns:
        The relatedEntryType.