doc/api/methods/jobs.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "jobs"
   6
   7 ...
   8
   9 h1. jobs
  10
  11 Required arguments are displayed in %{background:#ccffcc}green%.
  12
  13
  14 h2. cancel
  15
  16 cancel jobs
  17
  18 Arguments:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  22 {background:#ccffcc}.|uuid|string||path||
  23
  24 h2. create
  25
  26 Create a new Job.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 |job|object||query||
  33
  34 h2. delete
  35
  36 Delete an existing Job.
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
  43
  44 h2. destroy
  45
  46 destroy jobs
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 {background:#ccffcc}.|uuid|string||path||
  53
  54 h2. get
  55
  56 Gets a Job's metadata by UUID.
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
  63
  64 h2. index
  65
  66 index jobs
  67
  68 Arguments:
  69
  70 table(table table-bordered table-condensed).
  71 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  72 |order|string||query||
  73 |where|object||query||
  74
  75 h2. list
  76
  77 List jobs.
  78
  79 Arguments:
  80
  81 table(table table-bordered table-condensed).
  82 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  83 |limit|integer (default 100)|Maximum number of jobs to return.|query||
  84 |order|string|Order in which to return matching jobs.|query||
  85 |pageToken|string|Page token.|query||
  86 |q|string|Query string for searching jobs.|query||
  87 |where|object|Conditions for filtering jobs.|query||
  88
  89 h2. log_tail_follow
  90
  91 log_tail_follow jobs
  92
  93 Arguments:
  94
  95 table(table table-bordered table-condensed).
  96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  97 {background:#ccffcc}.|uuid|string||path||
  98 |buffer_size|integer (default 8192)||query||
  99
 100 h2. queue
 101
 102 queue jobs
 103
 104 Arguments:
 105
 106 table(table table-bordered table-condensed).
 107 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 108 |order|string||query||
 109 |where|object||query||
 110
 111 h2. show
 112
 113 show jobs
 114
 115 Arguments:
 116
 117 table(table table-bordered table-condensed).
 118 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 119 {background:#ccffcc}.|uuid|string||path||
 120
 121 h2. update
 122
 123 Update attributes of an existing Job.
 124
 125 Arguments:
 126
 127 table(table table-bordered table-condensed).
 128 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 129 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
 130 |job|object||query||