You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

422 lines
13 KiB

  1. {
  2. "auth": {
  3. "oauth2": {
  4. "scopes": {
  5. "https://www.googleapis.com/auth/taskqueue": {
  6. "description": "Manage your Tasks and Taskqueues"
  7. },
  8. "https://www.googleapis.com/auth/taskqueue.consumer": {
  9. "description": "Consume Tasks from your Taskqueues"
  10. }
  11. }
  12. }
  13. },
  14. "basePath": "/taskqueue/v1beta1/projects/",
  15. "baseUrl": "https://www.googleapis.com/taskqueue/v1beta1/projects/",
  16. "batchPath": "batch/taskqueue/v1beta1",
  17. "description": "Accesses a Google App Engine Pull Task Queue over REST.",
  18. "discoveryVersion": "v1",
  19. "documentationLink": "https://developers.google.com/appengine/docs/python/taskqueue/rest",
  20. "etag": "\"-iA1DTNe4s-I6JZXPt1t1Ypy8IU/UNHEtVyVE-POJmRW0SrDcBQE6KY\"",
  21. "icons": {
  22. "x16": "https://www.google.com/images/icons/product/app_engine-16.png",
  23. "x32": "https://www.google.com/images/icons/product/app_engine-32.png"
  24. },
  25. "id": "taskqueue:v1beta1",
  26. "kind": "discovery#restDescription",
  27. "name": "taskqueue",
  28. "ownerDomain": "google.com",
  29. "ownerName": "Google",
  30. "parameters": {
  31. "alt": {
  32. "default": "json",
  33. "description": "Data format for the response.",
  34. "enum": [
  35. "json"
  36. ],
  37. "enumDescriptions": [
  38. "Responses with Content-Type of application/json"
  39. ],
  40. "location": "query",
  41. "type": "string"
  42. },
  43. "fields": {
  44. "description": "Selector specifying which fields to include in a partial response.",
  45. "location": "query",
  46. "type": "string"
  47. },
  48. "key": {
  49. "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
  50. "location": "query",
  51. "type": "string"
  52. },
  53. "oauth_token": {
  54. "description": "OAuth 2.0 token for the current user.",
  55. "location": "query",
  56. "type": "string"
  57. },
  58. "prettyPrint": {
  59. "default": "true",
  60. "description": "Returns response with indentations and line breaks.",
  61. "location": "query",
  62. "type": "boolean"
  63. },
  64. "quotaUser": {
  65. "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
  66. "location": "query",
  67. "type": "string"
  68. },
  69. "userIp": {
  70. "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
  71. "location": "query",
  72. "type": "string"
  73. }
  74. },
  75. "protocol": "rest",
  76. "resources": {
  77. "taskqueues": {
  78. "methods": {
  79. "get": {
  80. "description": "Get detailed information about a TaskQueue.",
  81. "httpMethod": "GET",
  82. "id": "taskqueue.taskqueues.get",
  83. "parameterOrder": [
  84. "project",
  85. "taskqueue"
  86. ],
  87. "parameters": {
  88. "getStats": {
  89. "description": "Whether to get stats. Optional.",
  90. "location": "query",
  91. "type": "boolean"
  92. },
  93. "project": {
  94. "description": "The project under which the queue lies.",
  95. "location": "path",
  96. "required": true,
  97. "type": "string"
  98. },
  99. "taskqueue": {
  100. "description": "The id of the taskqueue to get the properties of.",
  101. "location": "path",
  102. "required": true,
  103. "type": "string"
  104. }
  105. },
  106. "path": "{project}/taskqueues/{taskqueue}",
  107. "response": {
  108. "$ref": "TaskQueue"
  109. },
  110. "scopes": [
  111. "https://www.googleapis.com/auth/taskqueue",
  112. "https://www.googleapis.com/auth/taskqueue.consumer"
  113. ]
  114. }
  115. }
  116. },
  117. "tasks": {
  118. "methods": {
  119. "delete": {
  120. "description": "Delete a task from a TaskQueue.",
  121. "httpMethod": "DELETE",
  122. "id": "taskqueue.tasks.delete",
  123. "parameterOrder": [
  124. "project",
  125. "taskqueue",
  126. "task"
  127. ],
  128. "parameters": {
  129. "project": {
  130. "description": "The project under which the queue lies.",
  131. "location": "path",
  132. "required": true,
  133. "type": "string"
  134. },
  135. "task": {
  136. "description": "The id of the task to delete.",
  137. "location": "path",
  138. "required": true,
  139. "type": "string"
  140. },
  141. "taskqueue": {
  142. "description": "The taskqueue to delete a task from.",
  143. "location": "path",
  144. "required": true,
  145. "type": "string"
  146. }
  147. },
  148. "path": "{project}/taskqueues/{taskqueue}/tasks/{task}",
  149. "scopes": [
  150. "https://www.googleapis.com/auth/taskqueue",
  151. "https://www.googleapis.com/auth/taskqueue.consumer"
  152. ]
  153. },
  154. "get": {
  155. "description": "Get a particular task from a TaskQueue.",
  156. "httpMethod": "GET",
  157. "id": "taskqueue.tasks.get",
  158. "parameterOrder": [
  159. "project",
  160. "taskqueue",
  161. "task"
  162. ],
  163. "parameters": {
  164. "project": {
  165. "description": "The project under which the queue lies.",
  166. "location": "path",
  167. "required": true,
  168. "type": "string"
  169. },
  170. "task": {
  171. "description": "The task to get properties of.",
  172. "location": "path",
  173. "required": true,
  174. "type": "string"
  175. },
  176. "taskqueue": {
  177. "description": "The taskqueue in which the task belongs.",
  178. "location": "path",
  179. "required": true,
  180. "type": "string"
  181. }
  182. },
  183. "path": "{project}/taskqueues/{taskqueue}/tasks/{task}",
  184. "response": {
  185. "$ref": "Task"
  186. },
  187. "scopes": [
  188. "https://www.googleapis.com/auth/taskqueue",
  189. "https://www.googleapis.com/auth/taskqueue.consumer"
  190. ]
  191. },
  192. "lease": {
  193. "description": "Lease 1 or more tasks from a TaskQueue.",
  194. "httpMethod": "POST",
  195. "id": "taskqueue.tasks.lease",
  196. "parameterOrder": [
  197. "project",
  198. "taskqueue",
  199. "numTasks",
  200. "leaseSecs"
  201. ],
  202. "parameters": {
  203. "leaseSecs": {
  204. "description": "The lease in seconds.",
  205. "format": "int32",
  206. "location": "query",
  207. "required": true,
  208. "type": "integer"
  209. },
  210. "numTasks": {
  211. "description": "The number of tasks to lease.",
  212. "format": "int32",
  213. "location": "query",
  214. "required": true,
  215. "type": "integer"
  216. },
  217. "project": {
  218. "description": "The project under which the queue lies.",
  219. "location": "path",
  220. "required": true,
  221. "type": "string"
  222. },
  223. "taskqueue": {
  224. "description": "The taskqueue to lease a task from.",
  225. "location": "path",
  226. "required": true,
  227. "type": "string"
  228. }
  229. },
  230. "path": "{project}/taskqueues/{taskqueue}/tasks/lease",
  231. "response": {
  232. "$ref": "Tasks"
  233. },
  234. "scopes": [
  235. "https://www.googleapis.com/auth/taskqueue",
  236. "https://www.googleapis.com/auth/taskqueue.consumer"
  237. ]
  238. },
  239. "list": {
  240. "description": "List Tasks in a TaskQueue",
  241. "httpMethod": "GET",
  242. "id": "taskqueue.tasks.list",
  243. "parameterOrder": [
  244. "project",
  245. "taskqueue"
  246. ],
  247. "parameters": {
  248. "project": {
  249. "description": "The project under which the queue lies.",
  250. "location": "path",
  251. "required": true,
  252. "type": "string"
  253. },
  254. "taskqueue": {
  255. "description": "The id of the taskqueue to list tasks from.",
  256. "location": "path",
  257. "required": true,
  258. "type": "string"
  259. }
  260. },
  261. "path": "{project}/taskqueues/{taskqueue}/tasks",
  262. "response": {
  263. "$ref": "Tasks2"
  264. },
  265. "scopes": [
  266. "https://www.googleapis.com/auth/taskqueue",
  267. "https://www.googleapis.com/auth/taskqueue.consumer"
  268. ]
  269. }
  270. }
  271. }
  272. },
  273. "revision": "20160428",
  274. "rootUrl": "https://www.googleapis.com/",
  275. "schemas": {
  276. "Task": {
  277. "id": "Task",
  278. "properties": {
  279. "enqueueTimestamp": {
  280. "description": "Time (in seconds since the epoch) at which the task was enqueued.",
  281. "format": "int64",
  282. "type": "string"
  283. },
  284. "id": {
  285. "description": "Name of the task.",
  286. "type": "string"
  287. },
  288. "kind": {
  289. "default": "taskqueues#task",
  290. "description": "The kind of object returned, in this case set to task.",
  291. "type": "string"
  292. },
  293. "leaseTimestamp": {
  294. "description": "Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.",
  295. "format": "int64",
  296. "type": "string"
  297. },
  298. "payloadBase64": {
  299. "description": "A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.",
  300. "type": "string"
  301. },
  302. "queueName": {
  303. "description": "Name of the queue that the task is in.",
  304. "type": "string"
  305. }
  306. },
  307. "type": "object"
  308. },
  309. "TaskQueue": {
  310. "id": "TaskQueue",
  311. "properties": {
  312. "acl": {
  313. "description": "ACLs that are applicable to this TaskQueue object.",
  314. "properties": {
  315. "adminEmails": {
  316. "description": "Email addresses of users who are \"admins\" of the TaskQueue. This means they can control the queue, eg set ACLs for the queue.",
  317. "items": {
  318. "type": "string"
  319. },
  320. "type": "array"
  321. },
  322. "consumerEmails": {
  323. "description": "Email addresses of users who can \"consume\" tasks from the TaskQueue. This means they can Dequeue and Delete tasks from the queue.",
  324. "items": {
  325. "type": "string"
  326. },
  327. "type": "array"
  328. },
  329. "producerEmails": {
  330. "description": "Email addresses of users who can \"produce\" tasks into the TaskQueue. This means they can Insert tasks into the queue.",
  331. "items": {
  332. "type": "string"
  333. },
  334. "type": "array"
  335. }
  336. },
  337. "type": "object"
  338. },
  339. "id": {
  340. "description": "Name of the taskqueue.",
  341. "type": "string"
  342. },
  343. "kind": {
  344. "default": "taskqueues#taskqueue",
  345. "description": "The kind of REST object returned, in this case taskqueue.",
  346. "type": "string"
  347. },
  348. "maxLeases": {
  349. "description": "The number of times we should lease out tasks before giving up on them. If unset we lease them out forever until a worker deletes the task.",
  350. "format": "int32",
  351. "type": "integer"
  352. },
  353. "stats": {
  354. "description": "Statistics for the TaskQueue object in question.",
  355. "properties": {
  356. "leasedLastHour": {
  357. "description": "Number of tasks leased in the last hour.",
  358. "format": "int64",
  359. "type": "string"
  360. },
  361. "leasedLastMinute": {
  362. "description": "Number of tasks leased in the last minute.",
  363. "format": "int64",
  364. "type": "string"
  365. },
  366. "oldestTask": {
  367. "description": "The timestamp (in seconds since the epoch) of the oldest unfinished task.",
  368. "format": "int64",
  369. "type": "string"
  370. },
  371. "totalTasks": {
  372. "description": "Number of tasks in the queue.",
  373. "format": "int32",
  374. "type": "integer"
  375. }
  376. },
  377. "type": "object"
  378. }
  379. },
  380. "type": "object"
  381. },
  382. "Tasks": {
  383. "id": "Tasks",
  384. "properties": {
  385. "items": {
  386. "description": "The actual list of tasks returned as a result of the lease operation.",
  387. "items": {
  388. "$ref": "Task"
  389. },
  390. "type": "array"
  391. },
  392. "kind": {
  393. "default": "taskqueue#tasks",
  394. "description": "The kind of object returned, a list of tasks.",
  395. "type": "string"
  396. }
  397. },
  398. "type": "object"
  399. },
  400. "Tasks2": {
  401. "id": "Tasks2",
  402. "properties": {
  403. "items": {
  404. "description": "The actual list of tasks currently active in the TaskQueue.",
  405. "items": {
  406. "$ref": "Task"
  407. },
  408. "type": "array"
  409. },
  410. "kind": {
  411. "default": "taskqueues#tasks",
  412. "description": "The kind of object returned, a list of tasks.",
  413. "type": "string"
  414. }
  415. },
  416. "type": "object"
  417. }
  418. },
  419. "servicePath": "taskqueue/v1beta1/projects/",
  420. "title": "TaskQueue API",
  421. "version": "v1beta1"
  422. }