Google Cloud Tasks V2beta3 Client - Class QueueStats (1.11.11)

Reference documentation and code samples for the Google Cloud Tasks V2beta3 Client class QueueStats.

Statistics for a queue.

Generated from protobuf message google.cloud.tasks.v2beta3.QueueStats

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ tasks_count int|string

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.

↳ oldest_estimated_arrival_time Google\Protobuf\Timestamp

Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed.

↳ executed_last_minute_count int|string

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.

↳ concurrent_dispatches_count int|string

Output only. The number of requests that the queue has dispatched but has not received a reply for yet.

↳ effective_execution_rate float

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.

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.

Returns
TypeDescription
int|string

setTasksCount

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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getOldestEstimatedArrivalTime

Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasOldestEstimatedArrivalTime

clearOldestEstimatedArrivalTime

setOldestEstimatedArrivalTime

Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

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.

Returns
TypeDescription
int|string

setExecutedLastMinuteCount

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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getConcurrentDispatchesCount

Output only. The number of requests that the queue has dispatched but has not received a reply for yet.

Returns
TypeDescription
int|string

setConcurrentDispatchesCount

Output only. The number of requests that the queue has dispatched but has not received a reply for yet.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
float

setEffectiveExecutionRate

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.

Parameter
NameDescription
var float
Returns
TypeDescription
$this