Class Scheduler (2.31.0)

Scheduler()

Abstract base class for schedulers.

Schedulers are used to schedule callbacks asynchronously.

Properties

Queue: A concurrency-safe queue specific to the underlying concurrency implementation.

This queue is used to send messages back to the scheduling actor.

schedule(callback: typing.Callable, *args, **kwargs) -> None

Schedule the callback to be called asynchronously.

shutdown(
 await_msg_callbacks: bool = False,
) -> typing.List[pubsub_v1.subscriber.message.Message]

Shuts down the scheduler and immediately end all pending callbacks.

Parameter
Name	Description
`await_msg_callbacks`	`bool` If `True`, the method will block until all currently executing callbacks are done processing. If `False` (default), the method will not wait for the currently running callbacks to complete.