| Joe Gregorio | 351b149 | 2011-05-08 23:32:46 -0700 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get detailed information about a TaskQueue.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | taskqueue: string, The id of the taskqueue to get the properties of. (required)<br> |
| 21 | project: string, The project under which the queue lies. (required)<br> |
| Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame^] | 22 | getStats: boolean, Whether to get stats. Optional.<br> |
| 23 | <br> |
| 24 | Returns:<br> |
| 25 | An object of the form<br> |
| 26 | <br> |
| 27 | {<br> |
| 28 | "kind": "taskqueues#taskqueue", # The kind of REST object returned, in this case taskqueue.<br> |
| 29 | "stats": { # Statistics for the TaskQueue object in question.<br> |
| 30 | "oldestTask": "A String", # The timestamp (in seconds since the epoch) of the oldest unfinished task.<br> |
| 31 | "leasedLastMinute": "A String", # Number of tasks leased in the last minute.<br> |
| 32 | "totalTasks": 42, # Number of tasks in the queue.<br> |
| 33 | "leasedLastHour": "A String", # Number of tasks leased in the last hour.<br> |
| 34 | },<br> |
| 35 | "id": "A String", # Name of the taskqueue.<br> |
| 36 | "maxLeases": 42, # 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.<br> |
| 37 | "acl": { # ACLs that are applicable to this TaskQueue object.<br> |
| 38 | "consumerEmails": [ # Email addresses of users who can "consume" tasks from the TaskQueue. This means they can Dequeue and Delete tasks from the queue.<br> |
| 39 | "A String",<br> |
| 40 | ],<br> |
| 41 | "producerEmails": [ # Email addresses of users who can "produce" tasks into the TaskQueue. This means they can Insert tasks into the queue.<br> |
| 42 | "A String",<br> |
| 43 | ],<br> |
| 44 | "adminEmails": [ # Email addresses of users who are "admins" of the TaskQueue. This means they can control the queue, eg set ACLs for the queue.<br> |
| 45 | "A String",<br> |
| 46 | ],<br> |
| 47 | },<br> |
| 48 | }</tt></dd></dl> |
| Joe Gregorio | 351b149 | 2011-05-08 23:32:46 -0700 | [diff] [blame] | 49 | |
| 50 | <hr> |
| 51 | Data descriptors defined here:<br> |
| 52 | <dl><dt><strong>__dict__</strong></dt> |
| 53 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 54 | </dl> |
| 55 | <dl><dt><strong>__weakref__</strong></dt> |
| 56 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 57 | </dl> |
| 58 | </td></tr></table> |
| 59 | </body></html> |