Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02503857cef62a9180632b798eacd30ae049f3c3 / . / docs / dyn / freebase.v1-dev.html
blob: be8ec1bdd1f746fe73cb7de3fc18eb3d8da78572 [file] [log] [blame]
Joe Gregorio02503852011-08-31 09:07:55 -0400[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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</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-dataset"><strong>dataset</strong></a> = method(self, **kwargs)</dt><dd><tt>Provides&nbsp;access&nbsp;to&nbsp;various&nbsp;key/value&nbsp;databases&nbsp;used&nbsp;by&nbsp;Freebase,&nbsp;with&nbsp;the&nbsp;id&nbsp;in&nbsp;the&nbsp;path.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;format:&nbsp;string,&nbsp;The&nbsp;format&nbsp;of&nbsp;the&nbsp;result.<br>
21&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
22&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;The&nbsp;content&nbsp;is&nbsp;a&nbsp;JSON&nbsp;encoded&nbsp;object.<br>
23&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raw&nbsp;-&nbsp;The&nbsp;content&nbsp;of&nbsp;the&nbsp;response&nbsp;is&nbsp;the&nbsp;raw&nbsp;bytes&nbsp;of&nbsp;the&nbsp;desired&nbsp;value.&nbsp;The&nbsp;content-type&nbsp;is&nbsp;set&nbsp;to&nbsp;text/plain<br>
24&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;item&nbsp;that&nbsp;you&nbsp;want&nbsp;data&nbsp;about&nbsp;(required)&nbsp;(repeated)<br>
25&nbsp;&nbsp;dbName:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)</tt></dd></dl>
26
27<dl><dt><a name="Resource-image"><strong>image</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;the&nbsp;scaled/cropped&nbsp;image&nbsp;attached&nbsp;to&nbsp;a&nbsp;freebase&nbsp;node.<br>
28&nbsp;<br>
29Args:<br>
30&nbsp;&nbsp;maxwidth:&nbsp;integer,&nbsp;Maximum&nbsp;width&nbsp;in&nbsp;pixels&nbsp;for&nbsp;resulting&nbsp;image.<br>
31&nbsp;&nbsp;maxheight:&nbsp;integer,&nbsp;Maximum&nbsp;height&nbsp;in&nbsp;pixels&nbsp;for&nbsp;resulting&nbsp;image.<br>
32&nbsp;&nbsp;fallbackid:&nbsp;string,&nbsp;Use&nbsp;the&nbsp;image&nbsp;associated&nbsp;with&nbsp;this&nbsp;secondary&nbsp;id&nbsp;if&nbsp;no&nbsp;image&nbsp;is&nbsp;associated&nbsp;with&nbsp;the&nbsp;primary&nbsp;id.<br>
33&nbsp;&nbsp;pad:&nbsp;boolean,&nbsp;A&nbsp;boolean&nbsp;specifying&nbsp;whether&nbsp;the&nbsp;resulting&nbsp;image&nbsp;should&nbsp;be&nbsp;padded&nbsp;up&nbsp;to&nbsp;the&nbsp;requested&nbsp;dimensions.<br>
34&nbsp;&nbsp;mode:&nbsp;string,&nbsp;Method&nbsp;used&nbsp;to&nbsp;scale&nbsp;or&nbsp;crop&nbsp;image.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fill&nbsp;-&nbsp;TODO(bendrees)<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fillcrop&nbsp;-&nbsp;TODO(bendrees)<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fillcropmid&nbsp;-&nbsp;TODO(bendrees)<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fit&nbsp;-&nbsp;TODO(bendrees)<br>
40&nbsp;&nbsp;id:&nbsp;string,&nbsp;Freebase&nbsp;entity&nbsp;or&nbsp;content&nbsp;id,&nbsp;mid,&nbsp;or&nbsp;guid.&nbsp;(required)&nbsp;(repeated)</tt></dd></dl>
41
42<dl><dt><a name="Resource-mqlread"><strong>mqlread</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs&nbsp;MQL&nbsp;Queries.<br>
43&nbsp;<br>
44Args:<br>
45&nbsp;&nbsp;lang:&nbsp;string,&nbsp;The&nbsp;language&nbsp;of&nbsp;the&nbsp;results&nbsp;-&nbsp;an&nbsp;id&nbsp;of&nbsp;a&nbsp;/type/lang&nbsp;object.<br>
46&nbsp;&nbsp;cursor:&nbsp;string,&nbsp;The&nbsp;mql&nbsp;cursor.<br>
47&nbsp;&nbsp;indent:&nbsp;integer,&nbsp;How&nbsp;many&nbsp;spaces&nbsp;to&nbsp;indent&nbsp;the&nbsp;json.<br>
48&nbsp;&nbsp;callback:&nbsp;string,&nbsp;JS&nbsp;method&nbsp;name&nbsp;for&nbsp;JSONP&nbsp;callbacks.<br>
49&nbsp;&nbsp;uniqueness_failure:&nbsp;string,&nbsp;How&nbsp;MQL&nbsp;responds&nbsp;to&nbsp;uniqueness&nbsp;failures.<br>
50&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;hard&nbsp;-&nbsp;Be&nbsp;strict&nbsp;-&nbsp;throw&nbsp;an&nbsp;error.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;soft&nbsp;-&nbsp;Just&nbsp;return&nbsp;the&nbsp;first&nbsp;encountered&nbsp;object.<br>
53&nbsp;&nbsp;html_escape:&nbsp;boolean,&nbsp;Whether&nbsp;or&nbsp;not&nbsp;to&nbsp;escape&nbsp;entities.<br>
54&nbsp;&nbsp;cost:&nbsp;boolean,&nbsp;Show&nbsp;the&nbsp;costs&nbsp;or&nbsp;not.<br>
55&nbsp;&nbsp;query:&nbsp;string,&nbsp;An&nbsp;envelope&nbsp;containing&nbsp;a&nbsp;single&nbsp;MQL&nbsp;query.&nbsp;(required)<br>
56&nbsp;&nbsp;as_of_time:&nbsp;string,&nbsp;Run&nbsp;the&nbsp;query&nbsp;as&nbsp;it&nbsp;would've&nbsp;been&nbsp;run&nbsp;at&nbsp;the&nbsp;specified&nbsp;point&nbsp;in&nbsp;time.</tt></dd></dl>
57
58<dl><dt><a name="Resource-mqlwrite"><strong>mqlwrite</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs&nbsp;MQL&nbsp;Write&nbsp;Operations.<br>
59&nbsp;<br>
60Args:<br>
61&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
62&nbsp;&nbsp;indent:&nbsp;integer,&nbsp;How&nbsp;many&nbsp;spaces&nbsp;to&nbsp;indent&nbsp;the&nbsp;json.<br>
63&nbsp;&nbsp;callback:&nbsp;string,&nbsp;JS&nbsp;method&nbsp;name&nbsp;for&nbsp;JSONP&nbsp;callbacks.<br>
64&nbsp;&nbsp;use_permission_of:&nbsp;string,&nbsp;Use&nbsp;the&nbsp;same&nbsp;permission&nbsp;node&nbsp;of&nbsp;the&nbsp;object&nbsp;with&nbsp;the&nbsp;specified&nbsp;id.<br>
65&nbsp;&nbsp;query:&nbsp;string,&nbsp;An&nbsp;MQL&nbsp;query&nbsp;with&nbsp;write&nbsp;directives.&nbsp;(required)</tt></dd></dl>
66
67<dl><dt><a name="Resource-text"><strong><a href="freebase.v1-dev.text.html">text</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
68
69<dl><dt><a name="Resource-upload"><strong>upload</strong></a> = method(self, **kwargs)</dt><dd><tt>Uploads&nbsp;data&nbsp;to&nbsp;the&nbsp;Freebase&nbsp;blobstore&nbsp;and&nbsp;creates&nbsp;documents&nbsp;in&nbsp;the&nbsp;graph.<br>
70&nbsp;<br>
71Args:<br>
72&nbsp;&nbsp;lang:&nbsp;string,&nbsp;An&nbsp;id&nbsp;of&nbsp;a&nbsp;/type/lang&nbsp;object&nbsp;that&nbsp;will&nbsp;be&nbsp;used&nbsp;as&nbsp;the&nbsp;language&nbsp;-&nbsp;e.g.&nbsp;'/lang/fr'<br>
73&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.<br>
74&nbsp;&nbsp;license:&nbsp;string,&nbsp;An&nbsp;id&nbsp;of&nbsp;a&nbsp;/common/license&nbsp;object&nbsp;that&nbsp;you&nbsp;want&nbsp;to&nbsp;use&nbsp;as&nbsp;the&nbsp;license&nbsp;of&nbsp;this&nbsp;content<br>
75&nbsp;&nbsp;media_body:&nbsp;string,&nbsp;The&nbsp;filename&nbsp;of&nbsp;the&nbsp;media&nbsp;request&nbsp;body.<br>
76&nbsp;&nbsp;text_encoding:&nbsp;string,&nbsp;The&nbsp;encoding&nbsp;of&nbsp;the&nbsp;content&nbsp;-&nbsp;e.g.&nbsp;'utf-8'<br>
77&nbsp;&nbsp;rights_holder:&nbsp;string,&nbsp;An&nbsp;id&nbsp;of&nbsp;a&nbsp;user&nbsp;or&nbsp;topic&nbsp;that&nbsp;is&nbsp;considered&nbsp;to&nbsp;be&nbsp;the&nbsp;rights&nbsp;holder&nbsp;for&nbsp;this&nbsp;content&nbsp;-&nbsp;applies&nbsp;only&nbsp;to&nbsp;images.<br>
78&nbsp;&nbsp;use_permission_of:&nbsp;string,&nbsp;An&nbsp;id&nbsp;of&nbsp;an&nbsp;object&nbsp;that&nbsp;has&nbsp;the&nbsp;permissions&nbsp;that&nbsp;you&nbsp;want&nbsp;to&nbsp;use&nbsp;in&nbsp;the&nbsp;document&nbsp;node.<br>
79&nbsp;&nbsp;content:&nbsp;string,&nbsp;An&nbsp;id&nbsp;of&nbsp;a&nbsp;/type/content&nbsp;object&nbsp;that&nbsp;should&nbsp;be&nbsp;the&nbsp;last&nbsp;content&nbsp;attached&nbsp;to&nbsp;the&nbsp;document&nbsp;node&nbsp;specified.&nbsp;This&nbsp;is&nbsp;a&nbsp;consistency&nbsp;check&nbsp;and&nbsp;will&nbsp;make&nbsp;sure&nbsp;that&nbsp;the&nbsp;content&nbsp;has&nbsp;not&nbsp;changed&nbsp;since&nbsp;the&nbsp;request&nbsp;was&nbsp;created.&nbsp;The&nbsp;document&nbsp;parameter&nbsp;must&nbsp;also&nbsp;be&nbsp;passed&nbsp;if&nbsp;this&nbsp;is&nbsp;present.<br>
80&nbsp;&nbsp;document:&nbsp;string,&nbsp;An&nbsp;id&nbsp;of&nbsp;a&nbsp;/common/document&nbsp;object&nbsp;that&nbsp;you'd&nbsp;like&nbsp;to&nbsp;attach&nbsp;this&nbsp;content.</tt></dd></dl>
81
82<dl><dt><a name="Resource-user"><strong><a href="freebase.v1-dev.user.html">user</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
83
84<hr>
85Data descriptors defined here:<br>
86<dl><dt><strong>__dict__</strong></dt>
87<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
88</dl>
89<dl><dt><strong>__weakref__</strong></dt>
90<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
91</dl>
92</td></tr></table>
93</body></html>