Paused

class Paused(val untilEpochMillis: Long, val length: Duration, val source: PauseSource) : BudgetEvent(source)

The budget is paused until untilEpochMillis, length from now, because of the hint source (PauseSource.RetryAfter, PauseSource.ResetIn, PauseSource.Boundary, or PauseSource.Snapshot for a restored pause). Emitted when a pause begins or is extended, never when a hint is shorter than the pause in force.

Stable Core.

Parameters

untilEpochMillis

the epoch millisecond the pause ends.

length

how long the pause lasts from now; not negative.

source

which hint set the pause.

Throws

Constructors

Link copied to clipboard
constructor(untilEpochMillis: Long, length: Duration, source: PauseSource)

Properties

Link copied to clipboard

How long the pause lasts from now.

Link copied to clipboard

Which hint set the pause.

Link copied to clipboard

The epoch millisecond the pause ends.

Functions

Link copied to clipboard
open override fun toString(): String

A diagnostic string for logs: untilEpochMillis, length and the source's name. Its format is not part of the API and may change.