docs/dyn/freebase.v1-dev.html - platform/external/python/google-api-python-client - Gitiles


 <!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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</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-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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;format:&nbsp;string,&nbsp;The&nbsp;format&nbsp;of&nbsp;the&nbsp;result.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;The&nbsp;content&nbsp;is&nbsp;a&nbsp;JSON&nbsp;encoded&nbsp;object.<br>
 &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>
 &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>
 &nbsp;&nbsp;dbName:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)</tt></dd></dl>

 <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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;maxwidth:&nbsp;integer,&nbsp;Maximum&nbsp;width&nbsp;in&nbsp;pixels&nbsp;for&nbsp;resulting&nbsp;image.<br>
 &nbsp;&nbsp;maxheight:&nbsp;integer,&nbsp;Maximum&nbsp;height&nbsp;in&nbsp;pixels&nbsp;for&nbsp;resulting&nbsp;image.<br>
 &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>
 &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>
 &nbsp;&nbsp;mode:&nbsp;string,&nbsp;Method&nbsp;used&nbsp;to&nbsp;scale&nbsp;or&nbsp;crop&nbsp;image.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fill&nbsp;-&nbsp;TODO(bendrees)<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fillcrop&nbsp;-&nbsp;TODO(bendrees)<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fillcropmid&nbsp;-&nbsp;TODO(bendrees)<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fit&nbsp;-&nbsp;TODO(bendrees)<br>
 &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>

 <dl><dt><a name="Resource-mqlread"><strong>mqlread</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs&nbsp;MQL&nbsp;Queries.<br>
 &nbsp;<br>
 Args:<br>
 &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>
 &nbsp;&nbsp;cursor:&nbsp;string,&nbsp;The&nbsp;mql&nbsp;cursor.<br>
 &nbsp;&nbsp;indent:&nbsp;integer,&nbsp;How&nbsp;many&nbsp;spaces&nbsp;to&nbsp;indent&nbsp;the&nbsp;json.<br>
 &nbsp;&nbsp;callback:&nbsp;string,&nbsp;JS&nbsp;method&nbsp;name&nbsp;for&nbsp;JSONP&nbsp;callbacks.<br>
 &nbsp;&nbsp;uniqueness_failure:&nbsp;string,&nbsp;How&nbsp;MQL&nbsp;responds&nbsp;to&nbsp;uniqueness&nbsp;failures.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;hard&nbsp;-&nbsp;Be&nbsp;strict&nbsp;-&nbsp;throw&nbsp;an&nbsp;error.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;soft&nbsp;-&nbsp;Just&nbsp;return&nbsp;the&nbsp;first&nbsp;encountered&nbsp;object.<br>
 &nbsp;&nbsp;html_escape:&nbsp;boolean,&nbsp;Whether&nbsp;or&nbsp;not&nbsp;to&nbsp;escape&nbsp;entities.<br>
 &nbsp;&nbsp;cost:&nbsp;boolean,&nbsp;Show&nbsp;the&nbsp;costs&nbsp;or&nbsp;not.<br>
 &nbsp;&nbsp;query:&nbsp;string,&nbsp;An&nbsp;envelope&nbsp;containing&nbsp;a&nbsp;single&nbsp;MQL&nbsp;query.&nbsp;(required)<br>
 &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>

 <dl><dt><a name="Resource-mqlwrite"><strong>mqlwrite</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs&nbsp;MQL&nbsp;Write&nbsp;Operations.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;indent:&nbsp;integer,&nbsp;How&nbsp;many&nbsp;spaces&nbsp;to&nbsp;indent&nbsp;the&nbsp;json.<br>
 &nbsp;&nbsp;callback:&nbsp;string,&nbsp;JS&nbsp;method&nbsp;name&nbsp;for&nbsp;JSONP&nbsp;callbacks.<br>
 &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>
 &nbsp;&nbsp;query:&nbsp;string,&nbsp;An&nbsp;MQL&nbsp;query&nbsp;with&nbsp;write&nbsp;directives.&nbsp;(required)</tt></dd></dl>

 <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>

 <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>
 &nbsp;<br>
 Args:<br>
 &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>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.<br>
 &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>
 &nbsp;&nbsp;media_body:&nbsp;string,&nbsp;The&nbsp;filename&nbsp;of&nbsp;the&nbsp;media&nbsp;request&nbsp;body.<br>
 &nbsp;&nbsp;text_encoding:&nbsp;string,&nbsp;The&nbsp;encoding&nbsp;of&nbsp;the&nbsp;content&nbsp;-&nbsp;e.g.&nbsp;'utf-8'<br>
 &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>
 &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>
 &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>
 &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>

 <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>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!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-dataset"><strong>dataset</strong></a> = method(self, **kwargs)</dt><dd><tt>Provides access to various key/value databases used by Freebase, with the id in the path.<br>
	<br>
	Args:<br>
	format: string, The format of the result.<br>
	Allowed values<br>
	json - The content is a JSON encoded object.<br>
	raw - The content of the response is the raw bytes of the desired value. The content-type is set to text/plain<br>
	id: string, The id of the item that you want data about (required) (repeated)<br>
	dbName: string, A parameter (required)</tt></dd></dl>

	<dl><dt><a name="Resource-image"><strong>image</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the scaled/cropped image attached to a freebase node.<br>
	<br>
	Args:<br>
	maxwidth: integer, Maximum width in pixels for resulting image.<br>
	maxheight: integer, Maximum height in pixels for resulting image.<br>
	fallbackid: string, Use the image associated with this secondary id if no image is associated with the primary id.<br>
	pad: boolean, A boolean specifying whether the resulting image should be padded up to the requested dimensions.<br>
	mode: string, Method used to scale or crop image.<br>
	Allowed values<br>
	fill - TODO(bendrees)<br>
	fillcrop - TODO(bendrees)<br>
	fillcropmid - TODO(bendrees)<br>
	fit - TODO(bendrees)<br>
	id: string, Freebase entity or content id, mid, or guid. (required) (repeated)</tt></dd></dl>

	<dl><dt><a name="Resource-mqlread"><strong>mqlread</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs MQL Queries.<br>
	<br>
	Args:<br>
	lang: string, The language of the results - an id of a /type/lang object.<br>
	cursor: string, The mql cursor.<br>
	indent: integer, How many spaces to indent the json.<br>
	callback: string, JS method name for JSONP callbacks.<br>
	uniqueness_failure: string, How MQL responds to uniqueness failures.<br>
	Allowed values<br>
	hard - Be strict - throw an error.<br>
	soft - Just return the first encountered object.<br>
	html_escape: boolean, Whether or not to escape entities.<br>
	cost: boolean, Show the costs or not.<br>
	query: string, An envelope containing a single MQL query. (required)<br>
	as_of_time: string, Run the query as it would've been run at the specified point in time.</tt></dd></dl>

	<dl><dt><a name="Resource-mqlwrite"><strong>mqlwrite</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs MQL Write Operations.<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	indent: integer, How many spaces to indent the json.<br>
	callback: string, JS method name for JSONP callbacks.<br>
	use_permission_of: string, Use the same permission node of the object with the specified id.<br>
	query: string, An MQL query with write directives. (required)</tt></dd></dl>

	<dl><dt><a name="Resource-text"><strong><a href="freebase.v1-dev.text.html">text</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>

	<dl><dt><a name="Resource-upload"><strong>upload</strong></a> = method(self, **kwargs)</dt><dd><tt>Uploads data to the Freebase blobstore and creates documents in the graph.<br>
	<br>
	Args:<br>
	lang: string, An id of a /type/lang object that will be used as the language - e.g. '/lang/fr'<br>
	body: object, The request body.<br>
	license: string, An id of a /common/license object that you want to use as the license of this content<br>
	media_body: string, The filename of the media request body.<br>
	text_encoding: string, The encoding of the content - e.g. 'utf-8'<br>
	rights_holder: string, An id of a user or topic that is considered to be the rights holder for this content - applies only to images.<br>
	use_permission_of: string, An id of an object that has the permissions that you want to use in the document node.<br>
	content: string, An id of a /type/content object that should be the last content attached to the document node specified. This is a consistency check and will make sure that the content has not changed since the request was created. The document parameter must also be passed if this is present.<br>
	document: string, An id of a /common/document object that you'd like to attach this content.</tt></dd></dl>

	<dl><dt><a name="Resource-user"><strong><a href="freebase.v1-dev.user.html">user</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</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>