hetzner/actions

Types

ActionSortOption = enum
  sortId = "id", sortIdAsc = "id:asc", sortIdDesc = "id:desc",
  sortCommand = "command", sortCommandAsc = "command:asc",
  sortCommandDesc = "command:desc", sortStatus = "status",
  sortStatusAsc = "status:asc", sortStatusDesc = "status:desc",
  sortProgress = "progress", sortProgressAsc = "progress:asc",
  sortProgressDesc = "progress:desc", sortStarted = "started",
  sortStartedAsc = "started:asc", sortStartedDesc = "started:desc",
  sortFinished = "finished", sortFinishedAsc = "finished:asc",
  sortFinishedDesc = "finished:desc"
ActionStatusOption = enum
  statusRunning = "running", statusSuccess = "success", statusError = "error"

Procs

proc getActions(client: HetznerClient; id: int64 = default(int64);
                sort: set[ActionSortOption] = {};
                status: set[ActionStatusOption] = {}): Future[GetActionsResponse] {.
    ...stackTrace: false, raises: [Exception, ValueError, KeyError,
                                HttpRequestError, LibraryError, SslError,
                                OSError, IOError, ProtocolError,
                                OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns all Action objects. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
proc getActionsId(client: HetznerClient; id: int64): Future[GetActionsIdResponse] {.
    ...stackTrace: false, raises: [Exception, ValueError, HttpRequestError,
                                LibraryError, SslError, OSError, IOError,
                                ProtocolError, KeyError, OpenParserJsonError,
                                HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns a specific Action object.