Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="taskqueue_v1beta1.html">TaskQueue API</a> . <a href="taskqueue_v1beta1.taskqueues.html">taskqueues</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(project, taskqueue, getStats=None)</a></code></p>
     79 <p class="firstline">Get detailed information about a TaskQueue.</p>
     80 <h3>Method Details</h3>
     81 <div class="method">
     82     <code class="details" id="get">get(project, taskqueue, getStats=None)</code>
     83   <pre>Get detailed information about a TaskQueue.
     84 
     85 Args:
     86   project: string, The project under which the queue lies. (required)
     87   taskqueue: string, The id of the taskqueue to get the properties of. (required)
     88   getStats: boolean, Whether to get stats. Optional.
     89 
     90 Returns:
     91   An object of the form:
     92 
     93     {
     94     "kind": "taskqueues#taskqueue", # The kind of REST object returned, in this case taskqueue.
     95     "stats": { # Statistics for the TaskQueue object in question.
     96       "oldestTask": "A String", # The timestamp (in seconds since the epoch) of the oldest unfinished task.
     97       "leasedLastMinute": "A String", # Number of tasks leased in the last minute.
     98       "totalTasks": 42, # Number of tasks in the queue.
     99       "leasedLastHour": "A String", # Number of tasks leased in the last hour.
    100     },
    101     "id": "A String", # Name of the taskqueue.
    102     "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.
    103     "acl": { # ACLs that are applicable to this TaskQueue object.
    104       "consumerEmails": [ # Email addresses of users who can "consume" tasks from the TaskQueue. This means they can Dequeue and Delete tasks from the queue.
    105         "A String",
    106       ],
    107       "producerEmails": [ # Email addresses of users who can "produce" tasks into the TaskQueue. This means they can Insert tasks into the queue.
    108         "A String",
    109       ],
    110       "adminEmails": [ # Email addresses of users who are "admins" of the TaskQueue. This means they can control the queue, eg set ACLs for the queue.
    111         "A String",
    112       ],
    113     },
    114   }</pre>
    115 </div>
    116 
    117 </body></html>