Class QueueStats (2.43.0)

public final class QueueStats extends GeneratedMessageV3 implements QueueStatsOrBuilder

Statistics for a queue.

Protobuf type google.cloud.tasks.v2beta2.QueueStats

Implements

QueueStatsOrBuilder

Static Fields

CONCURRENT_DISPATCHES_COUNT_FIELD_NUMBER

public static final int CONCURRENT_DISPATCHES_COUNT_FIELD_NUMBER
Field Value
Type Description
int

EFFECTIVE_EXECUTION_RATE_FIELD_NUMBER

public static final int EFFECTIVE_EXECUTION_RATE_FIELD_NUMBER
Field Value
Type Description
int

EXECUTED_LAST_MINUTE_COUNT_FIELD_NUMBER

public static final int EXECUTED_LAST_MINUTE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

OLDEST_ESTIMATED_ARRIVAL_TIME_FIELD_NUMBER

public static final int OLDEST_ESTIMATED_ARRIVAL_TIME_FIELD_NUMBER
Field Value
Type Description
int

TASKS_COUNT_FIELD_NUMBER

public static final int TASKS_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueueStats getDefaultInstance()
Returns
Type Description
QueueStats

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static QueueStats.Builder newBuilder()
Returns
Type Description
QueueStats.Builder

newBuilder(QueueStats prototype)

public static QueueStats.Builder newBuilder(QueueStats prototype)
Parameter
Name Description
prototype QueueStats
Returns
Type Description
QueueStats.Builder

parseDelimitedFrom(InputStream input)

public static QueueStats parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueueStats
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueueStats parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueueStats
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QueueStats parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueueStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueueStats parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueueStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueueStats parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueueStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueueStats parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueueStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueueStats parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueueStats
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueueStats parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueueStats
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QueueStats parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueueStats
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueueStats parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueueStats
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QueueStats parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueueStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueueStats parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueueStats
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QueueStats> parser()
Returns
Type Description
Parser<QueueStats>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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];

Returns
Type Description
long

The concurrentDispatchesCount.

getDefaultInstanceForType()

public QueueStats getDefaultInstanceForType()
Returns
Type Description
QueueStats

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];

Returns
Type Description
double

The effectiveExecutionRate.

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];

Returns
Type Description
long

The executedLastMinuteCount.

getOldestEstimatedArrivalTime()

public 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];

Returns
Type Description
Timestamp

The oldestEstimatedArrivalTime.

getOldestEstimatedArrivalTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

getParserForType()

public Parser<QueueStats> getParserForType()
Returns
Type Description
Parser<QueueStats>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
long

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];

Returns
Type Description
boolean

Whether the oldestEstimatedArrivalTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QueueStats.Builder newBuilderForType()
Returns
Type Description
QueueStats.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QueueStats.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueueStats.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public QueueStats.Builder toBuilder()
Returns
Type Description
QueueStats.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException