| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <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> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete a task from a TaskQueue.<br> |
| <br> |
| Args:<br> |
| project: string, The project under which the queue lies. (required)<br> |
| pp: string, A parameter<br> |
| task: string, The id of the task to delete. (required)<br> |
| trace: string, A parameter<br> |
| taskqueue: string, The taskqueue to delete a task from. (required)<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a particular task from a TaskQueue.<br> |
| <br> |
| Args:<br> |
| project: string, The project under which the queue lies. (required)<br> |
| pp: string, A parameter<br> |
| task: string, The task to get properties of. (required)<br> |
| trace: string, A parameter<br> |
| taskqueue: string, The taskqueue in which the task belongs. (required)<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Insert a new task in a TaskQueue<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| }<br> |
| <br> |
| project: string, The project under which the queue lies (required)<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| taskqueue: string, The taskqueue to insert the task into (required)<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-lease"><strong>lease</strong></a> = method(self, **kwargs)</dt><dd><tt>Lease 1 or more tasks from a TaskQueue.<br> |
| <br> |
| Args:<br> |
| groupByTag: boolean, When true, all returned tasks will have the same tag<br> |
| project: string, The project under which the queue lies. (required)<br> |
| pp: string, A parameter<br> |
| leaseSecs: integer, The lease in seconds. (required)<br> |
| taskqueue: string, The taskqueue to lease a task from. (required)<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| tag: string, The tag allowed for tasks in the response. Must only be specified if group_by_tag is true. If group_by_tag is true and tag is not specified the tag will be that of the oldest task by eta, i.e. the first available tag<br> |
| trace: string, A parameter<br> |
| numTasks: integer, The number of tasks to lease. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "items": [ # The actual list of tasks returned as a result of the lease operation.<br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| },<br> |
| ],<br> |
| "kind": "taskqueue#tasks", # The kind of object returned, a list of tasks.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List Tasks in a TaskQueue<br> |
| <br> |
| Args:<br> |
| project: string, The project under which the queue lies. (required)<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| taskqueue: string, The id of the taskqueue to list tasks from. (required)<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "items": [ # The actual list of tasks currently active in the TaskQueue.<br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| },<br> |
| ],<br> |
| "kind": "taskqueues#tasks", # The kind of object returned, a list of tasks.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update tasks that are leased out of a TaskQueue. This method supports patch semantics.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| }<br> |
| <br> |
| project: string, The project under which the queue lies. (required)<br> |
| pp: string, A parameter<br> |
| task: string, A parameter (required)<br> |
| newLeaseSeconds: integer, The new lease in seconds. (required)<br> |
| trace: string, A parameter<br> |
| taskqueue: string, A parameter (required)<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update tasks that are leased out of a TaskQueue.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| }<br> |
| <br> |
| project: string, The project under which the queue lies. (required)<br> |
| pp: string, A parameter<br> |
| task: string, A parameter (required)<br> |
| newLeaseSeconds: integer, The new lease in seconds. (required)<br> |
| trace: string, A parameter<br> |
| taskqueue: string, A parameter (required)<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "taskqueues#task", # The kind of object returned, in this case set to task.<br> |
| "leaseTimestamp": "A String", # 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.<br> |
| "id": "A String", # Name of the task.<br> |
| "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.<br> |
| "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.<br> |
| "queueName": "A String", # Name of the queue that the task is in.<br> |
| "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.<br> |
| }</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |