1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
Globus Timer
=============
.. currentmodule:: globus_sdk
.. note::
``TimersClient`` is also available under a legacy alias, ``TimerClient``.
.. autoclass:: TimersClient
:members:
:member-order: bysource
:show-inheritance:
:exclude-members: error_class
Helper Objects
--------------
A helper is provided for constructing Transfer Timers:
.. autoclass:: TransferTimer
:members:
:show-inheritance:
In order to schedule a timer, pass a ``schedule`` with relevant parameters.
This can be done using the two schedule helper classes
.. autoclass:: OnceTimerSchedule
:members:
:show-inheritance:
.. autoclass:: RecurringTimerSchedule
:members:
:show-inheritance:
TimerJob (legacy)
~~~~~~~~~~~~~~~~~
The ``TimerJob`` class is still supported for creating timers, but it is
not recommended.
New users should prefer the ``TransferTimer`` class.
.. autoclass:: TimerJob
:members:
:show-inheritance:
Client Errors
-------------
When an error occurs on calls to the Timers service, a :class:`TimersClient`
will raise a ``TimersAPIError``.
.. note::
``TimersAPIError`` is also available under a legacy alias, ``TimerAPIError``.
.. autoclass:: TimersAPIError
:members:
:show-inheritance:
|
