Package io.temporal.api.taskqueue.v1

Class TaskQueueStats

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TaskQueueStatsOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:TaskQueueStats.java.pb.meta")
public final class TaskQueueStats
extends com.google.protobuf.GeneratedMessageV3
implements TaskQueueStatsOrBuilder
     TaskQueueStats contains statistics about task queue backlog and activity.
 For workflow task queue type, this result is partial because tasks sent to sticky queues are not included. Read
 comments above each metric to understand the impact of sticky queue exclusion on that metric accuracy.
    Protobuf type temporal.api.taskqueue.v1.TaskQueueStats
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TaskQueueStats.Builder
      TaskQueueStats contains statistics about task queue backlog and activity.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      com.google.protobuf.Duration getApproximateBacklogAge()
      Approximate age of the oldest task in the backlog based on the creation time of the task at the head of the queue.
      com.google.protobuf.DurationOrBuilder getApproximateBacklogAgeOrBuilder()
      Approximate age of the oldest task in the backlog based on the creation time of the task at the head of the queue.
      long getApproximateBacklogCount()
      The approximate number of tasks backlogged in this task queue.
      static TaskQueueStats getDefaultInstance()  
      TaskQueueStats getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<TaskQueueStats> getParserForType()  
      int getSerializedSize()  
      float getTasksAddRate()
      The approximate tasks per second added to the task queue, averaging the last 30 seconds.
      float getTasksDispatchRate()
      The approximate tasks per second dispatched from the task queue, averaging the last 30 seconds.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasApproximateBacklogAge()
      Approximate age of the oldest task in the backlog based on the creation time of the task at the head of the queue.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static TaskQueueStats.Builder newBuilder()  
      static TaskQueueStats.Builder newBuilder​(TaskQueueStats prototype)  
      TaskQueueStats.Builder newBuilderForType()  
      protected TaskQueueStats.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static TaskQueueStats parseDelimitedFrom​(java.io.InputStream input)  
      static TaskQueueStats parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TaskQueueStats parseFrom​(byte[] data)  
      static TaskQueueStats parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TaskQueueStats parseFrom​(com.google.protobuf.ByteString data)  
      static TaskQueueStats parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TaskQueueStats parseFrom​(com.google.protobuf.CodedInputStream input)  
      static TaskQueueStats parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TaskQueueStats parseFrom​(java.io.InputStream input)  
      static TaskQueueStats parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TaskQueueStats parseFrom​(java.nio.ByteBuffer data)  
      static TaskQueueStats parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<TaskQueueStats> parser()  
      TaskQueueStats.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

    • Field Detail

      • APPROXIMATE_BACKLOG_COUNT_FIELD_NUMBER

        public static final int APPROXIMATE_BACKLOG_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • APPROXIMATE_BACKLOG_AGE_FIELD_NUMBER

        public static final int APPROXIMATE_BACKLOG_AGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASKS_ADD_RATE_FIELD_NUMBER

        public static final int TASKS_ADD_RATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASKS_DISPATCH_RATE_FIELD_NUMBER

        public static final int TASKS_DISPATCH_RATE_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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getApproximateBacklogCount

        public long getApproximateBacklogCount()
         The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually
 converges to the right value. Can be relied upon for scaling decisions.
 Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because
 those tasks only remain valid for a few seconds, the inaccuracy becomes less significant as the backlog size
 grows.
        int64 approximate_backlog_count = 1;
        Specified by:
        getApproximateBacklogCount in interface TaskQueueStatsOrBuilder
        Returns:
        The approximateBacklogCount.

      • hasApproximateBacklogAge

        public boolean hasApproximateBacklogAge()
         Approximate age of the oldest task in the backlog based on the creation time of the task at the head of
 the queue. Can be relied upon for scaling decisions.
 Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because
 those tasks only remain valid for a few seconds, they should not affect the result when backlog is older than
 few seconds.
        .google.protobuf.Duration approximate_backlog_age = 2;
        Specified by:
        hasApproximateBacklogAge in interface TaskQueueStatsOrBuilder
        Returns:
        Whether the approximateBacklogAge field is set.

      • getApproximateBacklogAge

        public com.google.protobuf.Duration getApproximateBacklogAge()
         Approximate age of the oldest task in the backlog based on the creation time of the task at the head of
 the queue. Can be relied upon for scaling decisions.
 Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because
 those tasks only remain valid for a few seconds, they should not affect the result when backlog is older than
 few seconds.
        .google.protobuf.Duration approximate_backlog_age = 2;
        Specified by:
        getApproximateBacklogAge in interface TaskQueueStatsOrBuilder
        Returns:
        The approximateBacklogAge.

      • getApproximateBacklogAgeOrBuilder

        public com.google.protobuf.DurationOrBuilder getApproximateBacklogAgeOrBuilder()
         Approximate age of the oldest task in the backlog based on the creation time of the task at the head of
 the queue. Can be relied upon for scaling decisions.
 Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because
 those tasks only remain valid for a few seconds, they should not affect the result when backlog is older than
 few seconds.
        .google.protobuf.Duration approximate_backlog_age = 2;
        Specified by:
        getApproximateBacklogAgeOrBuilder in interface TaskQueueStatsOrBuilder

      • getTasksAddRate

        public float getTasksAddRate()
         The approximate tasks per second added to the task queue, averaging the last 30 seconds. These includes tasks
 whether or not they were added to/dispatched from the backlog or they were dispatched immediately without going
 to the backlog (sync-matched).
 The difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which
 backlog grows/shrinks.
 Note: the actual tasks delivered to the workers may significantly be higher than the numbers reported by
 tasks_add_rate, because:
 - Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is
   enable for activities by default in the latest SDKs.
 - Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each
   workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific
   worker instance.
        float tasks_add_rate = 3;
        Specified by:
        getTasksAddRate in interface TaskQueueStatsOrBuilder
        Returns:
        The tasksAddRate.

      • getTasksDispatchRate

        public float getTasksDispatchRate()
         The approximate tasks per second dispatched from the task queue, averaging the last 30 seconds. These includes
 tasks whether or not they were added to/dispatched from the backlog or they were dispatched immediately without
 going to the backlog (sync-matched).
 The difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which
 backlog grows/shrinks.
 Note: the actual tasks delivered to the workers may significantly be higher than the numbers reported by
 tasks_dispatch_rate, because:
 - Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is
   enable for activities by default in the latest SDKs.
 - Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each
   workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific
   worker instance.
        float tasks_dispatch_rate = 4;
        Specified by:
        getTasksDispatchRate in interface TaskQueueStatsOrBuilder
        Returns:
        The tasksDispatchRate.

      • 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 TaskQueueStats parseFrom​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static TaskQueueStats getDefaultInstance()

      • parser

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

      • getParserForType

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