Package io.temporal.api.common.v1

Class Priority

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PriorityOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:Priority.java.pb.meta")
public final class Priority
extends com.google.protobuf.GeneratedMessageV3
implements PriorityOrBuilder
     Priority contains metadata that controls relative ordering of task processing
 when tasks are backed up in a queue. Initially, Priority will be used in
 matching (workflow and activity) task queues. Later it may be used in history
 task queues and in rate limiting decisions.

 Priority is attached to workflows and activities. By default, activities
 inherit Priority from the workflow that created them, but may override fields
 when an activity is started or modified.

 Despite being named "Priority", this message also contains fields that
 control "fairness" mechanisms.

 For all fields, the field not present or equal to zero/empty string means to
 inherit the value from the calling workflow, or if there is no calling
 workflow, then use the default value.

 For all fields other than fairness_key, the zero value isn't meaningful so
 there's no confusion between inherit/default and a meaningful value. For
 fairness_key, the empty string will be interpreted as "inherit". This means
 that if a workflow has a non-empty fairness key, you can't override the
 fairness key of its activity to the empty string.

 The overall semantics of Priority are:
 1. First, consider "priority": higher priority (lower number) goes first.
 2. Then, consider fairness: try to dispatch tasks for different fairness keys
    in proportion to their weight.

 Applications may use any subset of mechanisms that are useful to them and
 leave the other fields to use default values.

 Not all queues in the system may support the "full" semantics of all priority
 fields. (Currently only support in matching task queues is planned.)
    Protobuf type temporal.api.common.v1.Priority
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Priority.Builder
      Priority contains metadata that controls relative ordering of task processing when tasks are backed up in a queue.

      • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FAIRNESS_KEY_FIELD_NUMBER  
      static int FAIRNESS_WEIGHT_FIELD_NUMBER  
      static int PRIORITY_KEY_FIELD_NUMBER  

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

        alwaysUseFieldBuilders, unknownFields

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

        memoizedSize

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

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static Priority getDefaultInstance()  
      Priority getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getFairnessKey()
      Fairness key is a short string that's used as a key for a fairness balancing mechanism.
      com.google.protobuf.ByteString getFairnessKeyBytes()
      Fairness key is a short string that's used as a key for a fairness balancing mechanism.
      float getFairnessWeight()
      Fairness weight for a task can come from multiple sources for flexibility.
      com.google.protobuf.Parser<Priority> getParserForType()  
      int getPriorityKey()
      Priority key is a positive integer from 1 to n, where smaller integers correspond to higher priorities (tasks run sooner).
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Priority.Builder newBuilder()  
      static Priority.Builder newBuilder​(Priority prototype)  
      Priority.Builder newBuilderForType()  
      protected Priority.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Priority parseDelimitedFrom​(java.io.InputStream input)  
      static Priority parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Priority parseFrom​(byte[] data)  
      static Priority parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Priority parseFrom​(com.google.protobuf.ByteString data)  
      static Priority parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Priority parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Priority parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Priority parseFrom​(java.io.InputStream input)  
      static Priority parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Priority parseFrom​(java.nio.ByteBuffer data)  
      static Priority parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Priority> parser()  
      Priority.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 class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • 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

    • Field Detail

      • PRIORITY_KEY_FIELD_NUMBER

        public static final int PRIORITY_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAIRNESS_KEY_FIELD_NUMBER

        public static final int FAIRNESS_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAIRNESS_WEIGHT_FIELD_NUMBER

        public static final int FAIRNESS_WEIGHT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getPriorityKey

        public int getPriorityKey()
         Priority key is a positive integer from 1 to n, where smaller integers
 correspond to higher priorities (tasks run sooner). In general, tasks in
 a queue should be processed in close to priority order, although small
 deviations are possible.

 The maximum priority value (minimum priority) is determined by server
 configuration, and defaults to 5.

 If priority is not present (or zero), then the effective priority will be
 the default priority, which is calculated by (min+max)/2. With the
 default max of 5, and min of 1, that comes out to 3.
        int32 priority_key = 1;
        Specified by:
        getPriorityKey in interface PriorityOrBuilder
        Returns:
        The priorityKey.

      • getFairnessKey

        public java.lang.String getFairnessKey()
         Fairness key is a short string that's used as a key for a fairness
 balancing mechanism. It may correspond to a tenant id, or to a fixed
 string like "high" or "low". The default is the empty string.

 The fairness mechanism attempts to dispatch tasks for a given key in
 proportion to its weight. For example, using a thousand distinct tenant
 ids, each with a weight of 1.0 (the default) will result in each tenant
 getting a roughly equal share of task dispatch throughput.

 (Note: this does not imply equal share of worker capacity! Fairness
 decisions are made based on queue statistics, not
 current worker load.)

 As another example, using keys "high" and "low" with weight 9.0 and 1.0
 respectively will prefer dispatching "high" tasks over "low" tasks at a
 9:1 ratio, while allowing either key to use all worker capacity if the
 other is not present.

 All fairness mechanisms, including rate limits, are best-effort and
 probabilistic. The results may not match what a "perfect" algorithm with
 infinite resources would produce. The more unique keys are used, the less
 accurate the results will be.

 Fairness keys are limited to 64 bytes.
        string fairness_key = 2;
        Specified by:
        getFairnessKey in interface PriorityOrBuilder
        Returns:
        The fairnessKey.

      • getFairnessKeyBytes

        public com.google.protobuf.ByteString getFairnessKeyBytes()
         Fairness key is a short string that's used as a key for a fairness
 balancing mechanism. It may correspond to a tenant id, or to a fixed
 string like "high" or "low". The default is the empty string.

 The fairness mechanism attempts to dispatch tasks for a given key in
 proportion to its weight. For example, using a thousand distinct tenant
 ids, each with a weight of 1.0 (the default) will result in each tenant
 getting a roughly equal share of task dispatch throughput.

 (Note: this does not imply equal share of worker capacity! Fairness
 decisions are made based on queue statistics, not
 current worker load.)

 As another example, using keys "high" and "low" with weight 9.0 and 1.0
 respectively will prefer dispatching "high" tasks over "low" tasks at a
 9:1 ratio, while allowing either key to use all worker capacity if the
 other is not present.

 All fairness mechanisms, including rate limits, are best-effort and
 probabilistic. The results may not match what a "perfect" algorithm with
 infinite resources would produce. The more unique keys are used, the less
 accurate the results will be.

 Fairness keys are limited to 64 bytes.
        string fairness_key = 2;
        Specified by:
        getFairnessKeyBytes in interface PriorityOrBuilder
        Returns:
        The bytes for fairnessKey.

      • getFairnessWeight

        public float getFairnessWeight()
         Fairness weight for a task can come from multiple sources for
 flexibility. From highest to lowest precedence:
 1. Weights for a small set of keys can be overridden in task queue
    configuration with an API.
 2. It can be attached to the workflow/activity in this field.
 3. The default weight of 1.0 will be used.

 Weight values are clamped to the range [0.001, 1000].
        float fairness_weight = 3;
        Specified by:
        getFairnessWeight in interface PriorityOrBuilder
        Returns:
        The fairnessWeight.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 Priority parseFrom​(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Priority parseFrom​(java.io.InputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Priority parseFrom​(java.io.InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Priority parseDelimitedFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Priority parseDelimitedFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Priority parseFrom​(com.google.protobuf.CodedInputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Priority getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Priority> 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 Priority getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder