Class QueueStats

  • All Implemented Interfaces:
    QueueStatsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class QueueStats
    extends com.google.protobuf.GeneratedMessageV3
    implements QueueStatsOrBuilder
     Statistics for a queue.
     
    Protobuf type google.cloud.tasks.v2beta3.QueueStats
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  QueueStats.Builder
      Statistics for 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 Detail

      • TASKS_COUNT_FIELD_NUMBER

        public static final int TASKS_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OLDEST_ESTIMATED_ARRIVAL_TIME_FIELD_NUMBER

        public static final int OLDEST_ESTIMATED_ARRIVAL_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXECUTED_LAST_MINUTE_COUNT_FIELD_NUMBER

        public static final int EXECUTED_LAST_MINUTE_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CONCURRENT_DISPATCHES_COUNT_FIELD_NUMBER

        public static final int CONCURRENT_DISPATCHES_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EFFECTIVE_EXECUTION_RATE_FIELD_NUMBER

        public static final int EFFECTIVE_EXECUTION_RATE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • 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
      • getTasksCount

        public long getTasksCount()
         Output only. An estimation of the number of tasks in the queue, that is,
         the tasks in the queue that haven't been executed, the tasks in the queue
         which the queue has dispatched but has not yet received a reply for, and
         the failed tasks that the queue is retrying.
         
        int64 tasks_count = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTasksCount in interface QueueStatsOrBuilder
        Returns:
        The tasksCount.
      • hasOldestEstimatedArrivalTime

        public boolean hasOldestEstimatedArrivalTime()
         Output only. An estimation of the nearest time in the future where a task
         in the queue is scheduled to be executed.
         
        .google.protobuf.Timestamp oldest_estimated_arrival_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasOldestEstimatedArrivalTime in interface QueueStatsOrBuilder
        Returns:
        Whether the oldestEstimatedArrivalTime field is set.
      • getOldestEstimatedArrivalTime

        public com.google.protobuf.Timestamp getOldestEstimatedArrivalTime()
         Output only. An estimation of the nearest time in the future where a task
         in the queue is scheduled to be executed.
         
        .google.protobuf.Timestamp oldest_estimated_arrival_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOldestEstimatedArrivalTime in interface QueueStatsOrBuilder
        Returns:
        The oldestEstimatedArrivalTime.
      • getOldestEstimatedArrivalTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getOldestEstimatedArrivalTimeOrBuilder()
         Output only. An estimation of the nearest time in the future where a task
         in the queue is scheduled to be executed.
         
        .google.protobuf.Timestamp oldest_estimated_arrival_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOldestEstimatedArrivalTimeOrBuilder in interface QueueStatsOrBuilder
      • getExecutedLastMinuteCount

        public long getExecutedLastMinuteCount()
         Output only. The number of tasks that the queue has dispatched and received
         a reply for during the last minute. This variable counts both successful
         and non-successful executions.
         
        int64 executed_last_minute_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExecutedLastMinuteCount in interface QueueStatsOrBuilder
        Returns:
        The executedLastMinuteCount.
      • getConcurrentDispatchesCount

        public long getConcurrentDispatchesCount()
         Output only. The number of requests that the queue has dispatched but has
         not received a reply for yet.
         
        int64 concurrent_dispatches_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getConcurrentDispatchesCount in interface QueueStatsOrBuilder
        Returns:
        The concurrentDispatchesCount.
      • getEffectiveExecutionRate

        public double getEffectiveExecutionRate()
         Output only. The current maximum number of tasks per second executed by the
         queue. The maximum value of this variable is controlled by the RateLimits
         of the Queue. However, this value could be less to avoid overloading the
         endpoints tasks in the queue are targeting.
         
        double effective_execution_rate = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveExecutionRate in interface QueueStatsOrBuilder
        Returns:
        The effectiveExecutionRate.
      • 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 QueueStats parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static QueueStats getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<QueueStats> parser()
      • getParserForType

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