Google Cloud Tasks V2beta3 Client - Class QueueStats (1.14.6)

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

Namespace

Google \ Cloud \ Tasks \ V2beta3

Methods

__construct

Constructor.

Parameters
Name	Description
`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
Type	Description
`int\|string`

setTasksCount

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getConcurrentDispatchesCount

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

Returns
Type	Description
`int\|string`

setConcurrentDispatchesCount

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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
Type	Description
`float`

setEffectiveExecutionRate

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`