Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 52a5c53138b140f8536544c1abb3f274656f518a / . / docs / epy / apiclient.push.Headers-class.html
blob: 76a41bf34896fa59153b25876566b2e8f390121d [file] [log] [blame]
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame^]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>apiclient.push.Headers</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="apiclient-module.html">Package&nbsp;apiclient</a> ::
38 <a href="apiclient.push-module.html">Module&nbsp;push</a> ::
39 Class&nbsp;Headers
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="apiclient.push.Headers-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class Headers</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.push-pysrc.html#Headers">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_headers" name="class_hierarchy_for_headers">
59<area shape="rect" id="node1" href="apiclient.push.Headers-class.html" title="Headers" alt="" coords="5,6,75,34"/>
60<area shape="rect" id="node2" href="javascript:void(0);" title="collections.defaultdict" alt="" coords="99,6,245,34"/>
61</map>
62 <img src="class_hierarchy_for_headers.gif" alt='' usemap="#class_hierarchy_for_headers" ismap="ismap" class="graph-without-title" />
63</center>
64</center>
65<hr />
66<pre class="literalblock">
67Headers for managing subscriptions.
68
69</pre>
70
71<!-- ==================== INSTANCE METHODS ==================== -->
72<a name="section-InstanceMethods"></a>
73<table class="summary" border="1" cellpadding="3"
74 cellspacing="0" width="100%" bgcolor="white">
75<tr bgcolor="#70b0f0" class="table-header">
76 <td colspan="2" class="table-header">
77 <table border="0" cellpadding="0" cellspacing="0" width="100%">
78 <tr valign="top">
79 <td align="left"><span class="table-header">Instance Methods</span></td>
80 <td align="right" valign="top"
81 ><span class="options">[<a href="#section-InstanceMethods"
82 class="privatelink" onclick="toggle_private();"
83 >hide private</a>]</span></td>
84 </tr>
85 </table>
86 </td>
87</tr>
88<tr>
89 <td width="15%" align="right" valign="top" class="summary">
90 <span class="summary-type">&nbsp;</span>
91 </td><td class="summary">
92 <table width="100%" cellpadding="0" cellspacing="0" border="0">
93 <tr>
94 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span><br />
95 Create a new subscription configuration instance.</td>
96 <td align="right" valign="top">
97 <span class="codelink"><a href="apiclient.push-pysrc.html#Headers.__init__">source&nbsp;code</a></span>
98
99 </td>
100 </tr>
101 </table>
102
103 </td>
104 </tr>
105<tr>
106 <td width="15%" align="right" valign="top" class="summary">
107 <span class="summary-type">&nbsp;</span>
108 </td><td class="summary">
109 <table width="100%" cellpadding="0" cellspacing="0" border="0">
110 <tr>
111 <td><span class="summary-sig"><a href="apiclient.push.Headers-class.html#__setitem__" class="summary-sig-name">__setitem__</a>(<span class="summary-sig-arg">self</span>,
112 <span class="summary-sig-arg">key</span>,
113 <span class="summary-sig-arg">value</span>)</span><br />
114 Set a header value, ensuring the key is an allowed value.</td>
115 <td align="right" valign="top">
116 <span class="codelink"><a href="apiclient.push-pysrc.html#Headers.__setitem__">source&nbsp;code</a></span>
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124<tr>
125 <td width="15%" align="right" valign="top" class="summary">
126 <span class="summary-type">&nbsp;</span>
127 </td><td class="summary">
128 <table width="100%" cellpadding="0" cellspacing="0" border="0">
129 <tr>
130 <td><span class="summary-sig"><a href="apiclient.push.Headers-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
131 <span class="summary-sig-arg">key</span>)</span><br />
132 Get a header value, normalizing the key case.</td>
133 <td align="right" valign="top">
134 <span class="codelink"><a href="apiclient.push-pysrc.html#Headers.__getitem__">source&nbsp;code</a></span>
135
136 </td>
137 </tr>
138 </table>
139
140 </td>
141 </tr>
142<tr class="private">
143 <td width="15%" align="right" valign="top" class="summary">
144 <span class="summary-type">&nbsp;</span>
145 </td><td class="summary">
146 <table width="100%" cellpadding="0" cellspacing="0" border="0">
147 <tr>
148 <td><span class="summary-sig"><a name="_normalize_key"></a><span class="summary-sig-name">_normalize_key</span>(<span class="summary-sig-arg">self</span>,
149 <span class="summary-sig-arg">key</span>)</span><br />
150 Normalize a header name for use as a key.</td>
151 <td align="right" valign="top">
152 <span class="codelink"><a href="apiclient.push-pysrc.html#Headers._normalize_key">source&nbsp;code</a></span>
153
154 </td>
155 </tr>
156 </table>
157
158 </td>
159 </tr>
160<tr>
161 <td width="15%" align="right" valign="top" class="summary">
162 <span class="summary-type">&nbsp;</span>
163 </td><td class="summary">
164 <table width="100%" cellpadding="0" cellspacing="0" border="0">
165 <tr>
166 <td><span class="summary-sig"><a name="items"></a><span class="summary-sig-name">items</span>(<span class="summary-sig-arg">self</span>)</span><br />
167 Generator for each header.</td>
168 <td align="right" valign="top">
169 <span class="codelink"><a href="apiclient.push-pysrc.html#Headers.items">source&nbsp;code</a></span>
170
171 </td>
172 </tr>
173 </table>
174
175 </td>
176 </tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <table width="100%" cellpadding="0" cellspacing="0" border="0">
182 <tr>
183 <td><span class="summary-sig"><a href="apiclient.push.Headers-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
184 <span class="summary-sig-arg">headers</span>)</span><br />
185 Applies the subscription headers.</td>
186 <td align="right" valign="top">
187 <span class="codelink"><a href="apiclient.push-pysrc.html#Headers.write">source&nbsp;code</a></span>
188
189 </td>
190 </tr>
191 </table>
192
193 </td>
194 </tr>
195<tr>
196 <td width="15%" align="right" valign="top" class="summary">
197 <span class="summary-type">&nbsp;</span>
198 </td><td class="summary">
199 <table width="100%" cellpadding="0" cellspacing="0" border="0">
200 <tr>
201 <td><span class="summary-sig"><a href="apiclient.push.Headers-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>,
202 <span class="summary-sig-arg">headers</span>)</span><br />
203 Read from headers.</td>
204 <td align="right" valign="top">
205 <span class="codelink"><a href="apiclient.push-pysrc.html#Headers.read">source&nbsp;code</a></span>
206
207 </td>
208 </tr>
209 </table>
210
211 </td>
212 </tr>
213</table>
214<!-- ==================== CLASS VARIABLES ==================== -->
215<a name="section-ClassVariables"></a>
216<table class="summary" border="1" cellpadding="3"
217 cellspacing="0" width="100%" bgcolor="white">
218<tr bgcolor="#70b0f0" class="table-header">
219 <td colspan="2" class="table-header">
220 <table border="0" cellpadding="0" cellspacing="0" width="100%">
221 <tr valign="top">
222 <td align="left"><span class="table-header">Class Variables</span></td>
223 <td align="right" valign="top"
224 ><span class="options">[<a href="#section-ClassVariables"
225 class="privatelink" onclick="toggle_private();"
226 >hide private</a>]</span></td>
227 </tr>
228 </table>
229 </td>
230</tr>
231<tr>
232 <td width="15%" align="right" valign="top" class="summary">
233 <span class="summary-type">&nbsp;</span>
234 </td><td class="summary">
235 <a href="apiclient.push.Headers-class.html#ALL_HEADERS" class="summary-name">ALL_HEADERS</a> = <code title="set([SUBSCRIBE, SUBSCRIPTION_ID, TOPIC_ID, TOPIC_URI, CLIENT_TOKEN, EV\
236ENT_TYPE, UNSUBSCRIBE])">set([SUBSCRIBE, SUBSCRIPTION_ID, TOPIC_ID, TOPIC<code class="variable-ellipsis">...</code></code>
237 </td>
238 </tr>
239</table>
240<!-- ==================== METHOD DETAILS ==================== -->
241<a name="section-MethodDetails"></a>
242<table class="details" border="1" cellpadding="3"
243 cellspacing="0" width="100%" bgcolor="white">
244<tr bgcolor="#70b0f0" class="table-header">
245 <td colspan="2" class="table-header">
246 <table border="0" cellpadding="0" cellspacing="0" width="100%">
247 <tr valign="top">
248 <td align="left"><span class="table-header">Method Details</span></td>
249 <td align="right" valign="top"
250 ><span class="options">[<a href="#section-MethodDetails"
251 class="privatelink" onclick="toggle_private();"
252 >hide private</a>]</span></td>
253 </tr>
254 </table>
255 </td>
256</tr>
257</table>
258<a name="__setitem__"></a>
259<div>
260<table class="details" border="1" cellpadding="3"
261 cellspacing="0" width="100%" bgcolor="white">
262<tr><td>
263 <table width="100%" cellpadding="0" cellspacing="0" border="0">
264 <tr valign="top"><td>
265 <h3 class="epydoc"><span class="sig"><span class="sig-name">__setitem__</span>(<span class="sig-arg">self</span>,
266 <span class="sig-arg">key</span>,
267 <span class="sig-arg">value</span>)</span>
268 <br /><em class="fname">(Index assignment operator)</em>
269 </h3>
270 </td><td align="right" valign="top"
271 ><span class="codelink"><a href="apiclient.push-pysrc.html#Headers.__setitem__">source&nbsp;code</a></span>&nbsp;
272 </td>
273 </tr></table>
274
275 <pre class="literalblock">
276Set a header value, ensuring the key is an allowed value.
277
278Args:
279 key: str, the header key.
280 value: str, the header value.
281Raises:
282 ValueError if key is not one of the accepted headers.
283
284</pre>
285 <dl class="fields">
286 </dl>
287</td></tr></table>
288</div>
289<a name="__getitem__"></a>
290<div>
291<table class="details" border="1" cellpadding="3"
292 cellspacing="0" width="100%" bgcolor="white">
293<tr><td>
294 <table width="100%" cellpadding="0" cellspacing="0" border="0">
295 <tr valign="top"><td>
296 <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>,
297 <span class="sig-arg">key</span>)</span>
298 <br /><em class="fname">(Indexing operator)</em>
299 </h3>
300 </td><td align="right" valign="top"
301 ><span class="codelink"><a href="apiclient.push-pysrc.html#Headers.__getitem__">source&nbsp;code</a></span>&nbsp;
302 </td>
303 </tr></table>
304
305 <pre class="literalblock">
306Get a header value, normalizing the key case.
307
308Args:
309 key: str, the header key.
310Returns:
311 String header value.
312Raises:
313 KeyError if the key is not one of the accepted headers.
314
315</pre>
316 <dl class="fields">
317 </dl>
318</td></tr></table>
319</div>
320<a name="write"></a>
321<div>
322<table class="details" border="1" cellpadding="3"
323 cellspacing="0" width="100%" bgcolor="white">
324<tr><td>
325 <table width="100%" cellpadding="0" cellspacing="0" border="0">
326 <tr valign="top"><td>
327 <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,
328 <span class="sig-arg">headers</span>)</span>
329 </h3>
330 </td><td align="right" valign="top"
331 ><span class="codelink"><a href="apiclient.push-pysrc.html#Headers.write">source&nbsp;code</a></span>&nbsp;
332 </td>
333 </tr></table>
334
335 <pre class="literalblock">
336Applies the subscription headers.
337
338Args:
339 headers: dict of headers to insert values into.
340
341</pre>
342 <dl class="fields">
343 </dl>
344</td></tr></table>
345</div>
346<a name="read"></a>
347<div>
348<table class="details" border="1" cellpadding="3"
349 cellspacing="0" width="100%" bgcolor="white">
350<tr><td>
351 <table width="100%" cellpadding="0" cellspacing="0" border="0">
352 <tr valign="top"><td>
353 <h3 class="epydoc"><span class="sig"><span class="sig-name">read</span>(<span class="sig-arg">self</span>,
354 <span class="sig-arg">headers</span>)</span>
355 </h3>
356 </td><td align="right" valign="top"
357 ><span class="codelink"><a href="apiclient.push-pysrc.html#Headers.read">source&nbsp;code</a></span>&nbsp;
358 </td>
359 </tr></table>
360
361 <pre class="literalblock">
362Read from headers.
363
364Args:
365 headers: dict of headers to read from.
366
367</pre>
368 <dl class="fields">
369 </dl>
370</td></tr></table>
371</div>
372<br />
373<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
374<a name="section-ClassVariableDetails"></a>
375<table class="details" border="1" cellpadding="3"
376 cellspacing="0" width="100%" bgcolor="white">
377<tr bgcolor="#70b0f0" class="table-header">
378 <td colspan="2" class="table-header">
379 <table border="0" cellpadding="0" cellspacing="0" width="100%">
380 <tr valign="top">
381 <td align="left"><span class="table-header">Class Variable Details</span></td>
382 <td align="right" valign="top"
383 ><span class="options">[<a href="#section-ClassVariableDetails"
384 class="privatelink" onclick="toggle_private();"
385 >hide private</a>]</span></td>
386 </tr>
387 </table>
388 </td>
389</tr>
390</table>
391<a name="ALL_HEADERS"></a>
392<div>
393<table class="details" border="1" cellpadding="3"
394 cellspacing="0" width="100%" bgcolor="white">
395<tr><td>
396 <h3 class="epydoc">ALL_HEADERS</h3>
397
398 <dl class="fields">
399 </dl>
400 <dl class="fields">
401 <dt>Value:</dt>
402 <dd><table><tr><td><pre class="variable">
403set([SUBSCRIBE, SUBSCRIPTION_ID, TOPIC_ID, TOPIC_URI, CLIENT_TOKEN, EV<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
404ENT_TYPE, UNSUBSCRIBE])
405</pre></td></tr></table>
406</dd>
407 </dl>
408</td></tr></table>
409</div>
410<br />
411<!-- ==================== NAVIGATION BAR ==================== -->
412<table class="navbar" border="0" width="100%" cellpadding="0"
413 bgcolor="#a0c0ff" cellspacing="0">
414 <tr valign="middle">
415
416 <!-- Tree link -->
417 <th>&nbsp;&nbsp;&nbsp;<a
418 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
419
420 <!-- Index link -->
421 <th>&nbsp;&nbsp;&nbsp;<a
422 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
423
424 <!-- Help link -->
425 <th>&nbsp;&nbsp;&nbsp;<a
426 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
427
428 <th class="navbar" width="100%"></th>
429 </tr>
430</table>
431<table border="0" cellpadding="0" cellspacing="0" width="100%%">
432 <tr>
433 <td align="left" class="footer">
434 Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
435 </td>
436 <td align="right" class="footer">
437 <a target="mainFrame" href="http://epydoc.sourceforge.net"
438 >http://epydoc.sourceforge.net</a>
439 </td>
440 </tr>
441</table>
442
443<script type="text/javascript">
444 <!--
445 // Private objects are initially displayed (because if
446 // javascript is turned off then we want them to be
447 // visible); but by default, we want to hide them. So hide
448 // them unless we have a cookie that says to show them.
449 checkCookie();
450 // -->
451</script>
452</body>
453</html>