OLD | NEW |
(Empty) | |
| 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/v1beta2/projects/", |
| 15 "baseUrl": "https://www.googleapis.com/taskqueue/v1beta2/projects/", |
| 16 "batchPath": "batch", |
| 17 "description": "Lets you access a Google App Engine Pull Task Queue over RES
T.", |
| 18 "discoveryVersion": "v1", |
| 19 "documentationLink": "https://developers.google.com/appengine/docs/python/ta
skqueue/rest", |
| 20 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/NdbJrHMoZLPwtpKFHEyZMJzpuTM\"", |
| 21 "icons": { |
| 22 "x16": "http://www.google.com/images/icons/product/app_engine-16.png", |
| 23 "x32": "http://www.google.com/images/icons/product/app_engine-32.png" |
| 24 }, |
| 25 "id": "taskqueue:v1beta2", |
| 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 par
tial response.", |
| 45 "location": "query", |
| 46 "type": "string" |
| 47 }, |
| 48 "key": { |
| 49 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 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 exc
eed 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 li
es.", |
| 95 "location": "path", |
| 96 "required": true, |
| 97 "type": "string" |
| 98 }, |
| 99 "taskqueue": { |
| 100 "description": "The id of the taskqueue to get the p
roperties 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 li
es.", |
| 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 li
es.", |
| 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 belo
ngs.", |
| 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 "insert": { |
| 193 "description": "Insert a new task in a TaskQueue", |
| 194 "httpMethod": "POST", |
| 195 "id": "taskqueue.tasks.insert", |
| 196 "parameterOrder": [ |
| 197 "project", |
| 198 "taskqueue" |
| 199 ], |
| 200 "parameters": { |
| 201 "project": { |
| 202 "description": "The project under which the queue li
es", |
| 203 "location": "path", |
| 204 "required": true, |
| 205 "type": "string" |
| 206 }, |
| 207 "taskqueue": { |
| 208 "description": "The taskqueue to insert the task int
o", |
| 209 "location": "path", |
| 210 "required": true, |
| 211 "type": "string" |
| 212 } |
| 213 }, |
| 214 "path": "{project}/taskqueues/{taskqueue}/tasks", |
| 215 "request": { |
| 216 "$ref": "Task" |
| 217 }, |
| 218 "response": { |
| 219 "$ref": "Task" |
| 220 }, |
| 221 "scopes": [ |
| 222 "https://www.googleapis.com/auth/taskqueue", |
| 223 "https://www.googleapis.com/auth/taskqueue.consumer" |
| 224 ] |
| 225 }, |
| 226 "lease": { |
| 227 "description": "Lease 1 or more tasks from a TaskQueue.", |
| 228 "httpMethod": "POST", |
| 229 "id": "taskqueue.tasks.lease", |
| 230 "parameterOrder": [ |
| 231 "project", |
| 232 "taskqueue", |
| 233 "numTasks", |
| 234 "leaseSecs" |
| 235 ], |
| 236 "parameters": { |
| 237 "groupByTag": { |
| 238 "description": "When true, all returned tasks will h
ave the same tag", |
| 239 "location": "query", |
| 240 "type": "boolean" |
| 241 }, |
| 242 "leaseSecs": { |
| 243 "description": "The lease in seconds.", |
| 244 "format": "int32", |
| 245 "location": "query", |
| 246 "required": true, |
| 247 "type": "integer" |
| 248 }, |
| 249 "numTasks": { |
| 250 "description": "The number of tasks to lease.", |
| 251 "format": "int32", |
| 252 "location": "query", |
| 253 "required": true, |
| 254 "type": "integer" |
| 255 }, |
| 256 "project": { |
| 257 "description": "The project under which the queue li
es.", |
| 258 "location": "path", |
| 259 "required": true, |
| 260 "type": "string" |
| 261 }, |
| 262 "tag": { |
| 263 "description": "The tag allowed for tasks in the res
ponse. Must only be specified if group_by_tag is true. If group_by_tag is true a
nd tag is not specified the tag will be that of the oldest task by eta, i.e. the
first available tag", |
| 264 "location": "query", |
| 265 "type": "string" |
| 266 }, |
| 267 "taskqueue": { |
| 268 "description": "The taskqueue to lease a task from."
, |
| 269 "location": "path", |
| 270 "required": true, |
| 271 "type": "string" |
| 272 } |
| 273 }, |
| 274 "path": "{project}/taskqueues/{taskqueue}/tasks/lease", |
| 275 "response": { |
| 276 "$ref": "Tasks" |
| 277 }, |
| 278 "scopes": [ |
| 279 "https://www.googleapis.com/auth/taskqueue", |
| 280 "https://www.googleapis.com/auth/taskqueue.consumer" |
| 281 ] |
| 282 }, |
| 283 "list": { |
| 284 "description": "List Tasks in a TaskQueue", |
| 285 "httpMethod": "GET", |
| 286 "id": "taskqueue.tasks.list", |
| 287 "parameterOrder": [ |
| 288 "project", |
| 289 "taskqueue" |
| 290 ], |
| 291 "parameters": { |
| 292 "project": { |
| 293 "description": "The project under which the queue li
es.", |
| 294 "location": "path", |
| 295 "required": true, |
| 296 "type": "string" |
| 297 }, |
| 298 "taskqueue": { |
| 299 "description": "The id of the taskqueue to list task
s from.", |
| 300 "location": "path", |
| 301 "required": true, |
| 302 "type": "string" |
| 303 } |
| 304 }, |
| 305 "path": "{project}/taskqueues/{taskqueue}/tasks", |
| 306 "response": { |
| 307 "$ref": "Tasks2" |
| 308 }, |
| 309 "scopes": [ |
| 310 "https://www.googleapis.com/auth/taskqueue", |
| 311 "https://www.googleapis.com/auth/taskqueue.consumer" |
| 312 ] |
| 313 }, |
| 314 "patch": { |
| 315 "description": "Update tasks that are leased out of a TaskQu
eue. This method supports patch semantics.", |
| 316 "httpMethod": "PATCH", |
| 317 "id": "taskqueue.tasks.patch", |
| 318 "parameterOrder": [ |
| 319 "project", |
| 320 "taskqueue", |
| 321 "task", |
| 322 "newLeaseSeconds" |
| 323 ], |
| 324 "parameters": { |
| 325 "newLeaseSeconds": { |
| 326 "description": "The new lease in seconds.", |
| 327 "format": "int32", |
| 328 "location": "query", |
| 329 "required": true, |
| 330 "type": "integer" |
| 331 }, |
| 332 "project": { |
| 333 "description": "The project under which the queue li
es.", |
| 334 "location": "path", |
| 335 "required": true, |
| 336 "type": "string" |
| 337 }, |
| 338 "task": { |
| 339 "location": "path", |
| 340 "required": true, |
| 341 "type": "string" |
| 342 }, |
| 343 "taskqueue": { |
| 344 "location": "path", |
| 345 "required": true, |
| 346 "type": "string" |
| 347 } |
| 348 }, |
| 349 "path": "{project}/taskqueues/{taskqueue}/tasks/{task}", |
| 350 "request": { |
| 351 "$ref": "Task" |
| 352 }, |
| 353 "response": { |
| 354 "$ref": "Task" |
| 355 }, |
| 356 "scopes": [ |
| 357 "https://www.googleapis.com/auth/taskqueue", |
| 358 "https://www.googleapis.com/auth/taskqueue.consumer" |
| 359 ] |
| 360 }, |
| 361 "update": { |
| 362 "description": "Update tasks that are leased out of a TaskQu
eue.", |
| 363 "httpMethod": "POST", |
| 364 "id": "taskqueue.tasks.update", |
| 365 "parameterOrder": [ |
| 366 "project", |
| 367 "taskqueue", |
| 368 "task", |
| 369 "newLeaseSeconds" |
| 370 ], |
| 371 "parameters": { |
| 372 "newLeaseSeconds": { |
| 373 "description": "The new lease in seconds.", |
| 374 "format": "int32", |
| 375 "location": "query", |
| 376 "required": true, |
| 377 "type": "integer" |
| 378 }, |
| 379 "project": { |
| 380 "description": "The project under which the queue li
es.", |
| 381 "location": "path", |
| 382 "required": true, |
| 383 "type": "string" |
| 384 }, |
| 385 "task": { |
| 386 "location": "path", |
| 387 "required": true, |
| 388 "type": "string" |
| 389 }, |
| 390 "taskqueue": { |
| 391 "location": "path", |
| 392 "required": true, |
| 393 "type": "string" |
| 394 } |
| 395 }, |
| 396 "path": "{project}/taskqueues/{taskqueue}/tasks/{task}", |
| 397 "request": { |
| 398 "$ref": "Task" |
| 399 }, |
| 400 "response": { |
| 401 "$ref": "Task" |
| 402 }, |
| 403 "scopes": [ |
| 404 "https://www.googleapis.com/auth/taskqueue", |
| 405 "https://www.googleapis.com/auth/taskqueue.consumer" |
| 406 ] |
| 407 } |
| 408 } |
| 409 } |
| 410 }, |
| 411 "revision": "20130318", |
| 412 "rootUrl": "https://www.googleapis.com/", |
| 413 "schemas": { |
| 414 "Task": { |
| 415 "id": "Task", |
| 416 "properties": { |
| 417 "enqueueTimestamp": { |
| 418 "description": "Time (in seconds since the epoch) at which t
he task was enqueued.", |
| 419 "format": "int64", |
| 420 "type": "string" |
| 421 }, |
| 422 "id": { |
| 423 "description": "Name of the task.", |
| 424 "type": "string" |
| 425 }, |
| 426 "kind": { |
| 427 "default": "taskqueues#task", |
| 428 "description": "The kind of object returned, in this case se
t to task.", |
| 429 "type": "string" |
| 430 }, |
| 431 "leaseTimestamp": { |
| 432 "description": "Time (in seconds since the epoch) at which t
he task lease will expire. This value is 0 if the task isnt currently leased out
to a worker.", |
| 433 "format": "int64", |
| 434 "type": "string" |
| 435 }, |
| 436 "payloadBase64": { |
| 437 "description": "A bag of bytes which is the task payload. Th
e payload on the JSON side is always Base64 encoded.", |
| 438 "type": "string" |
| 439 }, |
| 440 "queueName": { |
| 441 "description": "Name of the queue that the task is in.", |
| 442 "type": "string" |
| 443 }, |
| 444 "retry_count": { |
| 445 "description": "The number of leases applied to this task.", |
| 446 "format": "int32", |
| 447 "type": "integer" |
| 448 }, |
| 449 "tag": { |
| 450 "description": "Tag for the task, could be used later to lea
se tasks grouped by a specific tag.", |
| 451 "type": "string" |
| 452 } |
| 453 }, |
| 454 "type": "object" |
| 455 }, |
| 456 "TaskQueue": { |
| 457 "id": "TaskQueue", |
| 458 "properties": { |
| 459 "acl": { |
| 460 "description": "ACLs that are applicable to this TaskQueue o
bject.", |
| 461 "properties": { |
| 462 "adminEmails": { |
| 463 "description": "Email addresses of users who are \"a
dmins\" of the TaskQueue. This means they can control the queue, eg set ACLs for
the queue.", |
| 464 "items": { |
| 465 "type": "string" |
| 466 }, |
| 467 "type": "array" |
| 468 }, |
| 469 "consumerEmails": { |
| 470 "description": "Email addresses of users who can \"c
onsume\" tasks from the TaskQueue. This means they can Dequeue and Delete tasks
from the queue.", |
| 471 "items": { |
| 472 "type": "string" |
| 473 }, |
| 474 "type": "array" |
| 475 }, |
| 476 "producerEmails": { |
| 477 "description": "Email addresses of users who can \"p
roduce\" tasks into the TaskQueue. This means they can Insert tasks into the que
ue.", |
| 478 "items": { |
| 479 "type": "string" |
| 480 }, |
| 481 "type": "array" |
| 482 } |
| 483 }, |
| 484 "type": "object" |
| 485 }, |
| 486 "id": { |
| 487 "description": "Name of the taskqueue.", |
| 488 "type": "string" |
| 489 }, |
| 490 "kind": { |
| 491 "default": "taskqueues#taskqueue", |
| 492 "description": "The kind of REST object returned, in this ca
se taskqueue.", |
| 493 "type": "string" |
| 494 }, |
| 495 "maxLeases": { |
| 496 "description": "The number of times we should lease out task
s before giving up on them. If unset we lease them out forever until a worker de
letes the task.", |
| 497 "format": "int32", |
| 498 "type": "integer" |
| 499 }, |
| 500 "stats": { |
| 501 "description": "Statistics for the TaskQueue object in quest
ion.", |
| 502 "properties": { |
| 503 "leasedLastHour": { |
| 504 "description": "Number of tasks leased in the last h
our.", |
| 505 "format": "int64", |
| 506 "type": "string" |
| 507 }, |
| 508 "leasedLastMinute": { |
| 509 "description": "Number of tasks leased in the last m
inute.", |
| 510 "format": "int64", |
| 511 "type": "string" |
| 512 }, |
| 513 "oldestTask": { |
| 514 "description": "The timestamp (in seconds since the
epoch) of the oldest unfinished task.", |
| 515 "format": "int64", |
| 516 "type": "string" |
| 517 }, |
| 518 "totalTasks": { |
| 519 "description": "Number of tasks in the queue.", |
| 520 "format": "int32", |
| 521 "type": "integer" |
| 522 } |
| 523 }, |
| 524 "type": "object" |
| 525 } |
| 526 }, |
| 527 "type": "object" |
| 528 }, |
| 529 "Tasks": { |
| 530 "id": "Tasks", |
| 531 "properties": { |
| 532 "items": { |
| 533 "description": "The actual list of tasks returned as a resul
t of the lease operation.", |
| 534 "items": { |
| 535 "$ref": "Task" |
| 536 }, |
| 537 "type": "array" |
| 538 }, |
| 539 "kind": { |
| 540 "default": "taskqueue#tasks", |
| 541 "description": "The kind of object returned, a list of tasks
.", |
| 542 "type": "string" |
| 543 } |
| 544 }, |
| 545 "type": "object" |
| 546 }, |
| 547 "Tasks2": { |
| 548 "id": "Tasks2", |
| 549 "properties": { |
| 550 "items": { |
| 551 "description": "The actual list of tasks currently active in
the TaskQueue.", |
| 552 "items": { |
| 553 "$ref": "Task" |
| 554 }, |
| 555 "type": "array" |
| 556 }, |
| 557 "kind": { |
| 558 "default": "taskqueues#tasks", |
| 559 "description": "The kind of object returned, a list of tasks
.", |
| 560 "type": "string" |
| 561 } |
| 562 }, |
| 563 "type": "object" |
| 564 } |
| 565 }, |
| 566 "servicePath": "taskqueue/v1beta2/projects/", |
| 567 "title": "TaskQueue API", |
| 568 "version": "v1beta2" |
| 569 } |
OLD | NEW |