File: operations.rst

package info (click to toggle)
python-pylxd 2.2.10-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 820 kB
  • sloc: python: 7,258; sh: 104; makefile: 21
file content (26 lines) | stat: -rw-r--r-- 809 bytes parent folder | download
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
Operations
==========

`Operation` objects detail the status of an asynchronous operation that is
taking place in the background.  Some operations (e.g. image related actions)
can take a long time and so the operation is performed in the background.  They
return an operation `id` that may be used to discover the state of the
operation.


Manager methods
---------------

Operations can be queried through the following client manager methods:

  - `get()` - Get a specific operation, by its id.
  - `wait_for_operation()` - get an operation, but wait until it is complete
    before returning the operation object.


Operation object methods
------------------------

  - `wait()` - Wait for the operation to complete and return.  Note that this
    can raise a `LXDAPIExceptiion` if the operations fails.