Class QueueStats.Builder (2.27.0)

public static final class QueueStats.Builder extends GeneratedMessageV3.Builder<QueueStats.Builder> implements QueueStatsOrBuilder

Statistics for a queue.

Protobuf type google.cloud.tasks.v2beta3.QueueStats

Implements

QueueStatsOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueueStats.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueueStats.Builder
Overrides

build()

public QueueStats build()
Returns
TypeDescription
QueueStats

buildPartial()

public QueueStats buildPartial()
Returns
TypeDescription
QueueStats

clear()

public QueueStats.Builder clear()
Returns
TypeDescription
QueueStats.Builder
Overrides

clearConcurrentDispatchesCount()

public QueueStats.Builder clearConcurrentDispatchesCount()

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
TypeDescription
QueueStats.Builder

This builder for chaining.

clearEffectiveExecutionRate()

public QueueStats.Builder clearEffectiveExecutionRate()

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
TypeDescription
QueueStats.Builder

This builder for chaining.

clearExecutedLastMinuteCount()

public QueueStats.Builder clearExecutedLastMinuteCount()

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
TypeDescription
QueueStats.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public QueueStats.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
QueueStats.Builder
Overrides

clearOldestEstimatedArrivalTime()

public QueueStats.Builder clearOldestEstimatedArrivalTime()

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
TypeDescription
QueueStats.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public QueueStats.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
QueueStats.Builder
Overrides

clearTasksCount()

public QueueStats.Builder clearTasksCount()

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
TypeDescription
QueueStats.Builder

This builder for chaining.

clone()

public QueueStats.Builder clone()
Returns
TypeDescription
QueueStats.Builder
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
TypeDescription
long

The concurrentDispatchesCount.

getDefaultInstanceForType()

public QueueStats getDefaultInstanceForType()
Returns
TypeDescription
QueueStats

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
Timestamp

The oldestEstimatedArrivalTime.

getOldestEstimatedArrivalTimeBuilder()

public Timestamp.Builder getOldestEstimatedArrivalTimeBuilder()

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
TypeDescription
Builder

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
TypeDescription
TimestampOrBuilder

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
TypeDescription
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
TypeDescription
boolean

Whether the oldestEstimatedArrivalTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(QueueStats other)

public QueueStats.Builder mergeFrom(QueueStats other)
Parameter
NameDescription
otherQueueStats
Returns
TypeDescription
QueueStats.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueueStats.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueueStats.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public QueueStats.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
QueueStats.Builder
Overrides

mergeOldestEstimatedArrivalTime(Timestamp value)

public QueueStats.Builder mergeOldestEstimatedArrivalTime(Timestamp value)

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
QueueStats.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueueStats.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueueStats.Builder
Overrides

setConcurrentDispatchesCount(long value)

public QueueStats.Builder setConcurrentDispatchesCount(long value)

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

Parameter
NameDescription
valuelong

The concurrentDispatchesCount to set.

Returns
TypeDescription
QueueStats.Builder

This builder for chaining.

setEffectiveExecutionRate(double value)

public QueueStats.Builder setEffectiveExecutionRate(double value)

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

Parameter
NameDescription
valuedouble

The effectiveExecutionRate to set.

Returns
TypeDescription
QueueStats.Builder

This builder for chaining.

setExecutedLastMinuteCount(long value)

public QueueStats.Builder setExecutedLastMinuteCount(long value)

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

Parameter
NameDescription
valuelong

The executedLastMinuteCount to set.

Returns
TypeDescription
QueueStats.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public QueueStats.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueueStats.Builder
Overrides

setOldestEstimatedArrivalTime(Timestamp value)

public QueueStats.Builder setOldestEstimatedArrivalTime(Timestamp value)

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
QueueStats.Builder

setOldestEstimatedArrivalTime(Timestamp.Builder builderForValue)

public QueueStats.Builder setOldestEstimatedArrivalTime(Timestamp.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
QueueStats.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QueueStats.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
QueueStats.Builder
Overrides

setTasksCount(long value)

public QueueStats.Builder setTasksCount(long value)

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

Parameter
NameDescription
valuelong

The tasksCount to set.

Returns
TypeDescription
QueueStats.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final QueueStats.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueueStats.Builder
Overrides