Package ai.blip.deckard

Class PullRequest

  • All Implemented Interfaces:
    PullRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PullRequest
extends com.google.protobuf.GeneratedMessageV3
implements PullRequestOrBuilder
    Protobuf type blipai.deckard.PullRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PullRequest.Builder
      Protobuf type blipai.deckard.PullRequest

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      long getAckDeadlineMs()
      Sets the amount of time in milliseconds a message will wait be available for processing before being returned to the queue if not ACKed.
      int getAmount()
      Number of messages to fetch.
      static PullRequest getDefaultInstance()  
      PullRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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.
      com.google.protobuf.Parser<PullRequest> getParserForType()  
      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.
      blipai.deckard.PullRequest.score_filter is deprecated.
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static PullRequest.Builder newBuilder()  
      static PullRequest.Builder newBuilder​(PullRequest prototype)  
      PullRequest.Builder newBuilderForType()  
      protected PullRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static PullRequest parseDelimitedFrom​(InputStream input)  
      static PullRequest parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PullRequest parseFrom​(byte[] data)  
      static PullRequest parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PullRequest parseFrom​(com.google.protobuf.ByteString data)  
      static PullRequest parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PullRequest parseFrom​(com.google.protobuf.CodedInputStream input)  
      static PullRequest parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PullRequest parseFrom​(InputStream input)  
      static PullRequest parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PullRequest parseFrom​(ByteBuffer data)  
      static PullRequest parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<PullRequest> parser()  
      PullRequest.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getQueue

        public String getQueue()
         Full name of the queue to pull messages (including any prefixes)
        string queue = 1;
        Specified by:
        getQueue in interface PullRequestOrBuilder
        Returns:
        The queue.

      • getQueueBytes

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

      • getAmount

        public 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;
        Specified by:
        getAmount in interface PullRequestOrBuilder
        Returns:
        The amount.

      • getScoreFilter

        @Deprecated
public long getScoreFilter()
        Deprecated.
        blipai.deckard.PullRequest.score_filter is deprecated. See proto/deckard_service.proto;l=114
         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];
        Specified by:
        getScoreFilter in interface PullRequestOrBuilder
        Returns:
        The scoreFilter.

      • getMaxScore

        public 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;
        Specified by:
        getMaxScore in interface PullRequestOrBuilder
        Returns:
        The maxScore.

      • getMinScore

        public 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;
        Specified by:
        getMinScore in interface PullRequestOrBuilder
        Returns:
        The minScore.

      • getAckDeadlineMs

        public long getAckDeadlineMs()
         Sets the amount of time in milliseconds a message will wait be available for processing before being returned to the queue if not ACKed.
 The default value is 300000 (5 minutes).
        int64 ack_deadline_ms = 6;
        Specified by:
        getAckDeadlineMs in interface PullRequestOrBuilder
        Returns:
        The ackDeadlineMs.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PullRequest parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PullRequest parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PullRequest parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PullRequest parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PullRequest parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PullRequest parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PullRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

        public PullRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PullRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PullRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static PullRequest getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<PullRequest> parser()

      • getParserForType

        public com.google.protobuf.Parser<PullRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PullRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder