Package ai.blip.deckard

Interface MessageOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Message, Message.Builder
    public interface MessageOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsMetadata​(String key)
      Metadata is a map of string to be used as a key-value store.
      boolean containsPayload​(String key)
      A payload map with formatted data to be stored and used by clients.
      String getBreakpoint()
      Breakpoint is a field to be used as an auxiliar field for some specific use cases.
      com.google.protobuf.ByteString getBreakpointBytes()
      Breakpoint is a field to be used as an auxiliar field for some specific use cases.
      String getDescription()
      Description of the message, this should be used as a human readable string to be used in diagnostics.
      com.google.protobuf.ByteString getDescriptionBytes()
      Description of the message, this should be used as a human readable string to be used in diagnostics.
      MessageDiagnostics getDiagnostics()
      Diagnostics is a field holding information about the message's usage.
      MessageDiagnosticsOrBuilder getDiagnosticsOrBuilder()
      Diagnostics is a field holding information about the message's usage.
      String getId()
      ID is an unique identifier inside a queue.
      com.google.protobuf.ByteString getIdBytes()
      ID is an unique identifier inside a queue.
      Map<String,​String> getMetadata()
      Deprecated.
      int getMetadataCount()
      Metadata is a map of string to be used as a key-value store.
      Map<String,​String> getMetadataMap()
      Metadata is a map of string to be used as a key-value store.
      String getMetadataOrDefault​(String key, String defaultValue)
      Metadata is a map of string to be used as a key-value store.
      String getMetadataOrThrow​(String key)
      Metadata is a map of string to be used as a key-value store.
      Map<String,​com.google.protobuf.Any> getPayload()
      Deprecated.
      int getPayloadCount()
      A payload map with formatted data to be stored and used by clients.
      Map<String,​com.google.protobuf.Any> getPayloadMap()
      A payload map with formatted data to be stored and used by clients.
      com.google.protobuf.Any getPayloadOrDefault​(String key, com.google.protobuf.Any defaultValue)
      A payload map with formatted data to be stored and used by clients.
      com.google.protobuf.Any getPayloadOrThrow​(String key)
      A payload map with formatted data to be stored and used by clients.
      String getQueue()
      Full name of the queue this message belongs (including any prefixes)
      com.google.protobuf.ByteString getQueueBytes()
      Full name of the queue this message belongs (including any prefixes)
      double getScore()
      Score represents the priority score the message currently have in the queue.
      String getStringPayload()
      Message string payload.
      com.google.protobuf.ByteString getStringPayloadBytes()
      Message string payload.
      boolean hasDiagnostics()
      Diagnostics is a field holding information about the message's usage.

      • 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

      • getId

        String getId()
         ID is an unique identifier inside a queue.
 Any message with the same id and queue will be considered the same message.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         ID is an unique identifier inside a queue.
 Any message with the same id and queue will be considered the same message.
        string id = 1;
        Returns:
        The bytes for id.

      • getDescription

        String getDescription()
         Description of the message, this should be used as a human readable string to be used in diagnostics.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Description of the message, this should be used as a human readable string to be used in diagnostics.
        string description = 2;
        Returns:
        The bytes for description.

      • getQueue

        String getQueue()
         Full name of the queue this message belongs (including any prefixes)
        string queue = 3;
        Returns:
        The queue.

      • getQueueBytes

        com.google.protobuf.ByteString getQueueBytes()
         Full name of the queue this message belongs (including any prefixes)
        string queue = 3;
        Returns:
        The bytes for queue.

      • getPayloadCount

        int getPayloadCount()
         A payload map with formatted data to be stored and used by clients.
        map<string, .google.protobuf.Any> payload = 8;

      • containsPayload

        boolean containsPayload​(String key)
         A payload map with formatted data to be stored and used by clients.
        map<string, .google.protobuf.Any> payload = 8;

      • getPayloadMap

        Map<String,​com.google.protobuf.Any> getPayloadMap()
         A payload map with formatted data to be stored and used by clients.
        map<string, .google.protobuf.Any> payload = 8;

      • getPayloadOrDefault

        com.google.protobuf.Any getPayloadOrDefault​(String key,
                                            com.google.protobuf.Any defaultValue)
         A payload map with formatted data to be stored and used by clients.
        map<string, .google.protobuf.Any> payload = 8;

      • getPayloadOrThrow

        com.google.protobuf.Any getPayloadOrThrow​(String key)
         A payload map with formatted data to be stored and used by clients.
        map<string, .google.protobuf.Any> payload = 8;

      • getMetadataCount

        int getMetadataCount()
         Metadata is a map of string to be used as a key-value store.
 It is a simple way to store data that is not part of the message payload.
        map<string, string> metadata = 4;

      • containsMetadata

        boolean containsMetadata​(String key)
         Metadata is a map of string to be used as a key-value store.
 It is a simple way to store data that is not part of the message payload.
        map<string, string> metadata = 4;

      • getMetadataMap

        Map<String,​String> getMetadataMap()
         Metadata is a map of string to be used as a key-value store.
 It is a simple way to store data that is not part of the message payload.
        map<string, string> metadata = 4;

      • getMetadataOrDefault

        String getMetadataOrDefault​(String key,
                            String defaultValue)
         Metadata is a map of string to be used as a key-value store.
 It is a simple way to store data that is not part of the message payload.
        map<string, string> metadata = 4;

      • getMetadataOrThrow

        String getMetadataOrThrow​(String key)
         Metadata is a map of string to be used as a key-value store.
 It is a simple way to store data that is not part of the message payload.
        map<string, string> metadata = 4;

      • getStringPayload

        String getStringPayload()
         Message string payload. Is responsibility of the caller to know how to encode/decode to a useful format for its purpose.
 This field can be used to store simple string data instead of using the payload field.
        string string_payload = 5;
        Returns:
        The stringPayload.

      • getStringPayloadBytes

        com.google.protobuf.ByteString getStringPayloadBytes()
         Message string payload. Is responsibility of the caller to know how to encode/decode to a useful format for its purpose.
 This field can be used to store simple string data instead of using the payload field.
        string string_payload = 5;
        Returns:
        The bytes for stringPayload.

      • getScore

        double getScore()
         Score represents the priority score the message currently have in the queue.
 The lower the score, the higher the priority.
 The maximum score accepted by Deckard is 9007199254740992 and the minimum is 0
        double score = 6;
        Returns:
        The score.

      • getBreakpoint

        String getBreakpoint()
         Breakpoint is a field to be used as an auxiliar field for some specific use cases.
 For example if you need to keep a record of the last result processing a message, or want to iteract with a pagination system.

 Examples: imagine a message representing a web news portal and you want to navigate through the articles. This field could be used to store the last visited article id.
 Or imagine a message representing a user and you want to iterate through the user's publications pages. This field could be used to store the last page number you visited.
        string breakpoint = 7;
        Returns:
        The breakpoint.

      • getBreakpointBytes

        com.google.protobuf.ByteString getBreakpointBytes()
         Breakpoint is a field to be used as an auxiliar field for some specific use cases.
 For example if you need to keep a record of the last result processing a message, or want to iteract with a pagination system.

 Examples: imagine a message representing a web news portal and you want to navigate through the articles. This field could be used to store the last visited article id.
 Or imagine a message representing a user and you want to iterate through the user's publications pages. This field could be used to store the last page number you visited.
        string breakpoint = 7;
        Returns:
        The bytes for breakpoint.

      • hasDiagnostics

        boolean hasDiagnostics()
         Diagnostics is a field holding information about the message's usage.
 It is useful to track how many times a message was ACKed or NACKed.
        .blipai.deckard.MessageDiagnostics diagnostics = 9;
        Returns:
        Whether the diagnostics field is set.

      • getDiagnostics

        MessageDiagnostics getDiagnostics()
         Diagnostics is a field holding information about the message's usage.
 It is useful to track how many times a message was ACKed or NACKed.
        .blipai.deckard.MessageDiagnostics diagnostics = 9;
        Returns:
        The diagnostics.

      • getDiagnosticsOrBuilder

        MessageDiagnosticsOrBuilder getDiagnosticsOrBuilder()
         Diagnostics is a field holding information about the message's usage.
 It is useful to track how many times a message was ACKed or NACKed.
        .blipai.deckard.MessageDiagnostics diagnostics = 9;