Package ai.blip.deckard

Interface PullRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      int getAmount()
      Number of messages to fetch.
      double getMaxScore()
      Sets the upper threshold for the priority score of a message to be returned in the pull request.
      double getMinScore()
      Sets the lower threshold for the priority score required for a message to be returned.
      String getQueue()
      Full name of the queue to pull messages (including any prefixes)
      com.google.protobuf.ByteString getQueueBytes()
      Full name of the queue to pull messages (including any prefixes)
      long getScoreFilter()
      Deprecated.

      • 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

      • getQueue

        String getQueue()
         Full name of the queue to pull messages (including any prefixes)
        string queue = 1;
        Returns:
        The queue.

      • getQueueBytes

        com.google.protobuf.ByteString getQueueBytes()
         Full name of the queue to pull messages (including any prefixes)
        string queue = 1;
        Returns:
        The bytes for queue.

      • getAmount

        int getAmount()
         Number of messages to fetch.
 Caution: as greater the amount, as more time it will take to process the request.
 Max value is 1000 and the default value is 1
        int32 amount = 2;
        Returns:
        The amount.

      • getScoreFilter

        @Deprecated
long getScoreFilter()
        Deprecated.
         Prefer using the max_score field instead of this one.
 This field is deprecated and will be removed in the future.
  
 The `score_filter` behaves differently than `max_score` field.
 The `max_score` field is the upper threshold itself, but the `score_filter` will result in an upper score threshold of the current timestamp minus the score_filter value.
 Useful only when your queue's score is only based on the current timestamp to not return a message just moments after it was last used.
 It will only return messages with score lower than the current timestamp minus the score_filter value.
 For example if your queue's score is only based on the current timestamp, this parameter will be the number of milliseconds a message must be in the queue before being returned.
        int64 score_filter = 3 [deprecated = true];
        Returns:
        The scoreFilter.

      • getMaxScore

        double getMaxScore()
         Sets the upper threshold for the priority score of a message to be returned in the pull request.
 Only messages with a priority score equal to or lower than the max_score value will be returned.
 The maximum score accepted by Deckard is 9007199254740992, any value higher than this will be capped to the maximum score.
 To set this value to the minimum score accepted by Deckard, use any negative number.
 This parameter will be ignored if set to 0 (default value).
        double max_score = 4;
        Returns:
        The maxScore.

      • getMinScore

        double getMinScore()
         Sets the lower threshold for the priority score required for a message to be returned.
 Only messages with a priority score equal to or higher than the min_score value will be returned.
 The minimum score accepted by Deckard is 0 which is also the default value
        double min_score = 5;
        Returns:
        The minScore.