Package ai.blip.deckard

Interface AddMessageOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AddMessage, AddMessage.Builder
    public interface AddMessageOrBuilder
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 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.
      String getId()
      Unique id of this message
      com.google.protobuf.ByteString getIdBytes()
      Unique id of this message
      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()
      Name of the queue to add this message Suggestion: to better observability, provide the name of the application using colon as the separator.
      com.google.protobuf.ByteString getQueueBytes()
      Name of the queue to add this message Suggestion: to better observability, provide the name of the application using colon as the separator.
      double getScore()
      Score represents the priority score the message currently have in the queue.
      String getStringPayload()
      Non-formatted string payload.
      com.google.protobuf.ByteString getStringPayloadBytes()
      Non-formatted string payload.
      boolean getTimeless()
      Indicate this message will never expire and will only be deleted from the queue if explicitly removed.
      long getTtlMinutes()
      TTL is the amount of time in minutes this message will live in the queue.

      • 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()
         Unique id of this message
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         Unique id of this message
        string id = 1;
        Returns:
        The bytes for id.

      • getPayloadCount

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

      • containsPayload

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

      • 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 = 10;

      • 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 = 10;

      • 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 = 10;

      • getStringPayload

        String getStringPayload()
         Non-formatted string payload.
 This field can be used to store simple string data instead of using the payload field.
        string string_payload = 3;
        Returns:
        The stringPayload.

      • getStringPayloadBytes

        com.google.protobuf.ByteString getStringPayloadBytes()
         Non-formatted string payload.
 This field can be used to store simple string data instead of using the payload field.
        string string_payload = 3;
        Returns:
        The bytes for stringPayload.

      • 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 = 11;

      • 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 = 11;

      • 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 = 11;

      • 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 = 11;

      • 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 = 11;

      • getQueue

        String getQueue()
        
Name of the queue to add this message

Suggestion: to better observability, provide the name of the application using colon as the separator. Example: <application_name>:<queue_name>

You may also add a queue prefix to the queue name using two colons as the separator. Example: <application_name>:<queue_prefix>::<queue_name>
        string queue = 4;
        Returns:
        The queue.

      • getQueueBytes

        com.google.protobuf.ByteString getQueueBytes()
        
Name of the queue to add this message

Suggestion: to better observability, provide the name of the application using colon as the separator. Example: <application_name>:<queue_name>

You may also add a queue prefix to the queue name using two colons as the separator. Example: <application_name>:<queue_prefix>::<queue_name>
        string queue = 4;
        Returns:
        The bytes for queue.

      • getTimeless

        boolean getTimeless()
         Indicate this message will never expire and will only be deleted from the queue if explicitly removed.
        bool timeless = 6;
        Returns:
        The timeless.

      • getTtlMinutes

        long getTtlMinutes()
         TTL is the amount of time in minutes this message will live in the queue.
 TTL is not a exact time, the message may live a little longer than the specified TTL.
        int64 ttl_minutes = 7;
        Returns:
        The ttlMinutes.

      • getDescription

        String getDescription()
         Description of the message, this should be used as a human readable string to be used in diagnostics.
        string description = 8;
        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 = 8;
        Returns:
        The bytes for description.

      • getScore

        double getScore()
         Score represents the priority score the message currently have in the queue.
 The score is used to determine the order of the messages returned in a pull request.
 The lower the score, the higher the priority.

 If the score is not set (or set to 0), the score will be set with the current timestamp in milliseconds at the moment of the message creation.

 The maximum score accepted by Deckard is 9007199254740992 and the minimum is 0
 Negative scores will be converted to 0, adding the message with the lowest score (and highest priority)
        double score = 12;
        Returns:
        The score.