Refresh docs
@@ -97,7 +97,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
@@ -121,9 +121,9 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
|
||||
"items": [ # A list of accounts.
|
||||
{
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
@@ -150,7 +150,7 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
@@ -168,7 +168,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
@@ -192,7 +192,7 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
@@ -210,7 +210,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # Configuration data for an Ad Exchange buyer account.
|
||||
"kind": "adexchangebuyer#account", # Resource type.
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.
|
||||
|
||||
@@ -83,6 +83,9 @@ h1, h2, h3 {
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of the authenticated user's active creatives.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, buyerCreativeId, adgroupId)</code>
|
||||
@@ -96,7 +99,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
@@ -139,7 +142,7 @@ Args:
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
@@ -177,7 +180,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
@@ -223,9 +226,10 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
|
||||
"nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
||||
"items": [ # A list of creatives.
|
||||
{
|
||||
{ # A creative and its classification data.
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
@@ -263,4 +267,18 @@ Returns:
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
||||
<pre>Retrieves the next page of results.
|
||||
|
||||
Args:
|
||||
previous_request: The request for the previous page. (required)
|
||||
previous_response: The response from the request for the previous page. (required)
|
||||
|
||||
Returns:
|
||||
A request object that you can call 'execute()' on to request the next
|
||||
page. Returns None if there are no more items in the collection.
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -91,7 +91,7 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # The configuration data for an Ad Exchange direct deal.
|
||||
"advertiser": "A String", # The name of the advertiser this deal is for.
|
||||
"kind": "adexchangebuyer#directDeal", # Resource type.
|
||||
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
|
||||
@@ -113,10 +113,10 @@ Args:
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
{ # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
|
||||
"kind": "adexchangebuyer#directDealsList", # Resource type.
|
||||
"directDeals": [ # A list of direct deals relevant for your account.
|
||||
{
|
||||
{ # The configuration data for an Ad Exchange direct deal.
|
||||
"advertiser": "A String", # The name of the advertiser this deal is for.
|
||||
"kind": "adexchangebuyer#directDeal", # Resource type.
|
||||
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
|
||||
|
||||
@@ -104,6 +104,7 @@ Returns:
|
||||
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this profile belongs.
|
||||
"updated": "A String", # Time this profile was last modified.
|
||||
"siteSearchQueryParameters": "A String", # The site search query parameters for this profile.
|
||||
"websiteUrl": "A String", # Website URL for this profile.
|
||||
"currency": "A String", # The currency type associated with this profile.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
|
||||
"childLink": { # Child link for this profile. Points to the list of goals for this profile.
|
||||
|
||||
@@ -152,6 +152,7 @@ Returns:
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
@@ -329,6 +330,7 @@ Args:
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
@@ -454,6 +456,7 @@ Returns:
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
@@ -603,6 +606,7 @@ Returns:
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"allowQuotedNewlines": True or False, # [Experimental] Whether to allow quoted newlines in the source CSV data.
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
@@ -708,13 +712,14 @@ Args:
|
||||
|
||||
{
|
||||
"timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error.
|
||||
"query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.
|
||||
"kind": "bigquery#queryRequest", # The resource type of the request.
|
||||
"maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.
|
||||
"dryRun": True or False, # [Optional] If set, don't actually run the query. A valid query will return an empty response, while an invalid query will return the same error it would if it wasn't a dry run.
|
||||
"defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.
|
||||
"query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -112,6 +112,7 @@ Returns:
|
||||
"data": { # JSON encoded data for this annotation data.
|
||||
"geo": {
|
||||
"countryCode": "A String", # The country code of the location.
|
||||
"title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search.
|
||||
"zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels
|
||||
"longitude": 3.14, # The longitude of the location.
|
||||
"mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
|
||||
@@ -124,7 +125,6 @@ Returns:
|
||||
},
|
||||
],
|
||||
],
|
||||
"resolution": "A String", # The resolution of the location. Ex: POI_LEVEL
|
||||
"viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.
|
||||
"lo": {
|
||||
"latitude": 3.14,
|
||||
@@ -184,6 +184,7 @@ Returns:
|
||||
"data": { # JSON encoded data for this annotation data.
|
||||
"geo": {
|
||||
"countryCode": "A String", # The country code of the location.
|
||||
"title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search.
|
||||
"zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels
|
||||
"longitude": 3.14, # The longitude of the location.
|
||||
"mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
|
||||
@@ -196,7 +197,6 @@ Returns:
|
||||
},
|
||||
],
|
||||
],
|
||||
"resolution": "A String", # The resolution of the location. Ex: POI_LEVEL
|
||||
"viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.
|
||||
"lo": {
|
||||
"latitude": 3.14,
|
||||
|
||||
106
docs/dyn/coordinate_v1.customFieldDef.html
Normal file
@@ -0,0 +1,106 @@
|
||||
<html><body>
|
||||
<style>
|
||||
|
||||
body, h1, h2, h3, div, span, p, pre, a {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
border: 0;
|
||||
font-weight: inherit;
|
||||
font-style: inherit;
|
||||
font-size: 100%;
|
||||
font-family: inherit;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
body {
|
||||
font-size: 13px;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 26px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 24px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 20px;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
pre, code {
|
||||
line-height: 1.5;
|
||||
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
||||
}
|
||||
|
||||
pre {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
h1, h2, h3, p {
|
||||
font-family: Arial, sans serif;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
border-bottom: solid #CCC 1px;
|
||||
}
|
||||
|
||||
.toc_element {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
.firstline {
|
||||
margin-left: 2 em;
|
||||
}
|
||||
|
||||
.method {
|
||||
margin-top: 1em;
|
||||
border: solid 1px #CCC;
|
||||
padding: 1em;
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
.details {
|
||||
font-weight: bold;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
<h1><a href="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.customFieldDef.html">customFieldDef</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(teamId)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of custom field definitions for a team.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(teamId)</code>
|
||||
<pre>Retrieves a list of custom field definitions for a team.
|
||||
|
||||
Args:
|
||||
teamId: string, Team ID (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Collection of custom field definitions for a team.
|
||||
"items": [ # Collection of custom field definitions in a team.
|
||||
{ # Custom field definition.
|
||||
"kind": "coordinate#customFieldDef", # Identifies this object as a custom field definition.
|
||||
"name": "A String", # Custom field name.
|
||||
"enabled": True or False, # Whether the field is enabled.
|
||||
"requiredForCheckout": True or False, # Whether the field is required for checkout.
|
||||
"type": "A String", # Custom field type.
|
||||
"id": "A String", # Custom field id.
|
||||
},
|
||||
],
|
||||
"kind": "coordinate#customFieldDefList", # Identifies this object as a collection of custom field definitions in a team.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -74,6 +74,11 @@ h1, h2, h3 {
|
||||
|
||||
<h1><a href="coordinate_v1.html">Google Maps Coordinate API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="coordinate_v1.customFieldDef.html">customFieldDef()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customFieldDef Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="coordinate_v1.jobs.html">jobs()</a></code>
|
||||
</p>
|
||||
|
||||
@@ -78,7 +78,7 @@ h1, h2, h3 {
|
||||
<code><a href="#get">get(teamId, jobId)</a></code></p>
|
||||
<p class="firstline">Retrieves a job, including all the changes made to the job.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(teamId, address, lat, lng, title, body, note=None, customerName=None, assignee=None, customerPhoneNumber=None)</a></code></p>
|
||||
<code><a href="#insert">insert(teamId, address, lat, lng, title, body, customerName=None, assignee=None, customerPhoneNumber=None, note=None, customField=None)</a></code></p>
|
||||
<p class="firstline">Inserts a new job. Only the state field of the job should be set.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(teamId, pageToken=None, minModifiedTimestampMs=None, maxResults=None)</a></code></p>
|
||||
@@ -87,10 +87,10 @@ h1, h2, h3 {
|
||||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#patch">patch(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None)</a></code></p>
|
||||
<code><a href="#patch">patch(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</a></code></p>
|
||||
<p class="firstline">Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None)</a></code></p>
|
||||
<code><a href="#update">update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</a></code></p>
|
||||
<p class="firstline">Updates a job. Fields that are set in the job state will be updated.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
@@ -128,6 +128,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -150,12 +160,22 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(teamId, address, lat, lng, title, body, note=None, customerName=None, assignee=None, customerPhoneNumber=None)</code>
|
||||
<code class="details" id="insert">insert(teamId, address, lat, lng, title, body, customerName=None, assignee=None, customerPhoneNumber=None, note=None, customField=None)</code>
|
||||
<pre>Inserts a new job. Only the state field of the job should be set.
|
||||
|
||||
Args:
|
||||
@@ -191,6 +211,16 @@ Args:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -213,13 +243,24 @@ Args:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
note: string, Job note as newline (Unix) separated string
|
||||
customerName: string, Customer name
|
||||
assignee: string, Assignee email address
|
||||
customerPhoneNumber: string, Customer phone number
|
||||
note: string, Job note as newline (Unix) separated string
|
||||
customField: string, Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' (repeated)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
@@ -248,6 +289,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -270,6 +321,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
@@ -314,6 +375,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -336,6 +407,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -358,7 +439,7 @@ Returns:
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="patch">patch(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None)</code>
|
||||
<code class="details" id="patch">patch(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</code>
|
||||
<pre>Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
@@ -391,6 +472,16 @@ Args:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -413,6 +504,16 @@ Args:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
@@ -431,6 +532,7 @@ Args:
|
||||
OBSOLETE - Obsolete
|
||||
address: string, Job address as newline (Unix) separated string
|
||||
lat: number, The latitude coordinate of this job's location.
|
||||
customField: string, Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' (repeated)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
@@ -459,6 +561,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -481,12 +593,22 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None)</code>
|
||||
<code class="details" id="update">update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)</code>
|
||||
<pre>Updates a job. Fields that are set in the job state will be updated.
|
||||
|
||||
Args:
|
||||
@@ -519,6 +641,16 @@ Args:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -541,6 +673,16 @@ Args:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
@@ -559,6 +701,7 @@ Args:
|
||||
OBSOLETE - Obsolete
|
||||
address: string, Job address as newline (Unix) separated string
|
||||
lat: number, The latitude coordinate of this job's location.
|
||||
customField: string, Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' (repeated)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
@@ -587,6 +730,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -609,6 +762,16 @@ Returns:
|
||||
"lng": 3.14, # Longitude.
|
||||
},
|
||||
"progress": "A String", # Job progress.
|
||||
"customFields": { # Collection of custom fields. # Custom fields.
|
||||
"kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
|
||||
"customField": [ # Collection of custom fields.
|
||||
{ # Custom field.
|
||||
"kind": "coordinate#customField", # Identifies this object as a custom field.
|
||||
"customFieldId": "A String", # Custom field id.
|
||||
"value": "A String", # Custom field value.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -123,7 +123,7 @@ Returns:
|
||||
"A String",
|
||||
],
|
||||
"id": "A String", # The ID of the app.
|
||||
"objectType": "A String", # The name of the type of object this app creates.
|
||||
"objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
@@ -170,7 +170,7 @@ Returns:
|
||||
"A String",
|
||||
],
|
||||
"id": "A String", # The ID of the app.
|
||||
"objectType": "A String", # The name of the type of object this app creates.
|
||||
"objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
|
||||
},
|
||||
],
|
||||
"kind": "drive#appList", # This is always drive#appList.
|
||||
|
||||
@@ -79,6 +79,11 @@ h1, h2, h3 {
|
||||
</p>
|
||||
<p class="firstline">Returns the column Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="fusiontables_v1.import_.html">import_()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the import_ Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="fusiontables_v1.query.html">query()</a></code>
|
||||
</p>
|
||||
|
||||
100
docs/dyn/fusiontables_v1.import_.html
Normal file
@@ -0,0 +1,100 @@
|
||||
<html><body>
|
||||
<style>
|
||||
|
||||
body, h1, h2, h3, div, span, p, pre, a {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
border: 0;
|
||||
font-weight: inherit;
|
||||
font-style: inherit;
|
||||
font-size: 100%;
|
||||
font-family: inherit;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
body {
|
||||
font-size: 13px;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 26px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 24px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 20px;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
pre, code {
|
||||
line-height: 1.5;
|
||||
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
||||
}
|
||||
|
||||
pre {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
h1, h2, h3, p {
|
||||
font-family: Arial, sans serif;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
border-bottom: solid #CCC 1px;
|
||||
}
|
||||
|
||||
.toc_element {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
.firstline {
|
||||
margin-left: 2 em;
|
||||
}
|
||||
|
||||
.method {
|
||||
margin-top: 1em;
|
||||
border: solid 1px #CCC;
|
||||
padding: 1em;
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
.details {
|
||||
font-weight: bold;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
<h1><a href="fusiontables_v1.html">Fusion Tables API</a> . <a href="fusiontables_v1.import_.html">import_</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(tableId, media_body=None, encoding=None, delimiter=None)</a></code></p>
|
||||
<p class="firstline">Import more rows into a table.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(tableId, media_body=None, encoding=None, delimiter=None)</code>
|
||||
<pre>Import more rows into a table.
|
||||
|
||||
Args:
|
||||
tableId: string, The table into which new rows are being imported. (required)
|
||||
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
|
||||
encoding: string, The encoding of the content. Default is UTF-8.
|
||||
delimiter: string, The delimiter used to separate cell values. Default is ','.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Represents an import request.
|
||||
"numRowsReceived": "A String", # The number of rows received from the import request.
|
||||
"kind": "fusiontables#import", # Type name: a template for an import request.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -76,17 +76,17 @@ h1, h2, h3 {
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#sql">sql(sql, hdrs=None, typed=None)</a></code></p>
|
||||
<p class="firstline">Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE statement.</p>
|
||||
<p class="firstline">Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#sqlGet">sqlGet(sql, hdrs=None, typed=None)</a></code></p>
|
||||
<p class="firstline">Executes an SQL SELECT/SHOW/DESCRIBE statement.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="sql">sql(sql, hdrs=None, typed=None)</code>
|
||||
<pre>Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE statement.
|
||||
<pre>Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.
|
||||
|
||||
Args:
|
||||
sql: string, An SQL SELECT/SHOW/DESCRIBE/INSERT/UPDATE/DELETE statement. (required)
|
||||
sql: string, An SQL SELECT/SHOW/DESCRIBE/INSERT/UPDATE/DELETE/CREATE statement. (required)
|
||||
hdrs: boolean, Should column names be included (in the first row)?. Default is true.
|
||||
typed: boolean, Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true.
|
||||
|
||||
|
||||
82
docs/dyn/licensing_v1.html
Normal file
@@ -0,0 +1,82 @@
|
||||
<html><body>
|
||||
<style>
|
||||
|
||||
body, h1, h2, h3, div, span, p, pre, a {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
border: 0;
|
||||
font-weight: inherit;
|
||||
font-style: inherit;
|
||||
font-size: 100%;
|
||||
font-family: inherit;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
body {
|
||||
font-size: 13px;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 26px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 24px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 20px;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
pre, code {
|
||||
line-height: 1.5;
|
||||
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
||||
}
|
||||
|
||||
pre {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
h1, h2, h3, p {
|
||||
font-family: Arial, sans serif;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
border-bottom: solid #CCC 1px;
|
||||
}
|
||||
|
||||
.toc_element {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
.firstline {
|
||||
margin-left: 2 em;
|
||||
}
|
||||
|
||||
.method {
|
||||
margin-top: 1em;
|
||||
border: solid 1px #CCC;
|
||||
padding: 1em;
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
.details {
|
||||
font-weight: bold;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
<h1><a href="licensing_v1.html">Enterprise License Manager API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="licensing_v1.licenseAssignments.html">licenseAssignments()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the licenseAssignments Resource.</p>
|
||||
|
||||
</body></html>
|
||||
323
docs/dyn/licensing_v1.licenseAssignments.html
Normal file
@@ -0,0 +1,323 @@
|
||||
<html><body>
|
||||
<style>
|
||||
|
||||
body, h1, h2, h3, div, span, p, pre, a {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
border: 0;
|
||||
font-weight: inherit;
|
||||
font-style: inherit;
|
||||
font-size: 100%;
|
||||
font-family: inherit;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
body {
|
||||
font-size: 13px;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 26px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 24px;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 20px;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
pre, code {
|
||||
line-height: 1.5;
|
||||
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
||||
}
|
||||
|
||||
pre {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
h1, h2, h3, p {
|
||||
font-family: Arial, sans serif;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
border-bottom: solid #CCC 1px;
|
||||
}
|
||||
|
||||
.toc_element {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
.firstline {
|
||||
margin-left: 2 em;
|
||||
}
|
||||
|
||||
.method {
|
||||
margin-top: 1em;
|
||||
border: solid 1px #CCC;
|
||||
padding: 1em;
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
.details {
|
||||
font-weight: bold;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
<h1><a href="licensing_v1.html">Enterprise License Manager API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(productId, skuId, userId)</a></code></p>
|
||||
<p class="firstline">Revoke License.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(productId, skuId, userId)</a></code></p>
|
||||
<p class="firstline">Get license assignment of a particular product and sku for a user</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(productId, skuId, body)</a></code></p>
|
||||
<p class="firstline">Assign License.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List license assignments for given product of the customer.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">List license assignments for given product and sku of the customer.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listForProduct_next">listForProduct_next(previous_request, previous_response)</a></code></p>
|
||||
<p class="firstline">Retrieves the next page of results.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#patch">patch(productId, skuId, userId, body)</a></code></p>
|
||||
<p class="firstline">Assign License. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(productId, skuId, userId, body)</a></code></p>
|
||||
<p class="firstline">Assign License.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(productId, skuId, userId)</code>
|
||||
<pre>Revoke License.
|
||||
|
||||
Args:
|
||||
productId: string, Name for product (required)
|
||||
skuId: string, Name for sku (required)
|
||||
userId: string, email id or unique Id of the user (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(productId, skuId, userId)</code>
|
||||
<pre>Get license assignment of a particular product and sku for a user
|
||||
|
||||
Args:
|
||||
productId: string, Name for product (required)
|
||||
skuId: string, Name for sku (required)
|
||||
userId: string, email id or unique Id of the user (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(productId, skuId, body)</code>
|
||||
<pre>Assign License.
|
||||
|
||||
Args:
|
||||
productId: string, Name for product (required)
|
||||
skuId: string, Name for sku (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Template for LicenseAssignment Insert request
|
||||
"userId": "A String", # Email id of the user
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List license assignments for given product of the customer.
|
||||
|
||||
Args:
|
||||
productId: string, Name for product (required)
|
||||
customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
|
||||
pageToken: string, Token to fetch the next page.Optional. By default server will return first page
|
||||
maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # LicesnseAssignment List for a given product/sku for a customer.
|
||||
"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
||||
"items": [ # The LicenseAssignments in this page of results.
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
},
|
||||
],
|
||||
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</code>
|
||||
<pre>List license assignments for given product and sku of the customer.
|
||||
|
||||
Args:
|
||||
productId: string, Name for product (required)
|
||||
skuId: string, Name for sku (required)
|
||||
customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
|
||||
pageToken: string, Token to fetch the next page.Optional. By default server will return first page
|
||||
maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # LicesnseAssignment List for a given product/sku for a customer.
|
||||
"nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
||||
"items": [ # The LicenseAssignments in this page of results.
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
},
|
||||
],
|
||||
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
|
||||
"etag": "A String", # ETag of the resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</code>
|
||||
<pre>Retrieves the next page of results.
|
||||
|
||||
Args:
|
||||
previous_request: The request for the previous page. (required)
|
||||
previous_response: The response from the request for the previous page. (required)
|
||||
|
||||
Returns:
|
||||
A request object that you can call 'execute()' on to request the next
|
||||
page. Returns None if there are no more items in the collection.
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="listForProduct_next">listForProduct_next(previous_request, previous_response)</code>
|
||||
<pre>Retrieves the next page of results.
|
||||
|
||||
Args:
|
||||
previous_request: The request for the previous page. (required)
|
||||
previous_response: The response from the request for the previous page. (required)
|
||||
|
||||
Returns:
|
||||
A request object that you can call 'execute()' on to request the next
|
||||
page. Returns None if there are no more items in the collection.
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="patch">patch(productId, skuId, userId, body)</code>
|
||||
<pre>Assign License. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
productId: string, Name for product (required)
|
||||
skuId: string, Name for sku for which license would be revoked (required)
|
||||
userId: string, email id or unique Id of the user (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(productId, skuId, userId, body)</code>
|
||||
<pre>Assign License.
|
||||
|
||||
Args:
|
||||
productId: string, Name for product (required)
|
||||
skuId: string, Name for sku for which license would be revoked (required)
|
||||
userId: string, email id or unique Id of the user (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # Template for LiscenseAssignment Resource
|
||||
"skuId": "A String", # Name of the sku of the product.
|
||||
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
|
||||
"userId": "A String", # Email id of the user.
|
||||
"etags": "A String", # ETag of the resource.
|
||||
"selfLink": "A String", # Link to this page.
|
||||
"productId": "A String", # Name of the product.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -321,11 +321,13 @@ Returns:
|
||||
},
|
||||
],
|
||||
"debug": { # Google internal.
|
||||
"recommendedItemsRequest": "A String", # Google internal.
|
||||
"searchRequest": "A String", # Google internal.
|
||||
"rdcResponse": "A String", # Google internal.
|
||||
"facetsRequest": "A String", # Google internal.
|
||||
"searchResponse": "A String", # Google internal.
|
||||
"elapsedMillis": "A String", # Google internal.
|
||||
"recommendedItemsResponse": "A String", # Google internal.
|
||||
"facetsResponse": "A String", # Google internal.
|
||||
"backendTimes": [ # Google internal
|
||||
{
|
||||
@@ -748,11 +750,13 @@ Returns:
|
||||
},
|
||||
],
|
||||
"debug": { # Google internal.
|
||||
"recommendedItemsRequest": "A String", # Google internal.
|
||||
"searchRequest": "A String", # Google internal.
|
||||
"rdcResponse": "A String", # Google internal.
|
||||
"facetsRequest": "A String", # Google internal.
|
||||
"searchResponse": "A String", # Google internal.
|
||||
"elapsedMillis": "A String", # Google internal.
|
||||
"recommendedItemsResponse": "A String", # Google internal.
|
||||
"facetsResponse": "A String", # Google internal.
|
||||
"backendTimes": [ # Google internal
|
||||
{
|
||||
@@ -918,11 +922,13 @@ Returns:
|
||||
},
|
||||
],
|
||||
"debug": { # Google internal.
|
||||
"recommendedItemsRequest": "A String", # Google internal.
|
||||
"searchRequest": "A String", # Google internal.
|
||||
"rdcResponse": "A String", # Google internal.
|
||||
"facetsRequest": "A String", # Google internal.
|
||||
"searchResponse": "A String", # Google internal.
|
||||
"elapsedMillis": "A String", # Google internal.
|
||||
"recommendedItemsResponse": "A String", # Google internal.
|
||||
"facetsResponse": "A String", # Google internal.
|
||||
"backendTimes": [ # Google internal
|
||||
{
|
||||
|
||||
@@ -127,6 +127,7 @@ Returns:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
@@ -202,6 +203,7 @@ Args:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
@@ -259,6 +261,7 @@ Returns:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
@@ -328,6 +331,7 @@ Returns:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
@@ -406,6 +410,7 @@ Args:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
@@ -461,6 +466,7 @@ Returns:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
@@ -519,6 +525,7 @@ Args:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
@@ -574,6 +581,7 @@ Returns:
|
||||
{ # An object.
|
||||
"kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
|
||||
"name": "A String", # The name of this object. Required if not specified by URL parameter.
|
||||
"contentLanguage": "A String", # Content-Language of the object data.
|
||||
"media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
|
||||
"contentType": "A String", # Content-Type of the object data.
|
||||
"timeCreated": "A String", # Creation time of the data in RFC 3339 format.
|
||||
|
||||
@@ -75,16 +75,17 @@ h1, h2, h3 {
|
||||
<h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.channels.html">channels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(part, mine=None, id=None)</a></code></p>
|
||||
<code><a href="#list">list(part, mine=None, contentOwnerId=None, id=None)</a></code></p>
|
||||
<p class="firstline">Browse the YouTube channel collection. Either the 'id' or 'mine' parameter must be set.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(part, mine=None, id=None)</code>
|
||||
<code class="details" id="list">list(part, mine=None, contentOwnerId=None, id=None)</code>
|
||||
<pre>Browse the YouTube channel collection. Either the 'id' or 'mine' parameter must be set.
|
||||
|
||||
Args:
|
||||
part: string, Parts of the channel resource to be returned. (required)
|
||||
mine: string, Flag indicating only return the channel ids of the authenticated user.
|
||||
contentOwnerId: string, The authenticated user acts on behalf of this content owner.
|
||||
id: string, YouTube IDs of the channels to be returned.
|
||||
|
||||
Returns:
|
||||
@@ -92,7 +93,7 @@ Returns:
|
||||
|
||||
{ # JSON template for a ChannelService.List() response.
|
||||
"channels": { # Map of channels matching the request criteria, keyed by channel id.
|
||||
"a_key": { # JSON template for a YouTube Channel.
|
||||
"a_key": { # JSON template for a YouTube Channel. # An entry in the "channels" map: the key is the channel id, the value is the channel resource.
|
||||
"kind": "youtube#channel", # The type of this API resource.
|
||||
"statistics": { # JSON template for the statistics part of a channel. # Statistics about the channel: number of subscribers, views, and comments.
|
||||
"commentCount": "A String", # Number of comments for this channel.
|
||||
|
||||
@@ -75,17 +75,18 @@ h1, h2, h3 {
|
||||
<h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.playlistitems.html">playlistitems</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(part, playlistId=None, maxResults=None, startIndex=None, id=None)</a></code></p>
|
||||
<code><a href="#list">list(part, playlistId=None, maxResults=None, contentOwnerId=None, startIndex=None, id=None)</a></code></p>
|
||||
<p class="firstline">Browse the YouTube playlist collection.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(part, playlistId=None, maxResults=None, startIndex=None, id=None)</code>
|
||||
<code class="details" id="list">list(part, playlistId=None, maxResults=None, contentOwnerId=None, startIndex=None, id=None)</code>
|
||||
<pre>Browse the YouTube playlist collection.
|
||||
|
||||
Args:
|
||||
part: string, Parts of the playlist resource to be returned. (required)
|
||||
playlistId: string, Retrieves playlist items from the given playlist id.
|
||||
maxResults: integer, Maximum number of results to return
|
||||
contentOwnerId: string, The authenticated user acts on behalf of this content owner.
|
||||
startIndex: integer, Index of the first element to return (starts at 0)
|
||||
id: string, YouTube IDs of the playlists to be returned.
|
||||
|
||||
@@ -94,7 +95,7 @@ Returns:
|
||||
|
||||
{ # JSON template for a PlaylistItemService.List() response.
|
||||
"playlistItems": { # Map of playlist items matching the request criteria, keyed by id.
|
||||
"a_key": { # JSON template for a YouTube Playlist item.
|
||||
"a_key": { # JSON template for a YouTube Playlist item. # An entry in the "playlistItems" map: the key is the video id, the value is the playlist item resource.
|
||||
"snippet": { # JSON template for the snippet part of a playlist item. # Basic details about the playlist item: title, description, thumbnails.
|
||||
"playlistId": "A String", # The playlist the item is part of.
|
||||
"description": "A String", # Description of the playlist item.
|
||||
@@ -109,6 +110,11 @@ Returns:
|
||||
"publishedAt": "A String", # The date and time the playlist item was created.
|
||||
"position": 42, # The position of the item within the playlist.
|
||||
},
|
||||
"contentDetails": { # JSON template for the content details part of a playlist item. # Content details about the playlist item: start and end clipping time.
|
||||
"startAt": "A String", # The time video playback begins.
|
||||
"endAt": "A String", # The time video playback ends.
|
||||
"videoId": "A String", # ID of the video.
|
||||
},
|
||||
"kind": "youtube#playlistItem", # The type of this API resource.
|
||||
"etag": "A String", # The eTag of the playlist item.
|
||||
"id": "A String", # The unique id of the playlist item.
|
||||
|
||||
@@ -75,16 +75,17 @@ h1, h2, h3 {
|
||||
<h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.playlists.html">playlists</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(id, part)</a></code></p>
|
||||
<code><a href="#list">list(id, part, contentOwnerId=None)</a></code></p>
|
||||
<p class="firstline">Browse the YouTube playlist collection.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(id, part)</code>
|
||||
<code class="details" id="list">list(id, part, contentOwnerId=None)</code>
|
||||
<pre>Browse the YouTube playlist collection.
|
||||
|
||||
Args:
|
||||
id: string, YouTube IDs of the playlists to be returned. (required)
|
||||
part: string, Parts of the playlist resource to be returned. (required)
|
||||
contentOwnerId: string, The authenticated user acts on behalf of this content owner.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
@@ -93,7 +94,7 @@ Returns:
|
||||
"kind": "youtube#playlistListResponse", # The type of this API response.
|
||||
"etag": "A String", # The eTag of the response.
|
||||
"playlists": { # Map of playlists matching the request criteria, keyed by id.
|
||||
"a_key": { # JSON template for a YouTube Playlist.
|
||||
"a_key": { # JSON template for a YouTube Playlist. # An entry in the "playlists" map: the key is the playlist id, the value is the playlist resource.
|
||||
"snippet": { # JSON template for the snippet part of a playlist. # Basic details about the playlist: title, description, thumbnails.
|
||||
"title": "A String", # Title of the playlist.
|
||||
"channelId": "A String", # Author of the playlist.
|
||||
|
||||
@@ -75,16 +75,17 @@ h1, h2, h3 {
|
||||
<h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.videos.html">videos</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(id, part)</a></code></p>
|
||||
<code><a href="#list">list(id, part, contentOwnerId=None)</a></code></p>
|
||||
<p class="firstline">Browse the YouTube video collection.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(id, part)</code>
|
||||
<code class="details" id="list">list(id, part, contentOwnerId=None)</code>
|
||||
<pre>Browse the YouTube video collection.
|
||||
|
||||
Args:
|
||||
id: string, YouTube IDs of the videos to be returned. (required)
|
||||
part: string, Parts of the video resource to be returned. (required)
|
||||
contentOwnerId: string, The authenticated user acts on behalf of this content owner.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
@@ -93,7 +94,7 @@ Returns:
|
||||
"kind": "youtube#videoListResponse", # The type of this API response.
|
||||
"etag": "A String", # The eTag of the response.
|
||||
"videos": { # Map of videos matching the request criteria, keyed by video id.
|
||||
"a_key": { # JSON template for a YouTube Video.
|
||||
"a_key": { # JSON template for a YouTube Video. # An entry in the "videos" map: the key is the video id, the value is the video resource.
|
||||
"status": { # JSON template for the status part of a video. # Status of the video upload, privacy status.
|
||||
"privacyStatus": "A String", # Privacy of the video.
|
||||
"uploadStatus": "A String", # Status of the video upload.
|
||||
|
||||
@@ -15,7 +15,6 @@ apiclient.discovery._add_query_parameter apiclient.discovery-module.html#_add_qu
|
||||
apiclient.discovery.__package__ apiclient.discovery-module.html#__package__
|
||||
apiclient.discovery.build apiclient.discovery-module.html#build
|
||||
apiclient.discovery.key2param apiclient.discovery-module.html#key2param
|
||||
apiclient.discovery.build_from_document apiclient.discovery-module.html#build_from_document
|
||||
apiclient.discovery._media_size_to_long apiclient.discovery-module.html#_media_size_to_long
|
||||
apiclient.discovery.RESERVED_WORDS apiclient.discovery-module.html#RESERVED_WORDS
|
||||
apiclient.discovery.logger apiclient.discovery-module.html#logger
|
||||
@@ -33,6 +32,7 @@ apiclient.http.set_user_agent apiclient.http-module.html#set_user_agent
|
||||
apiclient.http.tunnel_patch apiclient.http-module.html#tunnel_patch
|
||||
apiclient.http.DEFAULT_CHUNK_SIZE apiclient.http-module.html#DEFAULT_CHUNK_SIZE
|
||||
apiclient.http.__package__ apiclient.http-module.html#__package__
|
||||
apiclient.http.MAX_URI_LENGTH apiclient.http-module.html#MAX_URI_LENGTH
|
||||
apiclient.mimeparse apiclient.mimeparse-module.html
|
||||
apiclient.mimeparse.__credits__ apiclient.mimeparse-module.html#__credits__
|
||||
apiclient.mimeparse.fitness_and_quality_parsed apiclient.mimeparse-module.html#fitness_and_quality_parsed
|
||||
@@ -56,20 +56,19 @@ oauth2client.__package__ oauth2client-module.html#__package__
|
||||
oauth2client.anyjson oauth2client.anyjson-module.html
|
||||
oauth2client.anyjson.__package__ oauth2client.anyjson-module.html#__package__
|
||||
oauth2client.appengine oauth2client.appengine-module.html
|
||||
oauth2client.appengine._build_state_value oauth2client.appengine-module.html#_build_state_value
|
||||
oauth2client.appengine.XSRF_MEMCACHE_ID oauth2client.appengine-module.html#XSRF_MEMCACHE_ID
|
||||
oauth2client.appengine._parse_state_value oauth2client.appengine-module.html#_parse_state_value
|
||||
oauth2client.appengine.OAUTH2CLIENT_NAMESPACE oauth2client.appengine-module.html#OAUTH2CLIENT_NAMESPACE
|
||||
oauth2client.appengine.__package__ oauth2client.appengine-module.html#__package__
|
||||
oauth2client.appengine.application oauth2client.appengine-module.html#application
|
||||
oauth2client.appengine.logger oauth2client.appengine-module.html#logger
|
||||
oauth2client.appengine.main oauth2client.appengine-module.html#main
|
||||
oauth2client.appengine.oauth2decorator_from_clientsecrets oauth2client.appengine-module.html#oauth2decorator_from_clientsecrets
|
||||
oauth2client.appengine._generate_new_xsrf_secret_key oauth2client.appengine-module.html#_generate_new_xsrf_secret_key
|
||||
oauth2client.appengine.xsrf_secret_key oauth2client.appengine-module.html#xsrf_secret_key
|
||||
oauth2client.client oauth2client.client-module.html
|
||||
oauth2client.client._extract_id_token oauth2client.client-module.html#_extract_id_token
|
||||
oauth2client.client._cached_http oauth2client.client-module.html#_cached_http
|
||||
oauth2client.client.ID_TOKEN_VERIFICATON_CERTS oauth2client.client-module.html#ID_TOKEN_VERIFICATON_CERTS
|
||||
oauth2client.client.credentials_from_clientsecrets_and_code oauth2client.client-module.html#credentials_from_clientsecrets_and_code
|
||||
oauth2client.client.__package__ oauth2client.client-module.html#__package__
|
||||
oauth2client.client.flow_from_clientsecrets oauth2client.client-module.html#flow_from_clientsecrets
|
||||
oauth2client.client.credentials_from_code oauth2client.client-module.html#credentials_from_code
|
||||
oauth2client.client._abstract oauth2client.client-module.html#_abstract
|
||||
oauth2client.client.logger oauth2client.client-module.html#logger
|
||||
oauth2client.client.OOB_CALLBACK_URN oauth2client.client-module.html#OOB_CALLBACK_URN
|
||||
@@ -78,7 +77,6 @@ oauth2client.client.HAS_OPENSSL oauth2client.client-module.html#HAS_OPENSSL
|
||||
oauth2client.client.EXPIRY_FORMAT oauth2client.client-module.html#EXPIRY_FORMAT
|
||||
oauth2client.client._urlsafe_b64decode oauth2client.client-module.html#_urlsafe_b64decode
|
||||
oauth2client.client.verify_signed_jwt_with_certs oauth2client.crypt-module.html#verify_signed_jwt_with_certs
|
||||
oauth2client.client.verify_id_token oauth2client.client-module.html#verify_id_token
|
||||
oauth2client.client.make_signed_jwt oauth2client.crypt-module.html#make_signed_jwt
|
||||
oauth2client.clientsecrets oauth2client.clientsecrets-module.html
|
||||
oauth2client.clientsecrets.load oauth2client.clientsecrets-module.html#load
|
||||
@@ -105,6 +103,10 @@ oauth2client.django_orm oauth2client.django_orm-module.html
|
||||
oauth2client.django_orm.__package__ oauth2client.django_orm-module.html#__package__
|
||||
oauth2client.file oauth2client.file-module.html
|
||||
oauth2client.file.__package__ oauth2client.file-module.html#__package__
|
||||
oauth2client.gce oauth2client.gce-module.html
|
||||
oauth2client.gce.__package__ oauth2client.gce-module.html#__package__
|
||||
oauth2client.gce.META oauth2client.gce-module.html#META
|
||||
oauth2client.gce.logger oauth2client.gce-module.html#logger
|
||||
oauth2client.keyring_storage oauth2client.keyring_storage-module.html
|
||||
oauth2client.keyring_storage.__package__ oauth2client.keyring_storage-module.html#__package__
|
||||
oauth2client.locked_file oauth2client.locked_file-module.html
|
||||
@@ -113,7 +115,6 @@ oauth2client.locked_file.logger oauth2client.locked_file-module.html#logger
|
||||
oauth2client.locked_file.__package__ oauth2client.locked_file-module.html#__package__
|
||||
oauth2client.multistore_file oauth2client.multistore_file-module.html
|
||||
oauth2client.multistore_file._multistores_lock oauth2client.multistore_file-module.html#_multistores_lock
|
||||
oauth2client.multistore_file.get_credential_storage oauth2client.multistore_file-module.html#get_credential_storage
|
||||
oauth2client.multistore_file._multistores oauth2client.multistore_file-module.html#_multistores
|
||||
oauth2client.multistore_file.logger oauth2client.multistore_file-module.html#logger
|
||||
oauth2client.multistore_file.__package__ oauth2client.multistore_file-module.html#__package__
|
||||
@@ -126,6 +127,10 @@ oauth2client.util.__package__ oauth2client.util-module.html#__package__
|
||||
oauth2client.util.positional oauth2client.util-module.html#positional
|
||||
oauth2client.util.FLAGS oauth2client.util-module.html#FLAGS
|
||||
oauth2client.util.logger oauth2client.util-module.html#logger
|
||||
oauth2client.xsrfutil oauth2client.xsrfutil-module.html
|
||||
oauth2client.xsrfutil.DEFAULT_TIMEOUT_SECS oauth2client.xsrfutil-module.html#DEFAULT_TIMEOUT_SECS
|
||||
oauth2client.xsrfutil.__package__ oauth2client.xsrfutil-module.html#__package__
|
||||
oauth2client.xsrfutil.DELIMITER oauth2client.xsrfutil-module.html#DELIMITER
|
||||
apiclient.errors.BatchError apiclient.errors.BatchError-class.html
|
||||
apiclient.errors.BatchError.__str__ apiclient.errors.BatchError-class.html#__str__
|
||||
apiclient.errors.BatchError.__repr__ apiclient.errors.BatchError-class.html#__repr__
|
||||
@@ -137,6 +142,7 @@ apiclient.errors.HttpError.__str__ apiclient.errors.HttpError-class.html#__str__
|
||||
apiclient.errors.HttpError.__repr__ apiclient.errors.HttpError-class.html#__repr__
|
||||
apiclient.errors.HttpError.__init__ apiclient.errors.HttpError-class.html#__init__
|
||||
apiclient.errors.HttpError._get_reason apiclient.errors.HttpError-class.html#_get_reason
|
||||
apiclient.errors.InvalidChunkSizeError apiclient.errors.InvalidChunkSizeError-class.html
|
||||
apiclient.errors.InvalidJsonError apiclient.errors.InvalidJsonError-class.html
|
||||
apiclient.errors.MediaUploadSizeError apiclient.errors.MediaUploadSizeError-class.html
|
||||
apiclient.errors.ResumableUploadError apiclient.errors.ResumableUploadError-class.html
|
||||
@@ -179,30 +185,34 @@ apiclient.http.MediaDownloadProgress.progress apiclient.http.MediaDownloadProgre
|
||||
apiclient.http.MediaDownloadProgress.__init__ apiclient.http.MediaDownloadProgress-class.html#__init__
|
||||
apiclient.http.MediaFileUpload apiclient.http.MediaFileUpload-class.html
|
||||
apiclient.http.MediaFileUpload.from_json apiclient.http.MediaFileUpload-class.html#from_json
|
||||
apiclient.http.MediaIoBaseUpload.stream apiclient.http.MediaIoBaseUpload-class.html#stream
|
||||
apiclient.http.MediaFileUpload.to_json apiclient.http.MediaFileUpload-class.html#to_json
|
||||
apiclient.http.MediaUpload.new_from_json apiclient.http.MediaUpload-class.html#new_from_json
|
||||
apiclient.http.MediaFileUpload.__init__ apiclient.http.MediaFileUpload-class.html#__init__
|
||||
apiclient.http.MediaFileUpload.size apiclient.http.MediaFileUpload-class.html#size
|
||||
apiclient.http.MediaIoBaseUpload.size apiclient.http.MediaIoBaseUpload-class.html#size
|
||||
apiclient.http.MediaUpload._to_json apiclient.http.MediaUpload-class.html#_to_json
|
||||
apiclient.http.MediaFileUpload.chunksize apiclient.http.MediaFileUpload-class.html#chunksize
|
||||
apiclient.http.MediaFileUpload.getbytes apiclient.http.MediaFileUpload-class.html#getbytes
|
||||
apiclient.http.MediaFileUpload.mimetype apiclient.http.MediaFileUpload-class.html#mimetype
|
||||
apiclient.http.MediaFileUpload.resumable apiclient.http.MediaFileUpload-class.html#resumable
|
||||
apiclient.http.MediaIoBaseUpload.chunksize apiclient.http.MediaIoBaseUpload-class.html#chunksize
|
||||
apiclient.http.MediaIoBaseUpload.getbytes apiclient.http.MediaIoBaseUpload-class.html#getbytes
|
||||
apiclient.http.MediaIoBaseUpload.mimetype apiclient.http.MediaIoBaseUpload-class.html#mimetype
|
||||
apiclient.http.MediaIoBaseUpload.resumable apiclient.http.MediaIoBaseUpload-class.html#resumable
|
||||
apiclient.http.MediaIoBaseUpload.has_stream apiclient.http.MediaIoBaseUpload-class.html#has_stream
|
||||
apiclient.http.MediaInMemoryUpload apiclient.http.MediaInMemoryUpload-class.html
|
||||
apiclient.http.MediaInMemoryUpload.from_json apiclient.http.MediaInMemoryUpload-class.html#from_json
|
||||
apiclient.http.MediaInMemoryUpload.to_json apiclient.http.MediaInMemoryUpload-class.html#to_json
|
||||
apiclient.http.MediaIoBaseUpload.stream apiclient.http.MediaIoBaseUpload-class.html#stream
|
||||
apiclient.http.MediaIoBaseUpload.to_json apiclient.http.MediaIoBaseUpload-class.html#to_json
|
||||
apiclient.http.MediaUpload.new_from_json apiclient.http.MediaUpload-class.html#new_from_json
|
||||
apiclient.http.MediaInMemoryUpload.__init__ apiclient.http.MediaInMemoryUpload-class.html#__init__
|
||||
apiclient.http.MediaInMemoryUpload.size apiclient.http.MediaInMemoryUpload-class.html#size
|
||||
apiclient.http.MediaIoBaseUpload.size apiclient.http.MediaIoBaseUpload-class.html#size
|
||||
apiclient.http.MediaUpload._to_json apiclient.http.MediaUpload-class.html#_to_json
|
||||
apiclient.http.MediaInMemoryUpload.chunksize apiclient.http.MediaInMemoryUpload-class.html#chunksize
|
||||
apiclient.http.MediaInMemoryUpload.getbytes apiclient.http.MediaInMemoryUpload-class.html#getbytes
|
||||
apiclient.http.MediaInMemoryUpload.mimetype apiclient.http.MediaInMemoryUpload-class.html#mimetype
|
||||
apiclient.http.MediaInMemoryUpload.resumable apiclient.http.MediaInMemoryUpload-class.html#resumable
|
||||
apiclient.http.MediaIoBaseUpload.chunksize apiclient.http.MediaIoBaseUpload-class.html#chunksize
|
||||
apiclient.http.MediaIoBaseUpload.getbytes apiclient.http.MediaIoBaseUpload-class.html#getbytes
|
||||
apiclient.http.MediaIoBaseUpload.mimetype apiclient.http.MediaIoBaseUpload-class.html#mimetype
|
||||
apiclient.http.MediaIoBaseUpload.resumable apiclient.http.MediaIoBaseUpload-class.html#resumable
|
||||
apiclient.http.MediaIoBaseUpload.has_stream apiclient.http.MediaIoBaseUpload-class.html#has_stream
|
||||
apiclient.http.MediaIoBaseDownload apiclient.http.MediaIoBaseDownload-class.html
|
||||
apiclient.http.MediaIoBaseDownload.next_chunk apiclient.http.MediaIoBaseDownload-class.html#next_chunk
|
||||
apiclient.http.MediaIoBaseDownload.__init__ apiclient.http.MediaIoBaseDownload-class.html#__init__
|
||||
apiclient.http.MediaIoBaseUpload apiclient.http.MediaIoBaseUpload-class.html
|
||||
apiclient.http.MediaIoBaseUpload.stream apiclient.http.MediaIoBaseUpload-class.html#stream
|
||||
apiclient.http.MediaIoBaseUpload.to_json apiclient.http.MediaIoBaseUpload-class.html#to_json
|
||||
apiclient.http.MediaUpload.new_from_json apiclient.http.MediaUpload-class.html#new_from_json
|
||||
apiclient.http.MediaIoBaseUpload.__init__ apiclient.http.MediaIoBaseUpload-class.html#__init__
|
||||
@@ -212,7 +222,9 @@ apiclient.http.MediaIoBaseUpload.chunksize apiclient.http.MediaIoBaseUpload-clas
|
||||
apiclient.http.MediaIoBaseUpload.getbytes apiclient.http.MediaIoBaseUpload-class.html#getbytes
|
||||
apiclient.http.MediaIoBaseUpload.mimetype apiclient.http.MediaIoBaseUpload-class.html#mimetype
|
||||
apiclient.http.MediaIoBaseUpload.resumable apiclient.http.MediaIoBaseUpload-class.html#resumable
|
||||
apiclient.http.MediaIoBaseUpload.has_stream apiclient.http.MediaIoBaseUpload-class.html#has_stream
|
||||
apiclient.http.MediaUpload apiclient.http.MediaUpload-class.html
|
||||
apiclient.http.MediaUpload.stream apiclient.http.MediaUpload-class.html#stream
|
||||
apiclient.http.MediaUpload.to_json apiclient.http.MediaUpload-class.html#to_json
|
||||
apiclient.http.MediaUpload.new_from_json apiclient.http.MediaUpload-class.html#new_from_json
|
||||
apiclient.http.MediaUpload.size apiclient.http.MediaUpload-class.html#size
|
||||
@@ -221,12 +233,16 @@ apiclient.http.MediaUpload.chunksize apiclient.http.MediaUpload-class.html#chunk
|
||||
apiclient.http.MediaUpload.getbytes apiclient.http.MediaUpload-class.html#getbytes
|
||||
apiclient.http.MediaUpload.mimetype apiclient.http.MediaUpload-class.html#mimetype
|
||||
apiclient.http.MediaUpload.resumable apiclient.http.MediaUpload-class.html#resumable
|
||||
apiclient.http.MediaUpload.has_stream apiclient.http.MediaUpload-class.html#has_stream
|
||||
apiclient.http.MediaUploadProgress apiclient.http.MediaUploadProgress-class.html
|
||||
apiclient.http.MediaUploadProgress.progress apiclient.http.MediaUploadProgress-class.html#progress
|
||||
apiclient.http.MediaUploadProgress.__init__ apiclient.http.MediaUploadProgress-class.html#__init__
|
||||
apiclient.http.RequestMockBuilder apiclient.http.RequestMockBuilder-class.html
|
||||
apiclient.http.RequestMockBuilder.__call__ apiclient.http.RequestMockBuilder-class.html#__call__
|
||||
apiclient.http.RequestMockBuilder.__init__ apiclient.http.RequestMockBuilder-class.html#__init__
|
||||
apiclient.http._StreamSlice apiclient.http._StreamSlice-class.html
|
||||
apiclient.http._StreamSlice.read apiclient.http._StreamSlice-class.html#read
|
||||
apiclient.http._StreamSlice.__init__ apiclient.http._StreamSlice-class.html#__init__
|
||||
apiclient.model.BaseModel apiclient.model.BaseModel-class.html
|
||||
apiclient.model.BaseModel.serialize apiclient.model.BaseModel-class.html#serialize
|
||||
apiclient.model.BaseModel.accept apiclient.model.BaseModel-class.html#accept
|
||||
@@ -362,24 +378,36 @@ oauth2client.appengine.FlowProperty.validate oauth2client.appengine.FlowProperty
|
||||
oauth2client.appengine.FlowProperty.empty oauth2client.appengine.FlowProperty-class.html#empty
|
||||
oauth2client.appengine.FlowProperty.get_value_for_datastore oauth2client.appengine.FlowProperty-class.html#get_value_for_datastore
|
||||
oauth2client.appengine.InvalidClientSecretsError oauth2client.appengine.InvalidClientSecretsError-class.html
|
||||
oauth2client.appengine.InvalidXsrfTokenError oauth2client.appengine.InvalidXsrfTokenError-class.html
|
||||
oauth2client.appengine.OAuth2Decorator oauth2client.appengine.OAuth2Decorator-class.html
|
||||
oauth2client.appengine.OAuth2Decorator.http oauth2client.appengine.OAuth2Decorator-class.html#http
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_aware oauth2client.appengine.OAuth2Decorator-class.html#oauth_aware
|
||||
oauth2client.appengine.OAuth2Decorator.authorize_url oauth2client.appengine.OAuth2Decorator-class.html#authorize_url
|
||||
oauth2client.appengine.OAuth2Decorator._display_error_message oauth2client.appengine.OAuth2Decorator-class.html#_display_error_message
|
||||
oauth2client.appengine.OAuth2Decorator.has_credentials oauth2client.appengine.OAuth2Decorator-class.html#has_credentials
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_required oauth2client.appengine.OAuth2Decorator-class.html#oauth_required
|
||||
oauth2client.appengine.OAuth2Decorator.__init__ oauth2client.appengine.OAuth2Decorator-class.html#__init__
|
||||
oauth2client.appengine.OAuth2DecoratorFromClientSecrets oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html
|
||||
oauth2client.appengine.OAuth2Decorator.http oauth2client.appengine.OAuth2Decorator-class.html#http
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_aware oauth2client.appengine.OAuth2Decorator-class.html#oauth_aware
|
||||
oauth2client.appengine.OAuth2Decorator.authorize_url oauth2client.appengine.OAuth2Decorator-class.html#authorize_url
|
||||
oauth2client.appengine.OAuth2Decorator.callback_handler oauth2client.appengine.OAuth2Decorator-class.html#callback_handler
|
||||
oauth2client.appengine.OAuth2Decorator._display_error_message oauth2client.appengine.OAuth2Decorator-class.html#_display_error_message
|
||||
oauth2client.appengine.OAuth2Decorator.http oauth2client.appengine.OAuth2Decorator-class.html#http
|
||||
oauth2client.appengine.OAuth2Decorator._create_flow oauth2client.appengine.OAuth2Decorator-class.html#_create_flow
|
||||
oauth2client.appengine.OAuth2Decorator.has_credentials oauth2client.appengine.OAuth2Decorator-class.html#has_credentials
|
||||
oauth2client.appengine.OAuth2Decorator.callback_application oauth2client.appengine.OAuth2Decorator-class.html#callback_application
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_aware oauth2client.appengine.OAuth2Decorator-class.html#oauth_aware
|
||||
oauth2client.appengine.OAuth2Decorator.callback_path oauth2client.appengine.OAuth2Decorator-class.html#callback_path
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_required oauth2client.appengine.OAuth2Decorator-class.html#oauth_required
|
||||
oauth2client.appengine.OAuth2DecoratorFromClientSecrets oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html
|
||||
oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html#__init__
|
||||
oauth2client.appengine.OAuth2Handler oauth2client.appengine.OAuth2Handler-class.html
|
||||
oauth2client.appengine.OAuth2Handler.get oauth2client.appengine.OAuth2Handler-class.html#get
|
||||
oauth2client.appengine.OAuth2Decorator.authorize_url oauth2client.appengine.OAuth2Decorator-class.html#authorize_url
|
||||
oauth2client.appengine.OAuth2Decorator.callback_handler oauth2client.appengine.OAuth2Decorator-class.html#callback_handler
|
||||
oauth2client.appengine.OAuth2Decorator._display_error_message oauth2client.appengine.OAuth2Decorator-class.html#_display_error_message
|
||||
oauth2client.appengine.OAuth2Decorator.http oauth2client.appengine.OAuth2Decorator-class.html#http
|
||||
oauth2client.appengine.OAuth2Decorator._create_flow oauth2client.appengine.OAuth2Decorator-class.html#_create_flow
|
||||
oauth2client.appengine.OAuth2Decorator.has_credentials oauth2client.appengine.OAuth2Decorator-class.html#has_credentials
|
||||
oauth2client.appengine.OAuth2Decorator.callback_application oauth2client.appengine.OAuth2Decorator-class.html#callback_application
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_aware oauth2client.appengine.OAuth2Decorator-class.html#oauth_aware
|
||||
oauth2client.appengine.OAuth2Decorator.callback_path oauth2client.appengine.OAuth2Decorator-class.html#callback_path
|
||||
oauth2client.appengine.OAuth2Decorator.oauth_required oauth2client.appengine.OAuth2Decorator-class.html#oauth_required
|
||||
oauth2client.appengine.SiteXsrfSecretKey oauth2client.appengine.SiteXsrfSecretKey-class.html
|
||||
google.appengine.ext.db.Model.__metaclass__ google.appengine.ext.db.PropertiedClass-class.html
|
||||
oauth2client.appengine.SiteXsrfSecretKey._all_properties oauth2client.appengine.SiteXsrfSecretKey-class.html#_all_properties
|
||||
oauth2client.appengine.SiteXsrfSecretKey.secret oauth2client.appengine.SiteXsrfSecretKey-class.html#secret
|
||||
oauth2client.appengine.SiteXsrfSecretKey._properties oauth2client.appengine.SiteXsrfSecretKey-class.html#_properties
|
||||
oauth2client.appengine.StorageByKeyName oauth2client.appengine.StorageByKeyName-class.html
|
||||
oauth2client.client.Storage.acquire_lock oauth2client.client.Storage-class.html#acquire_lock
|
||||
oauth2client.appengine.StorageByKeyName.locked_put oauth2client.appengine.StorageByKeyName-class.html#locked_put
|
||||
@@ -549,6 +577,26 @@ oauth2client.file.Storage._create_file_if_needed oauth2client.file.Storage-class
|
||||
oauth2client.client.Storage.put oauth2client.client.Storage-class.html#put
|
||||
oauth2client.file.Storage.release_lock oauth2client.file.Storage-class.html#release_lock
|
||||
oauth2client.client.Storage.delete oauth2client.client.Storage-class.html#delete
|
||||
oauth2client.gce.AppAssertionCredentials oauth2client.gce.AppAssertionCredentials-class.html
|
||||
oauth2client.gce.AppAssertionCredentials.from_json oauth2client.gce.AppAssertionCredentials-class.html#from_json
|
||||
oauth2client.client.OAuth2Credentials.authorize oauth2client.client.OAuth2Credentials-class.html#authorize
|
||||
oauth2client.client.OAuth2Credentials.set_store oauth2client.client.OAuth2Credentials-class.html#set_store
|
||||
oauth2client.client.OAuth2Credentials.to_json oauth2client.client.OAuth2Credentials-class.html#to_json
|
||||
oauth2client.client.OAuth2Credentials.apply oauth2client.client.OAuth2Credentials-class.html#apply
|
||||
oauth2client.client.Credentials.new_from_json oauth2client.client.Credentials-class.html#new_from_json
|
||||
oauth2client.gce.AppAssertionCredentials.__init__ oauth2client.gce.AppAssertionCredentials-class.html#__init__
|
||||
oauth2client.client.OAuth2Credentials._generate_refresh_request_headers oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers
|
||||
oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS
|
||||
oauth2client.client.OAuth2Credentials.__getstate__ oauth2client.client.OAuth2Credentials-class.html#__getstate__
|
||||
oauth2client.client.OAuth2Credentials.__setstate__ oauth2client.client.OAuth2Credentials-class.html#__setstate__
|
||||
oauth2client.gce.AppAssertionCredentials._refresh oauth2client.gce.AppAssertionCredentials-class.html#_refresh
|
||||
oauth2client.client.AssertionCredentials._generate_assertion oauth2client.client.AssertionCredentials-class.html#_generate_assertion
|
||||
oauth2client.client.AssertionCredentials._generate_refresh_request_body oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body
|
||||
oauth2client.client.Credentials._to_json oauth2client.client.Credentials-class.html#_to_json
|
||||
oauth2client.client.OAuth2Credentials._updateFromCredential oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential
|
||||
oauth2client.client.OAuth2Credentials._do_refresh_request oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request
|
||||
oauth2client.client.OAuth2Credentials.refresh oauth2client.client.OAuth2Credentials-class.html#refresh
|
||||
oauth2client.client.OAuth2Credentials.access_token_expired oauth2client.client.OAuth2Credentials-class.html#access_token_expired
|
||||
oauth2client.keyring_storage.Storage oauth2client.keyring_storage.Storage-class.html
|
||||
oauth2client.keyring_storage.Storage.acquire_lock oauth2client.keyring_storage.Storage-class.html#acquire_lock
|
||||
oauth2client.keyring_storage.Storage.locked_put oauth2client.keyring_storage.Storage-class.html#locked_put
|
||||
|
||||
@@ -140,7 +140,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -83,7 +83,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:32 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:10 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -126,7 +126,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -102,7 +102,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -140,39 +140,11 @@ A client library for Google's discovery based APIs.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>,
|
||||
<span class="summary-sig-arg">version</span>,
|
||||
<span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersio</code><code class="variable-ellipsis">...</code></span>,
|
||||
<span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default"><class 'apiclient.http.HttpRequest'></span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Construct a Resource for interacting with an API.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name" onclick="show_private();">build_from_document</a>(<span class="summary-sig-arg">service</span>,
|
||||
<span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default"><class 'apiclient.http.HttpRequest'></span>)</span><br />
|
||||
Create a Resource for interacting with an API.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -446,16 +418,11 @@ Returns:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
|
||||
<span class="sig-arg">version</span>,
|
||||
<span class="sig-arg">http</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersio</code><code class="variable-ellipsis">...</code></span>,
|
||||
<span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">model</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">requestBuilder</span>=<span class="sig-default"><class 'apiclient.http.HttpRequest'></span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -485,54 +452,10 @@ Returns:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="build_from_document"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
|
||||
<span class="sig-arg">base</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">future</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">http</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">model</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">requestBuilder</span>=<span class="sig-default"><class 'apiclient.http.HttpRequest'></span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Create a Resource for interacting with an API.
|
||||
|
||||
Same as `build()`, but constructs the Resource object from a discovery
|
||||
document that is it given, as opposed to retrieving one over HTTP.
|
||||
|
||||
Args:
|
||||
service: string, discovery document.
|
||||
base: string, base URI for all HTTP requests, usually the discovery URI.
|
||||
This parameter is no longer used as rootUrl and servicePath are included
|
||||
within the discovery document. (deprecated)
|
||||
future: string, discovery document with future capabilities (deprecated).
|
||||
http: httplib2.Http, An instance of httplib2.Http or something that acts
|
||||
like it that HTTP requests will be made through.
|
||||
developerKey: string, Key for controlling API usage, generated
|
||||
from the API Console.
|
||||
model: Model class instance that serializes and de-serializes requests and
|
||||
responses.
|
||||
requestBuilder: Takes an http request and packages it up to be executed.
|
||||
|
||||
Returns:
|
||||
A Resource object with methods for interacting with the service.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(2)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -750,7 +673,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -146,6 +146,14 @@ should be defined in this file.
|
||||
Error occured during resumable upload.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.errors.InvalidChunkSizeError-class.html" class="summary-name">InvalidChunkSizeError</a><br />
|
||||
The given chunksize is not valid.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
@@ -219,7 +227,7 @@ should be defined in this file.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -94,13 +94,11 @@ Error occured during batch operations.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.errors.BatchError-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">reason</span>,
|
||||
<span class="summary-sig-arg">resp</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">content</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.errors.BatchError-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.errors-pysrc.html#BatchError.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -224,14 +222,12 @@ Error occured during batch operations.
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">reason</span>,
|
||||
<span class="sig-arg">resp</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">content</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.errors-pysrc.html#BatchError.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -240,6 +236,10 @@ x.__init__(...) initializes x; see x.__class__.__doc__ for signature
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(2)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
<dd><em class="note">(inherited documentation)</em></dd>
|
||||
@@ -325,7 +325,7 @@ str(x)
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -57,18 +57,19 @@
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for_error" name="class_hierarchy_for_error">
|
||||
<area shape="rect" href="apiclient.errors.BatchError-class.html" title="BatchError" alt="" coords="5,229,88,256"/>
|
||||
<area shape="rect" href="apiclient.errors.Error-class.html" title="Error" alt="" coords="664,117,712,144"/>
|
||||
<area shape="rect" href="apiclient.errors.Error-class.html" title="Error" alt="" coords="737,117,785,144"/>
|
||||
<area shape="rect" href="apiclient.errors.HttpError-class.html" title="HttpError" alt="" coords="11,173,83,200"/>
|
||||
<area shape="rect" href="apiclient.errors.InvalidJsonError-class.html" title="InvalidJsonError" alt="" coords="107,173,219,200"/>
|
||||
<area shape="rect" href="apiclient.errors.MediaUploadSizeError-class.html" title="MediaUploadSizeError" alt="" coords="243,173,392,200"/>
|
||||
<area shape="rect" href="apiclient.errors.ResumableUploadError-class.html" title="ResumableUploadError" alt="" coords="416,173,571,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnacceptableMimeTypeError-class.html" title="UnacceptableMimeTypeError" alt="" coords="595,173,781,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnexpectedBodyError-class.html" title="UnexpectedBodyError" alt="" coords="805,173,952,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnexpectedMethodError-class.html" title="UnexpectedMethodError" alt="" coords="976,173,1136,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnknownApiNameOrVersion-class.html" title="UnknownApiNameOrVersion" alt="" coords="1160,173,1344,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnknownLinkType-class.html" title="UnknownLinkType" alt="" coords="1368,173,1493,200"/>
|
||||
<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException" alt="" coords="600,5,776,32"/>
|
||||
<area shape="rect" href="javascript:void(0);" title="exceptions.Exception" alt="" coords="615,61,761,88"/>
|
||||
<area shape="rect" href="apiclient.errors.InvalidChunkSizeError-class.html" title="InvalidChunkSizeError" alt="" coords="107,173,253,200"/>
|
||||
<area shape="rect" href="apiclient.errors.InvalidJsonError-class.html" title="InvalidJsonError" alt="" coords="277,173,389,200"/>
|
||||
<area shape="rect" href="apiclient.errors.MediaUploadSizeError-class.html" title="MediaUploadSizeError" alt="" coords="413,173,563,200"/>
|
||||
<area shape="rect" href="apiclient.errors.ResumableUploadError-class.html" title="ResumableUploadError" alt="" coords="587,173,741,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnacceptableMimeTypeError-class.html" title="UnacceptableMimeTypeError" alt="" coords="765,173,952,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnexpectedBodyError-class.html" title="UnexpectedBodyError" alt="" coords="976,173,1123,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnexpectedMethodError-class.html" title="UnexpectedMethodError" alt="" coords="1147,173,1307,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnknownApiNameOrVersion-class.html" title="UnknownApiNameOrVersion" alt="" coords="1331,173,1515,200"/>
|
||||
<area shape="rect" href="apiclient.errors.UnknownLinkType-class.html" title="UnknownLinkType" alt="" coords="1539,173,1664,200"/>
|
||||
<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException" alt="" coords="673,5,849,32"/>
|
||||
<area shape="rect" href="javascript:void(0);" title="exceptions.Exception" alt="" coords="688,61,835,88"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for_error.gif" alt='' usemap="#class_hierarchy_for_error" ismap="ismap" class="graph-without-title" />
|
||||
</center>
|
||||
@@ -176,7 +177,7 @@ Base error for this module.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:01 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -94,13 +94,11 @@ HTTP data was invalid or unexpected.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.errors.HttpError-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">resp</span>,
|
||||
<span class="summary-sig-arg">content</span>,
|
||||
<span class="summary-sig-arg">uri</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.errors.HttpError-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.errors-pysrc.html#HttpError.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -238,14 +236,12 @@ HTTP data was invalid or unexpected.
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">resp</span>,
|
||||
<span class="sig-arg">content</span>,
|
||||
<span class="sig-arg">uri</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.errors-pysrc.html#HttpError.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -254,6 +250,10 @@ x.__init__(...) initializes x; see x.__class__.__doc__ for signature
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(3)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
<dd><em class="note">(inherited documentation)</em></dd>
|
||||
@@ -339,7 +339,7 @@ str(x)
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:01 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
189
docs/epy/apiclient.errors.InvalidChunkSizeError-class.html
Normal file
@@ -0,0 +1,189 @@
|
||||
<?xml version="1.0" encoding="ascii"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<title>apiclient.errors.InvalidChunkSizeError</title>
|
||||
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
||||
<script type="text/javascript" src="epydoc.js"></script>
|
||||
</head>
|
||||
|
||||
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
||||
alink="#204080">
|
||||
<!-- ==================== NAVIGATION BAR ==================== -->
|
||||
<table class="navbar" border="0" width="100%" cellpadding="0"
|
||||
bgcolor="#a0c0ff" cellspacing="0">
|
||||
<tr valign="middle">
|
||||
|
||||
<!-- Tree link -->
|
||||
<th> <a
|
||||
href="module-tree.html">Trees</a> </th>
|
||||
|
||||
<!-- Index link -->
|
||||
<th> <a
|
||||
href="identifier-index.html">Indices</a> </th>
|
||||
|
||||
<!-- Help link -->
|
||||
<th> <a
|
||||
href="help.html">Help</a> </th>
|
||||
|
||||
<th class="navbar" width="100%"></th>
|
||||
</tr>
|
||||
</table>
|
||||
<table width="100%" cellpadding="0" cellspacing="0">
|
||||
<tr valign="top">
|
||||
<td width="100%">
|
||||
<span class="breadcrumbs">
|
||||
<a href="apiclient-module.html">Package apiclient</a> ::
|
||||
<a href="apiclient.errors-module.html">Module errors</a> ::
|
||||
Class InvalidChunkSizeError
|
||||
</span>
|
||||
</td>
|
||||
<td>
|
||||
<table cellpadding="0" cellspacing="0">
|
||||
<!-- hide/show private -->
|
||||
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
||||
onclick="toggle_private();">hide private</a>]</span></td></tr>
|
||||
<tr><td align="right"><span class="options"
|
||||
>[<a href="frames.html" target="_top">frames</a
|
||||
>] | <a href="apiclient.errors.InvalidChunkSizeError-class.html"
|
||||
target="_top">no frames</a>]</span></td></tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
||||
<h1 class="epydoc">Class InvalidChunkSizeError</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.errors-pysrc.html#InvalidChunkSizeError">source code</a></span></p>
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for_invalidchu" name="class_hierarchy_for_invalidchu">
|
||||
<area shape="rect" href="apiclient.errors.Error-class.html" title="Error" alt="" coords="69,117,117,144"/>
|
||||
<area shape="rect" href="apiclient.errors.InvalidChunkSizeError-class.html" title="InvalidChunkSizeError" alt="" coords="20,173,167,200"/>
|
||||
<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException" alt="" coords="5,5,181,32"/>
|
||||
<area shape="rect" href="javascript:void(0);" title="exceptions.Exception" alt="" coords="20,61,167,88"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for_invalidchu.gif" alt='' usemap="#class_hierarchy_for_invalidchu" ismap="ismap" class="graph-without-title" />
|
||||
</center>
|
||||
</center>
|
||||
<hr />
|
||||
<pre class="literalblock">
|
||||
The given chunksize is not valid.
|
||||
|
||||
</pre>
|
||||
|
||||
<!-- ==================== INSTANCE METHODS ==================== -->
|
||||
<a name="section-InstanceMethods"></a>
|
||||
<table class="summary" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr bgcolor="#70b0f0" class="table-header">
|
||||
<td colspan="2" class="table-header">
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr valign="top">
|
||||
<td align="left"><span class="table-header">Instance Methods</span></td>
|
||||
<td align="right" valign="top"
|
||||
><span class="options">[<a href="#section-InstanceMethods"
|
||||
class="privatelink" onclick="toggle_private();"
|
||||
>hide private</a>]</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="summary">
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.Exception</code></b>:
|
||||
<code>__init__</code>,
|
||||
<code>__new__</code>
|
||||
</p>
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseException</code></b>:
|
||||
<code>__delattr__</code>,
|
||||
<code>__getattribute__</code>,
|
||||
<code>__getitem__</code>,
|
||||
<code>__getslice__</code>,
|
||||
<code>__reduce__</code>,
|
||||
<code>__repr__</code>,
|
||||
<code>__setattr__</code>,
|
||||
<code>__setstate__</code>,
|
||||
<code>__str__</code>,
|
||||
<code>__unicode__</code>
|
||||
</p>
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
||||
<code>__format__</code>,
|
||||
<code>__hash__</code>,
|
||||
<code>__reduce_ex__</code>,
|
||||
<code>__sizeof__</code>,
|
||||
<code>__subclasshook__</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== PROPERTIES ==================== -->
|
||||
<a name="section-Properties"></a>
|
||||
<table class="summary" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr bgcolor="#70b0f0" class="table-header">
|
||||
<td colspan="2" class="table-header">
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr valign="top">
|
||||
<td align="left"><span class="table-header">Properties</span></td>
|
||||
<td align="right" valign="top"
|
||||
><span class="options">[<a href="#section-Properties"
|
||||
class="privatelink" onclick="toggle_private();"
|
||||
>hide private</a>]</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="summary">
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseException</code></b>:
|
||||
<code>args</code>,
|
||||
<code>message</code>
|
||||
</p>
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
||||
<code>__class__</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== NAVIGATION BAR ==================== -->
|
||||
<table class="navbar" border="0" width="100%" cellpadding="0"
|
||||
bgcolor="#a0c0ff" cellspacing="0">
|
||||
<tr valign="middle">
|
||||
|
||||
<!-- Tree link -->
|
||||
<th> <a
|
||||
href="module-tree.html">Trees</a> </th>
|
||||
|
||||
<!-- Index link -->
|
||||
<th> <a
|
||||
href="identifier-index.html">Indices</a> </th>
|
||||
|
||||
<!-- Help link -->
|
||||
<th> <a
|
||||
href="help.html">Help</a> </th>
|
||||
|
||||
<th class="navbar" width="100%"></th>
|
||||
</tr>
|
||||
</table>
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:01 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
>http://epydoc.sourceforge.net</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<script type="text/javascript">
|
||||
<!--
|
||||
// Private objects are initially displayed (because if
|
||||
// javascript is turned off then we want them to be
|
||||
// visible); but by default, we want to hide them. So hide
|
||||
// them unless we have a cookie that says to show them.
|
||||
checkCookie();
|
||||
// -->
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -167,7 +167,7 @@ The JSON returned could not be parsed.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:01 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ Media is larger than the method can accept.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:01 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ Error occured during resumable upload.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:01 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ That is an unacceptable mimetype for this operation.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -232,7 +232,7 @@ Constructor for an UnexpectedMethodError.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -93,11 +93,11 @@ Exception raised by RequestMockBuilder on unexpected calls.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.errors.UnexpectedMethodError-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">methodId</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.errors.UnexpectedMethodError-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Constructor for an UnexpectedMethodError.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.errors-pysrc.html#UnexpectedMethodError.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -186,12 +186,12 @@ Exception raised by RequestMockBuilder on unexpected calls.
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">methodId</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.errors-pysrc.html#UnexpectedMethodError.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -200,6 +200,10 @@ Constructor for an UnexpectedMethodError.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(1)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
@@ -230,7 +234,7 @@ Constructor for an UnexpectedMethodError.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ No API with that name and version exists.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -167,7 +167,7 @@ Link type unknown or unexpected.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -101,7 +101,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -84,7 +84,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:31 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:10 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -111,16 +111,16 @@ actuall HTTP request.
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.http.MediaFileUpload-class.html" class="summary-name">MediaFileUpload</a><br />
|
||||
A MediaUpload for a file.
|
||||
<a href="apiclient.http.MediaIoBaseUpload-class.html" class="summary-name">MediaIoBaseUpload</a><br />
|
||||
A MediaUpload for a io.Base objects.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.http.MediaIoBaseUpload-class.html" class="summary-name">MediaIoBaseUpload</a><br />
|
||||
A MediaUpload for a io.Base objects.
|
||||
<a href="apiclient.http.MediaFileUpload-class.html" class="summary-name">MediaFileUpload</a><br />
|
||||
A MediaUpload for a file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -139,6 +139,14 @@ actuall HTTP request.
|
||||
"Download media resources.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="apiclient.http._StreamSlice-class.html" class="summary-name" onclick="show_private();">_StreamSlice</a><br />
|
||||
Truncated stream.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
@@ -265,6 +273,13 @@ actuall HTTP request.
|
||||
<a name="DEFAULT_CHUNK_SIZE"></a><span class="summary-name">DEFAULT_CHUNK_SIZE</span> = <code title="524288">524288</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a name="MAX_URI_LENGTH"></a><span class="summary-name">MAX_URI_LENGTH</span> = <code title="4000">4000</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
@@ -391,7 +406,7 @@ will result in a different signature.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -92,7 +92,7 @@ Example:
|
||||
|
||||
batch.add(service.animals().list(), list_animals)
|
||||
batch.add(service.farmers().list(), list_farmers)
|
||||
batch.execute(http)
|
||||
batch.execute(http=http)
|
||||
|
||||
</pre>
|
||||
|
||||
@@ -119,12 +119,11 @@ Example:
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">callback</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">batch_uri</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Constructor for a BatchHttpRequest.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -246,13 +245,11 @@ Example:
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">request</span>,
|
||||
<span class="summary-sig-arg">callback</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">request_id</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Add a new request.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.add">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -286,11 +283,11 @@ Example:
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Execute all the requests as a single batched HTTP request.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.execute">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -367,13 +364,12 @@ Example:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">callback</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">batch_uri</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -390,6 +386,10 @@ Args:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(1)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
@@ -582,13 +582,11 @@ Returns:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">request</span>,
|
||||
<span class="sig-arg">callback</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">request_id</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.add">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -622,6 +620,10 @@ Raises:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(2)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -667,11 +669,11 @@ Raises:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.execute">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -692,6 +694,10 @@ Raises:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(1)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -719,7 +725,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -242,7 +242,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -259,7 +259,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -90,18 +90,11 @@ Encapsulates a single HTTP request.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">http</span>,
|
||||
<span class="summary-sig-arg">postproc</span>,
|
||||
<span class="summary-sig-arg">uri</span>,
|
||||
<span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,
|
||||
<span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">methodId</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Constructor for an HttpRequest.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -115,11 +108,11 @@ Encapsulates a single HTTP request.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Execute the request.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.execute">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -133,11 +126,11 @@ Encapsulates a single HTTP request.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#next_chunk" class="summary-sig-name">next_chunk</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#next_chunk" class="summary-sig-name">next_chunk</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Execute the next step of a resumable upload.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.next_chunk">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -287,19 +280,12 @@ Encapsulates a single HTTP request.
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">http</span>,
|
||||
<span class="sig-arg">postproc</span>,
|
||||
<span class="sig-arg">uri</span>,
|
||||
<span class="sig-arg">method</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,
|
||||
<span class="sig-arg">body</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">headers</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">methodId</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">resumable</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -320,6 +306,10 @@ Args:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(4)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
@@ -333,11 +323,11 @@ Args:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.execute">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -358,6 +348,10 @@ Raises:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(1)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -368,11 +362,11 @@ Raises:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">next_chunk</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">next_chunk</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.next_chunk">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -408,6 +402,10 @@ Raises:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(1)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -470,7 +468,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -271,7 +271,7 @@ mocked and not really from an HTTP request/response.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -264,7 +264,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -56,8 +56,9 @@
|
||||
<h1 class="epydoc">Class MediaFileUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload">source code</a></span></p>
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for_mediafileu" name="class_hierarchy_for_mediafileu">
|
||||
<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="5,61,123,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="16,5,112,32"/>
|
||||
<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="15,117,132,144"/>
|
||||
<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="5,61,141,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="25,5,121,32"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for_mediafileu.gif" alt='' usemap="#class_hierarchy_for_mediafileu" ismap="ismap" class="graph-without-title" />
|
||||
</center>
|
||||
@@ -72,11 +73,19 @@ method. For example, if we had a service that allowed uploading images:
|
||||
|
||||
media = MediaFileUpload('cow.png', mimetype='image/png',
|
||||
chunksize=1024*1024, resumable=True)
|
||||
farm.animals()..insert(
|
||||
farm.animals().insert(
|
||||
id='cow',
|
||||
name='cow.png',
|
||||
media_body=media).execute()
|
||||
|
||||
Depending on the platform you are working on, you may pass -1 as the
|
||||
chunksize, which indicates that the entire file should be uploaded in a single
|
||||
request. If the underlying platform supports streams, such as Python 2.6 or
|
||||
later, then this can be very efficient as it avoids multiple connections, and
|
||||
also avoids loading the entire file into memory before sending it. Note that
|
||||
Google App Engine has a 5MB limit on request size, so you should never set
|
||||
your chunksize larger than 5MB, or to -1.
|
||||
|
||||
</pre>
|
||||
|
||||
<!-- ==================== INSTANCE METHODS ==================== -->
|
||||
@@ -102,101 +111,11 @@ method. For example, if we had a service that allowed uploading images:
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">filename</span>,
|
||||
<span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>,
|
||||
<span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Constructor.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#chunksize" class="summary-sig-name">chunksize</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Chunk size for resumable uploads.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#mimetype" class="summary-sig-name">mimetype</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Mime type of the body.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#size" class="summary-sig-name">size</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Size of upload.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#resumable" class="summary-sig-name">resumable</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Whether this upload is resumable.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#getbytes" class="summary-sig-name">getbytes</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">begin</span>,
|
||||
<span class="summary-sig-arg">length</span>)</span><br />
|
||||
Get bytes from the media.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -223,6 +142,15 @@ method. For example, if we had a service that allowed uploading images:
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="summary">
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaIoBaseUpload-class.html">MediaIoBaseUpload</a></code></b>:
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#chunksize">chunksize</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#getbytes">getbytes</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#has_stream">has_stream</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#mimetype">mimetype</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#resumable">resumable</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#size">size</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#stream">stream</a></code>
|
||||
</p>
|
||||
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
|
||||
<code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
|
||||
</p></div>
|
||||
@@ -352,15 +280,12 @@ method. For example, if we had a service that allowed uploading images:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">filename</span>,
|
||||
<span class="sig-arg">mimetype</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>,
|
||||
<span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -372,165 +297,25 @@ Args:
|
||||
mimetype: string, Mime-type of the file. If None then a mime-type will be
|
||||
guessed from the file extension.
|
||||
chunksize: int, File will be uploaded in chunks of this many bytes. Only
|
||||
used if resumable=True.
|
||||
used if resumable=True. Pass in a value of -1 if the file is to be
|
||||
uploaded in a single chunk. Note that Google App Engine has a 5MB limit
|
||||
on request size, so you should never set your chunksize larger than 5MB,
|
||||
or to -1.
|
||||
resumable: bool, True if this is a resumable upload. False means upload
|
||||
in a single request.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(2)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="chunksize"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Chunk size for resumable uploads.
|
||||
|
||||
Returns:
|
||||
Chunk size in bytes.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="mimetype"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Mime type of the body.
|
||||
|
||||
Returns:
|
||||
Mime type.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="size"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Size of upload.
|
||||
|
||||
Returns:
|
||||
Size of the body, or None of the size is unknown.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="resumable"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Whether this upload is resumable.
|
||||
|
||||
Returns:
|
||||
True if resumable upload or False.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="getbytes"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">begin</span>,
|
||||
<span class="sig-arg">length</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Get bytes from the media.
|
||||
|
||||
Args:
|
||||
begin: int, offset from beginning of file.
|
||||
length: int, number of bytes to read, starting at begin.
|
||||
|
||||
Returns:
|
||||
A string of bytes read. May be shorted than length if EOF was reached
|
||||
first.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="to_json"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
@@ -584,7 +369,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -56,7 +56,8 @@
|
||||
<h1 class="epydoc">Class MediaInMemoryUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload">source code</a></span></p>
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for_mediainmem" name="class_hierarchy_for_mediainmem">
|
||||
<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaInMemoryUpload" alt="" coords="5,61,157,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaInMemoryUpload" alt="" coords="5,117,157,144"/>
|
||||
<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="13,61,149,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="33,5,129,32"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for_mediainmem.gif" alt='' usemap="#class_hierarchy_for_mediainmem" ismap="ismap" class="graph-without-title" />
|
||||
@@ -66,8 +67,8 @@
|
||||
<pre class="literalblock">
|
||||
MediaUpload for a chunk of bytes.
|
||||
|
||||
Construct a MediaFileUpload and pass as the media_body parameter of the
|
||||
method.
|
||||
DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for
|
||||
the stream.
|
||||
|
||||
</pre>
|
||||
|
||||
@@ -94,118 +95,11 @@ method.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">body</span>,
|
||||
<span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">application/octet-stream</code><code class="variable-quote">'</code></span>,
|
||||
<span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>,
|
||||
<span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
|
||||
Create a new MediaBytesUpload.</td>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Create a new MediaInMemoryUpload.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.__init__">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#chunksize" class="summary-sig-name">chunksize</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Chunk size for resumable uploads.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.chunksize">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#mimetype" class="summary-sig-name">mimetype</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Mime type of the body.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.mimetype">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#size" class="summary-sig-name">size</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Size of upload.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.size">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#resumable" class="summary-sig-name">resumable</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Whether this upload is resumable.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.resumable">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#getbytes" class="summary-sig-name">getbytes</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">begin</span>,
|
||||
<span class="summary-sig-arg">length</span>)</span><br />
|
||||
Get bytes from the media.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.getbytes">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Create a JSON representation of a MediaInMemoryUpload.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.to_json">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -215,6 +109,16 @@ method.
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="summary">
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaIoBaseUpload-class.html">MediaIoBaseUpload</a></code></b>:
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#chunksize">chunksize</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#getbytes">getbytes</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#has_stream">has_stream</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#mimetype">mimetype</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#resumable">resumable</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#size">size</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#stream">stream</a></code>,
|
||||
<code><a href="apiclient.http.MediaIoBaseUpload-class.html#to_json">to_json</a></code>
|
||||
</p>
|
||||
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
|
||||
<code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
|
||||
</p></div>
|
||||
@@ -260,40 +164,6 @@ method.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== STATIC METHODS ==================== -->
|
||||
<a name="section-StaticMethods"></a>
|
||||
<table class="summary" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr bgcolor="#70b0f0" class="table-header">
|
||||
<td colspan="2" class="table-header">
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr valign="top">
|
||||
<td align="left"><span class="table-header">Static Methods</span></td>
|
||||
<td align="right" valign="top"
|
||||
><span class="options">[<a href="#section-StaticMethods"
|
||||
class="privatelink" onclick="toggle_private();"
|
||||
>hide private</a>]</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a name="from_json"></a><span class="summary-sig-name">from_json</span>(<span class="summary-sig-arg">s</span>)</span></td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.from_json">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== PROPERTIES ==================== -->
|
||||
<a name="section-Properties"></a>
|
||||
<table class="summary" border="1" cellpadding="3"
|
||||
@@ -344,20 +214,20 @@ method.
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">body</span>,
|
||||
<span class="sig-arg">mimetype</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">application/octet-stream</code><code class="variable-quote">'</code></span>,
|
||||
<span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>,
|
||||
<span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Create a new MediaBytesUpload.
|
||||
Create a new MediaInMemoryUpload.
|
||||
|
||||
DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for
|
||||
the stream.
|
||||
|
||||
Args:
|
||||
body: string, Bytes of body content.
|
||||
@@ -367,191 +237,20 @@ Args:
|
||||
used if resumable=True.
|
||||
resumable: bool, True if this is a resumable upload. False means upload
|
||||
in a single request.
|
||||
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(2)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="chunksize"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.chunksize">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Chunk size for resumable uploads.
|
||||
|
||||
Returns:
|
||||
Chunk size in bytes.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="mimetype"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.mimetype">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Mime type of the body.
|
||||
|
||||
Returns:
|
||||
Mime type.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="size"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.size">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Size of upload.
|
||||
|
||||
Returns:
|
||||
Size of the body, or None of the size is unknown.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="resumable"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.resumable">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Whether this upload is resumable.
|
||||
|
||||
Returns:
|
||||
True if resumable upload or False.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="getbytes"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">begin</span>,
|
||||
<span class="sig-arg">length</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.getbytes">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Get bytes from the media.
|
||||
|
||||
Args:
|
||||
begin: int, offset from beginning of file.
|
||||
length: int, number of bytes to read, starting at begin.
|
||||
|
||||
Returns:
|
||||
A string of bytes read. May be shorter than length if EOF was reached
|
||||
first.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="to_json"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.to_json">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Create a JSON representation of a MediaInMemoryUpload.
|
||||
|
||||
Returns:
|
||||
string, a JSON representation of this instance, suitable to pass to
|
||||
from_json().
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#to_json">MediaUpload.to_json</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<br />
|
||||
<!-- ==================== NAVIGATION BAR ==================== -->
|
||||
<table class="navbar" border="0" width="100%" cellpadding="0"
|
||||
@@ -576,7 +275,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -106,13 +106,11 @@ Example:
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseDownload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">fd</span>,
|
||||
<span class="summary-sig-arg">request</span>,
|
||||
<span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseDownload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Constructor.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseDownload.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -206,14 +204,12 @@ Example:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">fd</span>,
|
||||
<span class="sig-arg">request</span>,
|
||||
<span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseDownload.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -229,6 +225,10 @@ Args:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(3)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
@@ -290,7 +290,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:03 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -56,8 +56,10 @@
|
||||
<h1 class="epydoc">Class MediaIoBaseUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload">source code</a></span></p>
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for_mediaiobas_2" name="class_hierarchy_for_mediaiobas_2">
|
||||
<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="5,61,141,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="25,5,121,32"/>
|
||||
<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="5,117,123,144"/>
|
||||
<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaInMemoryUpload" alt="" coords="147,117,299,144"/>
|
||||
<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="75,61,211,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="95,5,191,32"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for_mediaiobas_2.gif" alt='' usemap="#class_hierarchy_for_mediaiobas_2" ismap="ismap" class="graph-without-title" />
|
||||
</center>
|
||||
@@ -77,6 +79,14 @@ with this class also.
|
||||
name='cow.png',
|
||||
media_body=media).execute()
|
||||
|
||||
Depending on the platform you are working on, you may pass -1 as the
|
||||
chunksize, which indicates that the entire file should be uploaded in a single
|
||||
request. If the underlying platform supports streams, such as Python 2.6 or
|
||||
later, then this can be very efficient as it avoids multiple connections, and
|
||||
also avoids loading the entire file into memory before sending it. Note that
|
||||
Google App Engine has a 5MB limit on request size, so you should never set
|
||||
your chunksize larger than 5MB, or to -1.
|
||||
|
||||
</pre>
|
||||
|
||||
<!-- ==================== INSTANCE METHODS ==================== -->
|
||||
@@ -102,14 +112,11 @@ with this class also.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">fd</span>,
|
||||
<span class="summary-sig-arg">mimetype</span>,
|
||||
<span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>,
|
||||
<span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Constructor.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -202,6 +209,40 @@ with this class also.
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#has_stream" class="summary-sig-name">has_stream</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Does the underlying upload support a streaming interface.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.has_stream">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#stream" class="summary-sig-name">stream</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
A stream interface to the data being uploaded.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.stream">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -318,15 +359,12 @@ with this class also.
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">fd</span>,
|
||||
<span class="sig-arg">mimetype</span>,
|
||||
<span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>,
|
||||
<span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -336,15 +374,23 @@ Constructor.
|
||||
Args:
|
||||
fd: io.Base or file object, The source of the bytes to upload. MUST be
|
||||
opened in blocking mode, do not use streams opened in non-blocking mode.
|
||||
mimetype: string, Mime-type of the file. If None then a mime-type will be
|
||||
guessed from the file extension.
|
||||
The given stream must be seekable, that is, it must be able to call
|
||||
seek() on fd.
|
||||
mimetype: string, Mime-type of the file.
|
||||
chunksize: int, File will be uploaded in chunks of this many bytes. Only
|
||||
used if resumable=True.
|
||||
used if resumable=True. Pass in a value of -1 if the file is to be
|
||||
uploaded as a single chunk. Note that Google App Engine has a 5MB limit
|
||||
on request size, so you should never set your chunksize larger than 5MB,
|
||||
or to -1.
|
||||
resumable: bool, True if this is a resumable upload. False means upload
|
||||
in a single request.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(3)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
@@ -498,6 +544,67 @@ Returns:
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="has_stream"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">has_stream</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.has_stream">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Does the underlying upload support a streaming interface.
|
||||
|
||||
Streaming means it is an io.IOBase subclass that supports seek, i.e.
|
||||
seekable() returns True.
|
||||
|
||||
Returns:
|
||||
True if the call to stream() will return an instance of a seekable io.Base
|
||||
subclass.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#has_stream">MediaUpload.has_stream</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="stream"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">stream</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.stream">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
A stream interface to the data being uploaded.
|
||||
|
||||
Returns:
|
||||
The returned value is an io.IOBase subclass that supports seek, i.e.
|
||||
seekable() returns True.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
<a href="apiclient.http.MediaUpload-class.html#stream">MediaUpload.stream</a>
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="to_json"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
@@ -547,7 +654,7 @@ This upload type is not serializable.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:03 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -56,10 +56,10 @@
|
||||
<h1 class="epydoc">Class MediaUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload">source code</a></span></p>
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for_mediauploa_2" name="class_hierarchy_for_mediauploa_2">
|
||||
<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="5,61,123,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaInMemoryUpload" alt="" coords="147,61,299,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="323,61,459,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="175,5,271,32"/>
|
||||
<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="5,117,123,144"/>
|
||||
<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaInMemoryUpload" alt="" coords="147,117,299,144"/>
|
||||
<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="75,61,211,88"/>
|
||||
<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="95,5,191,32"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for_mediauploa_2.gif" alt='' usemap="#class_hierarchy_for_mediauploa_2" ismap="ismap" class="graph-without-title" />
|
||||
</center>
|
||||
@@ -71,12 +71,26 @@ Describes a media object to upload.
|
||||
Base class that defines the interface of MediaUpload subclasses.
|
||||
|
||||
Note that subclasses of MediaUpload may allow you to control the chunksize
|
||||
when upload a media object. It is important to keep the size of the chunk as
|
||||
large as possible to keep the upload efficient. Other factors may influence
|
||||
when uploading a media object. It is important to keep the size of the chunk
|
||||
as large as possible to keep the upload efficient. Other factors may influence
|
||||
the size of the chunk you use, particularly if you are working in an
|
||||
environment where individual HTTP requests may have a hardcoded time limit,
|
||||
such as under certain classes of requests under Google App Engine.
|
||||
|
||||
Streams are io.Base compatible objects that support seek(). Some MediaUpload
|
||||
subclasses support using streams directly to upload data. Support for
|
||||
streaming may be indicated by a MediaUpload sub-class and if appropriate for a
|
||||
platform that stream will be used for uploading the media object. The support
|
||||
for streaming is indicated by has_stream() returning True. The stream() method
|
||||
should return an io.Base object that supports seek(). On platforms where the
|
||||
underlying httplib module supports streaming, for example Python 2.6 and
|
||||
later, the stream will be passed into the http library which will result in
|
||||
less memory being used and possibly faster uploads.
|
||||
|
||||
If you need to upload media that can't be uploaded using any of the existing
|
||||
MediaUpload sub-class then you can sub-class MediaUpload for your particular
|
||||
needs.
|
||||
|
||||
</pre>
|
||||
|
||||
<!-- ==================== INSTANCE METHODS ==================== -->
|
||||
@@ -181,6 +195,40 @@ such as under certain classes of requests under Google App Engine.
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaUpload-class.html#has_stream" class="summary-sig-name">has_stream</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
Does the underlying upload support a streaming interface.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.has_stream">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaUpload-class.html#stream" class="summary-sig-name">stream</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
||||
A stream interface to the data being uploaded.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.stream">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
@@ -189,11 +237,11 @@ such as under certain classes of requests under Google App Engine.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaUpload-class.html#_to_json" class="summary-sig-name" onclick="show_private();">_to_json</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">strip</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.http.MediaUpload-class.html#_to_json" class="summary-sig-name" onclick="show_private();">_to_json</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Utility function for creating a JSON representation of a MediaUpload.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload._to_json">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -445,6 +493,61 @@ Returns:
|
||||
A string of bytes read. May be shorter than length if EOF was reached
|
||||
first.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="has_stream"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">has_stream</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.has_stream">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Does the underlying upload support a streaming interface.
|
||||
|
||||
Streaming means it is an io.IOBase subclass that supports seek, i.e.
|
||||
seekable() returns True.
|
||||
|
||||
Returns:
|
||||
True if the call to stream() will return an instance of a seekable io.Base
|
||||
subclass.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="stream"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">stream</span>(<span class="sig-arg">self</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.stream">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
A stream interface to the data being uploaded.
|
||||
|
||||
Returns:
|
||||
The returned value is an io.IOBase subclass that supports seek, i.e.
|
||||
seekable() returns True.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
@@ -457,11 +560,11 @@ Returns:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_to_json</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">strip</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_to_json</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload._to_json">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -477,6 +580,10 @@ Returns:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(1)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -562,7 +669,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:03 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -265,7 +265,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:03 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -311,7 +311,7 @@ parameters and the expected response.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:03 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
299
docs/epy/apiclient.http._StreamSlice-class.html
Normal file
@@ -0,0 +1,299 @@
|
||||
<?xml version="1.0" encoding="ascii"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<title>apiclient.http._StreamSlice</title>
|
||||
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
||||
<script type="text/javascript" src="epydoc.js"></script>
|
||||
</head>
|
||||
|
||||
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
||||
alink="#204080">
|
||||
<!-- ==================== NAVIGATION BAR ==================== -->
|
||||
<table class="navbar" border="0" width="100%" cellpadding="0"
|
||||
bgcolor="#a0c0ff" cellspacing="0">
|
||||
<tr valign="middle">
|
||||
|
||||
<!-- Tree link -->
|
||||
<th> <a
|
||||
href="module-tree.html">Trees</a> </th>
|
||||
|
||||
<!-- Index link -->
|
||||
<th> <a
|
||||
href="identifier-index.html">Indices</a> </th>
|
||||
|
||||
<!-- Help link -->
|
||||
<th> <a
|
||||
href="help.html">Help</a> </th>
|
||||
|
||||
<th class="navbar" width="100%"></th>
|
||||
</tr>
|
||||
</table>
|
||||
<table width="100%" cellpadding="0" cellspacing="0">
|
||||
<tr valign="top">
|
||||
<td width="100%">
|
||||
<span class="breadcrumbs">
|
||||
<a href="apiclient-module.html">Package apiclient</a> ::
|
||||
<a href="apiclient.http-module.html">Module http</a> ::
|
||||
Class _StreamSlice
|
||||
</span>
|
||||
</td>
|
||||
<td>
|
||||
<table cellpadding="0" cellspacing="0">
|
||||
<!-- hide/show private -->
|
||||
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
||||
onclick="toggle_private();">hide private</a>]</span></td></tr>
|
||||
<tr><td align="right"><span class="options"
|
||||
>[<a href="frames.html" target="_top">frames</a
|
||||
>] | <a href="apiclient.http._StreamSlice-class.html"
|
||||
target="_top">no frames</a>]</span></td></tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
||||
<h1 class="epydoc">Class _StreamSlice</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice">source code</a></span></p>
|
||||
<center>
|
||||
<center> <map id="class_hierarchy_for__streamsli" name="class_hierarchy_for__streamsli">
|
||||
<area shape="rect" href="apiclient.http._StreamSlice-class.html" title="_StreamSlice" alt="" coords="5,5,104,32"/>
|
||||
</map>
|
||||
<img src="class_hierarchy_for__streamsli.gif" alt='' usemap="#class_hierarchy_for__streamsli" ismap="ismap" class="graph-without-title" />
|
||||
</center>
|
||||
</center>
|
||||
<hr />
|
||||
<pre class="literalblock">
|
||||
Truncated stream.
|
||||
|
||||
Takes a stream and presents a stream that is a slice of the original stream.
|
||||
This is used when uploading media in chunks. In later versions of Python a
|
||||
stream can be passed to httplib in place of the string of data to send. The
|
||||
problem is that httplib just blindly reads to the end of the stream. This
|
||||
wrapper presents a virtual stream that only reads to the end of the chunk.
|
||||
|
||||
</pre>
|
||||
|
||||
<!-- ==================== INSTANCE METHODS ==================== -->
|
||||
<a name="section-InstanceMethods"></a>
|
||||
<table class="summary" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr bgcolor="#70b0f0" class="table-header">
|
||||
<td colspan="2" class="table-header">
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr valign="top">
|
||||
<td align="left"><span class="table-header">Instance Methods</span></td>
|
||||
<td align="right" valign="top"
|
||||
><span class="options">[<a href="#section-InstanceMethods"
|
||||
class="privatelink" onclick="toggle_private();"
|
||||
>hide private</a>]</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http._StreamSlice-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">stream</span>,
|
||||
<span class="summary-sig-arg">begin</span>,
|
||||
<span class="summary-sig-arg">chunksize</span>)</span><br />
|
||||
Constructor.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.__init__">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.http._StreamSlice-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">n</span>=<span class="summary-sig-default">-1</span>)</span><br />
|
||||
Read n bytes.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.read">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="summary">
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
||||
<code>__delattr__</code>,
|
||||
<code>__format__</code>,
|
||||
<code>__getattribute__</code>,
|
||||
<code>__hash__</code>,
|
||||
<code>__new__</code>,
|
||||
<code>__reduce__</code>,
|
||||
<code>__reduce_ex__</code>,
|
||||
<code>__repr__</code>,
|
||||
<code>__setattr__</code>,
|
||||
<code>__sizeof__</code>,
|
||||
<code>__str__</code>,
|
||||
<code>__subclasshook__</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== PROPERTIES ==================== -->
|
||||
<a name="section-Properties"></a>
|
||||
<table class="summary" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr bgcolor="#70b0f0" class="table-header">
|
||||
<td colspan="2" class="table-header">
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr valign="top">
|
||||
<td align="left"><span class="table-header">Properties</span></td>
|
||||
<td align="right" valign="top"
|
||||
><span class="options">[<a href="#section-Properties"
|
||||
class="privatelink" onclick="toggle_private();"
|
||||
>hide private</a>]</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="summary">
|
||||
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
||||
<code>__class__</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== METHOD DETAILS ==================== -->
|
||||
<a name="section-MethodDetails"></a>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr bgcolor="#70b0f0" class="table-header">
|
||||
<td colspan="2" class="table-header">
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr valign="top">
|
||||
<td align="left"><span class="table-header">Method Details</span></td>
|
||||
<td align="right" valign="top"
|
||||
><span class="options">[<a href="#section-MethodDetails"
|
||||
class="privatelink" onclick="toggle_private();"
|
||||
>hide private</a>]</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="__init__"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">stream</span>,
|
||||
<span class="sig-arg">begin</span>,
|
||||
<span class="sig-arg">chunksize</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.__init__">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Constructor.
|
||||
|
||||
Args:
|
||||
stream: (io.Base, file object), the stream to wrap.
|
||||
begin: int, the seek position the chunk begins at.
|
||||
chunksize: int, the size of the chunk.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="read"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">read</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">n</span>=<span class="sig-default">-1</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.read">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Read n bytes.
|
||||
|
||||
Args:
|
||||
n, int, the number of bytes to read.
|
||||
|
||||
Returns:
|
||||
A string of length 'n', or less if EOF is reached.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<br />
|
||||
<!-- ==================== NAVIGATION BAR ==================== -->
|
||||
<table class="navbar" border="0" width="100%" cellpadding="0"
|
||||
bgcolor="#a0c0ff" cellspacing="0">
|
||||
<tr valign="middle">
|
||||
|
||||
<!-- Tree link -->
|
||||
<th> <a
|
||||
href="module-tree.html">Trees</a> </th>
|
||||
|
||||
<!-- Index link -->
|
||||
<th> <a
|
||||
href="identifier-index.html">Indices</a> </th>
|
||||
|
||||
<!-- Help link -->
|
||||
<th> <a
|
||||
href="help.html">Help</a> </th>
|
||||
|
||||
<th class="navbar" width="100%"></th>
|
||||
</tr>
|
||||
</table>
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:03 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
>http://epydoc.sourceforge.net</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<script type="text/javascript">
|
||||
<!--
|
||||
// Private objects are initially displayed (because if
|
||||
// javascript is turned off then we want them to be
|
||||
// visible); but by default, we want to hide them. So hide
|
||||
// them unless we have a cookie that says to show them.
|
||||
checkCookie();
|
||||
// -->
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -491,7 +491,7 @@ a tie.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -255,7 +255,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:32 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:10 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -300,7 +300,7 @@ Example usage:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -521,8 +521,7 @@ apiclient.model.RawModel.alt_param" class="py-name" href="#" onclick="return doc
|
||||
<a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"> <tt class="py-name">patch</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
|
||||
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">original_value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">original</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"> <tt class="py-name">modified_value</tt> <tt class="py-op">=</tt> <tt class="py-name">modified</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name" targets="Method apiclient.schema.Schemas.get()=apiclient.schema.Schemas-class.html#get,Method oauth2client.appengine.OAuth2Handler.get()=oauth2client.appengine.OAuth2Handler-class.html#get,Method oauth2client.client.MemoryCache.get()=oauth2client.client.MemoryCache-class.html#get,Method oauth2client.client.Storage.get()=oauth2client.client.Storage-class.html#get"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
<a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"> <tt class="py-name">modified_value</tt> <tt class="py-op">=</tt> <tt class="py-name">modified</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name" targets="Method apiclient.schema.Schemas.get()=apiclient.schema.Schemas-class.html#get,Method oauth2client.client.MemoryCache.get()=oauth2client.client.MemoryCache-class.html#get,Method oauth2client.client.Storage.get()=oauth2client.client.Storage-class.html#get"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-41', 'get', 'link-41');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">modified_value</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
||||
@@ -573,7 +572,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:31 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:10 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -535,7 +535,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:03 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -417,7 +417,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -322,7 +322,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -294,7 +294,7 @@ Raises:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -419,7 +419,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -322,7 +322,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -186,7 +186,7 @@ The constructor takes a discovery document in which to look up named schema.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -117,298 +117,287 @@
|
||||
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">'jcgregorio@google.com (Joe Gregorio)'</tt> </tt>
|
||||
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> </tt>
|
||||
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">copy</tt> </tt>
|
||||
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-0', 'oauth2client', 'link-0');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module oauth2client.anyjson=oauth2client.anyjson-module.html"><a title="oauth2client.anyjson" class="py-name" href="#" onclick="return doclink('link-1', 'anyjson', 'link-1');">anyjson</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">simplejson</tt> </tt>
|
||||
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> </tt>
|
||||
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas"></a><div id="Schemas-def"><a name="L68"></a><tt class="py-lineno"> 68</tt> <a class="py-toggle" href="#" id="Schemas-toggle" onclick="return toggle('Schemas');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html">Schemas</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Schemas-expanded"><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-docstring">"""Schemas for an API."""</tt> </tt>
|
||||
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.__init__"></a><div id="Schemas.__init__-def"><a name="L71"></a><tt class="py-lineno"> 71</tt> <a class="py-toggle" href="#" id="Schemas.__init__-toggle" onclick="return toggle('Schemas.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">discovery</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.__init__-expanded"><a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
|
||||
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> discovery: object, Deserialized discovery document from which we pull</tt> </tt>
|
||||
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> out the named schema.</tt> </tt>
|
||||
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">schemas</tt> <tt class="py-op">=</tt> <tt id="link-2" class="py-name" targets="Module apiclient.discovery=apiclient.discovery-module.html"><a title="apiclient.discovery" class="py-name" href="#" onclick="return doclink('link-2', 'discovery', 'link-2');">discovery</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method apiclient.schema.Schemas.get()=apiclient.schema.Schemas-class.html#get,Method oauth2client.appengine.OAuth2Handler.get()=oauth2client.appengine.OAuth2Handler-class.html#get,Method oauth2client.client.MemoryCache.get()=oauth2client.client.MemoryCache-class.html#get,Method oauth2client.client.Storage.get()=oauth2client.client.Storage-class.html#get"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt>
|
||||
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-0', 'oauth2client', 'link-0');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Module oauth2client.util=oauth2client.util-module.html"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-1', 'util', 'link-1');">util</a></tt> </tt>
|
||||
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-2', 'oauth2client', 'link-0');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Module oauth2client.anyjson=oauth2client.anyjson-module.html"><a title="oauth2client.anyjson" class="py-name" href="#" onclick="return doclink('link-3', 'anyjson', 'link-3');">anyjson</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">simplejson</tt> </tt>
|
||||
<a name="Schemas"></a><div id="Schemas-def"><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> </tt>
|
||||
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
|
||||
<a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="Schemas-toggle" onclick="return toggle('Schemas');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html">Schemas</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Schemas-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-docstring">"""Schemas for an API."""</tt> </tt>
|
||||
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.__init__"></a><div id="Schemas.__init__-def"><a name="L73"></a><tt class="py-lineno"> 73</tt> <a class="py-toggle" href="#" id="Schemas.__init__-toggle" onclick="return toggle('Schemas.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">discovery</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.__init__-expanded"><a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
|
||||
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> discovery: object, Deserialized discovery document from which we pull</tt> </tt>
|
||||
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> out the named schema.</tt> </tt>
|
||||
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">schemas</tt> <tt class="py-op">=</tt> <tt id="link-4" class="py-name" targets="Module apiclient.discovery=apiclient.discovery-module.html"><a title="apiclient.discovery" class="py-name" href="#" onclick="return doclink('link-4', 'discovery', 'link-4');">discovery</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method apiclient.schema.Schemas.get()=apiclient.schema.Schemas-class.html#get,Method oauth2client.client.MemoryCache.get()=oauth2client.client.MemoryCache-class.html#get,Method oauth2client.client.Storage.get()=oauth2client.client.Storage-class.html#get"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-3', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'schemas'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt>
|
||||
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-comment"># Cache of pretty printed schemas.</tt> </tt>
|
||||
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
|
||||
</div><a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas._prettyPrintByName"></a><div id="Schemas._prettyPrintByName-def"><a name="L83"></a><tt class="py-lineno"> 83</tt> <a class="py-toggle" href="#" id="Schemas._prettyPrintByName-toggle" onclick="return toggle('Schemas._prettyPrintByName');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#_prettyPrintByName">_prettyPrintByName</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">seen</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">dent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas._prettyPrintByName-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas._prettyPrintByName-expanded"><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype from the schema name.</tt> </tt>
|
||||
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> name: string, Name of schema in the discovery document.</tt> </tt>
|
||||
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> seen: list of string, Names of schema already seen. Used to handle</tt> </tt>
|
||||
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> recursive definitions.</tt> </tt>
|
||||
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">seen</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-name">seen</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> </tt>
|
||||
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">seen</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-comment"># Do not fall into an infinite loop over recursive definitions.</tt> </tt>
|
||||
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'# Object with schema name: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">name</tt> </tt>
|
||||
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-name">seen</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> </tt>
|
||||
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-4" class="py-name" targets="Class apiclient.schema._SchemaToStruct=apiclient.schema._SchemaToStruct-class.html"><a title="apiclient.schema._SchemaToStruct" class="py-name" href="#" onclick="return doclink('link-4', '_SchemaToStruct', 'link-4');">_SchemaToStruct</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">schemas</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
|
||||
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-name">seen</tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method apiclient.schema._SchemaToStruct.to_str()=apiclient.schema._SchemaToStruct-class.html#to_str"><a title="apiclient.schema._SchemaToStruct.to_str" class="py-name" href="#" onclick="return doclink('link-5', 'to_str', 'link-5');">to_str</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method apiclient.schema.Schemas._prettyPrintByName()=apiclient.schema.Schemas-class.html#_prettyPrintByName"><a title="apiclient.schema.Schemas._prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-6', '_prettyPrintByName', 'link-6');">_prettyPrintByName</a></tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> </tt>
|
||||
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-name">seen</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> </tt>
|
||||
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
|
||||
</div><a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.prettyPrintByName"></a><div id="Schemas.prettyPrintByName-def"><a name="L111"></a><tt class="py-lineno">111</tt> <a class="py-toggle" href="#" id="Schemas.prettyPrintByName-toggle" onclick="return toggle('Schemas.prettyPrintByName');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#prettyPrintByName">prettyPrintByName</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.prettyPrintByName-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.prettyPrintByName-expanded"><a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype from the schema name.</tt> </tt>
|
||||
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"> name: string, Name of schema in the discovery document.</tt> </tt>
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-5', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'schemas'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> </tt>
|
||||
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-comment"># Cache of pretty printed schemas.</tt> </tt>
|
||||
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
|
||||
</div><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt>
|
||||
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Function oauth2client.util.positional()=oauth2client.util-module.html#positional"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-6', 'positional', 'link-6');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="Schemas._prettyPrintByName"></a><div id="Schemas._prettyPrintByName-def"><a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="Schemas._prettyPrintByName-toggle" onclick="return toggle('Schemas._prettyPrintByName');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#_prettyPrintByName">_prettyPrintByName</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">seen</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">dent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas._prettyPrintByName-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas._prettyPrintByName-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype from the schema name.</tt> </tt>
|
||||
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> name: string, Name of schema in the discovery document.</tt> </tt>
|
||||
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> seen: list of string, Names of schema already seen. Used to handle</tt> </tt>
|
||||
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> recursive definitions.</tt> </tt>
|
||||
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">seen</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-name">seen</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> </tt>
|
||||
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">seen</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-comment"># Do not fall into an infinite loop over recursive definitions.</tt> </tt>
|
||||
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'# Object with schema name: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">name</tt> </tt>
|
||||
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-name">seen</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> </tt>
|
||||
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-7" class="py-name" targets="Class apiclient.schema._SchemaToStruct=apiclient.schema._SchemaToStruct-class.html"><a title="apiclient.schema._SchemaToStruct" class="py-name" href="#" onclick="return doclink('link-7', '_SchemaToStruct', 'link-7');">_SchemaToStruct</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">schemas</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
|
||||
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-name">seen</tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">=</tt><tt class="py-name">dent</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method apiclient.schema._SchemaToStruct.to_str()=apiclient.schema._SchemaToStruct-class.html#to_str"><a title="apiclient.schema._SchemaToStruct.to_str" class="py-name" href="#" onclick="return doclink('link-8', 'to_str', 'link-8');">to_str</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method apiclient.schema.Schemas._prettyPrintByName()=apiclient.schema.Schemas-class.html#_prettyPrintByName"><a title="apiclient.schema.Schemas._prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-9', '_prettyPrintByName', 'link-9');">_prettyPrintByName</a></tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> </tt>
|
||||
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt class="py-name">seen</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> </tt>
|
||||
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pretty</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
|
||||
</div><a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.prettyPrintByName"></a><div id="Schemas.prettyPrintByName-def"><a name="L114"></a><tt class="py-lineno">114</tt> <a class="py-toggle" href="#" id="Schemas.prettyPrintByName-toggle" onclick="return toggle('Schemas.prettyPrintByName');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#prettyPrintByName">prettyPrintByName</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.prettyPrintByName-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.prettyPrintByName-expanded"><a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype from the schema name.</tt> </tt>
|
||||
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-comment"># Return with trailing comma and newline removed.</tt> </tt>
|
||||
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="apiclient.schema.Schemas._prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-7', '_prettyPrintByName', 'link-6');">_prettyPrintByName</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">seen</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt>
|
||||
</div><a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas._prettyPrintSchema"></a><div id="Schemas._prettyPrintSchema-def"><a name="L124"></a><tt class="py-lineno">124</tt> <a class="py-toggle" href="#" id="Schemas._prettyPrintSchema-toggle" onclick="return toggle('Schemas._prettyPrintSchema');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#_prettyPrintSchema">_prettyPrintSchema</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">,</tt> <tt class="py-param">seen</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">dent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas._prettyPrintSchema-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas._prettyPrintSchema-expanded"><a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype of schema.</tt> </tt>
|
||||
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema.</tt> </tt>
|
||||
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"> seen: list of string, Names of schema already seen. Used to handle</tt> </tt>
|
||||
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> recursive definitions.</tt> </tt>
|
||||
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">seen</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-name">seen</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> </tt>
|
||||
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-8" class="py-name"><a title="apiclient.schema._SchemaToStruct" class="py-name" href="#" onclick="return doclink('link-8', '_SchemaToStruct', 'link-4');">_SchemaToStruct</a></tt><tt class="py-op">(</tt><tt id="link-9" class="py-name" targets="Module apiclient.schema=apiclient.schema-module.html"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-9', 'schema', 'link-9');">schema</a></tt><tt class="py-op">,</tt> <tt class="py-name">seen</tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="apiclient.schema._SchemaToStruct.to_str" class="py-name" href="#" onclick="return doclink('link-10', 'to_str', 'link-5');">to_str</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="apiclient.schema.Schemas._prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-11', '_prettyPrintByName', 'link-6');">_prettyPrintByName</a></tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.prettyPrintSchema"></a><div id="Schemas.prettyPrintSchema-def"><a name="L141"></a><tt class="py-lineno">141</tt> <a class="py-toggle" href="#" id="Schemas.prettyPrintSchema-toggle" onclick="return toggle('Schemas.prettyPrintSchema');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#prettyPrintSchema">prettyPrintSchema</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.prettyPrintSchema-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.prettyPrintSchema-expanded"><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype of schema.</tt> </tt>
|
||||
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema.</tt> </tt>
|
||||
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> <tt class="py-comment"># Return with trailing comma and newline removed.</tt> </tt>
|
||||
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method apiclient.schema.Schemas._prettyPrintSchema()=apiclient.schema.Schemas-class.html#_prettyPrintSchema"><a title="apiclient.schema.Schemas._prettyPrintSchema" class="py-name" href="#" onclick="return doclink('link-12', '_prettyPrintSchema', 'link-12');">_prettyPrintSchema</a></tt><tt class="py-op">(</tt><tt id="link-13" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-13', 'schema', 'link-9');">schema</a></tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt>
|
||||
</div><a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.get"></a><div id="Schemas.get-def"><a name="L154"></a><tt class="py-lineno">154</tt> <a class="py-toggle" href="#" id="Schemas.get-toggle" onclick="return toggle('Schemas.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.get-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.get-expanded"><a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-docstring">"""Get deserialized JSON schema from the schema name.</tt> </tt>
|
||||
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-docstring"> name: string, Schema name.</tt> </tt>
|
||||
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">schemas</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
|
||||
</div></div><a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> </tt>
|
||||
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct"></a><div id="_SchemaToStruct-def"><a name="L163"></a><tt class="py-lineno">163</tt> <a class="py-toggle" href="#" id="_SchemaToStruct-toggle" onclick="return toggle('_SchemaToStruct');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html">_SchemaToStruct</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_SchemaToStruct-expanded"><a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert schema to a prototype object."""</tt> </tt>
|
||||
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.__init__"></a><div id="_SchemaToStruct.__init__-def"><a name="L166"></a><tt class="py-lineno">166</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.__init__-toggle" onclick="return toggle('_SchemaToStruct.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">,</tt> <tt class="py-param">seen</tt><tt class="py-op">,</tt> <tt class="py-param">dent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.__init__-expanded"><a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
|
||||
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema.</tt> </tt>
|
||||
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> seen: list, List of names of schema already seen while parsing. Used to</tt> </tt>
|
||||
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> handle recursive definitions.</tt> </tt>
|
||||
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> dent: int, Initial indentation depth.</tt> </tt>
|
||||
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> <tt class="py-comment"># The result of this parsing kept as list of strings.</tt> </tt>
|
||||
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> </tt>
|
||||
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-comment"># The final value of the parsing.</tt> </tt>
|
||||
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
||||
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> </tt>
|
||||
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-comment"># The parsed JSON schema.</tt> </tt>
|
||||
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-14', 'schema', 'link-9');">schema</a></tt> <tt class="py-op">=</tt> <tt id="link-15" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-15', 'schema', 'link-9');">schema</a></tt> </tt>
|
||||
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> </tt>
|
||||
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt class="py-comment"># Indentation level.</tt> </tt>
|
||||
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">=</tt> <tt class="py-name">dent</tt> </tt>
|
||||
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> </tt>
|
||||
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-comment"># Method that when called returns a prototype object for the schema with</tt> </tt>
|
||||
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-comment"># the given name.</tt> </tt>
|
||||
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">from_cache</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
||||
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> </tt>
|
||||
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> <tt class="py-comment"># List of names of schema already seen while parsing.</tt> </tt>
|
||||
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">seen</tt> <tt class="py-op">=</tt> <tt class="py-name">seen</tt> </tt>
|
||||
</div><a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.emit"></a><div id="_SchemaToStruct.emit-def"><a name="L194"></a><tt class="py-lineno">194</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.emit-toggle" onclick="return toggle('_SchemaToStruct.emit');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#emit">emit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.emit-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.emit-expanded"><a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> <tt class="py-docstring">"""Add text as a line to the output.</tt> </tt>
|
||||
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"><tt class="py-docstring"> text: string, Text to output.</tt> </tt>
|
||||
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">" "</tt> <tt class="py-op">*</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'\n'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.emitBegin"></a><div id="_SchemaToStruct.emitBegin-def"><a name="L202"></a><tt class="py-lineno">202</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.emitBegin-toggle" onclick="return toggle('_SchemaToStruct.emitBegin');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#emitBegin">emitBegin</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.emitBegin-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.emitBegin-expanded"><a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-docstring">"""Add text to the output, but with no line terminator.</tt> </tt>
|
||||
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"><tt class="py-docstring"> text: string, Text to output.</tt> </tt>
|
||||
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">" "</tt> <tt class="py-op">*</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.emitEnd"></a><div id="_SchemaToStruct.emitEnd-def"><a name="L210"></a><tt class="py-lineno">210</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.emitEnd-toggle" onclick="return toggle('_SchemaToStruct.emitEnd');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#emitEnd">emitEnd</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">comment</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.emitEnd-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.emitEnd-expanded"><a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> <tt class="py-docstring">"""Add text and comment to the output with line terminator.</tt> </tt>
|
||||
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"><tt class="py-docstring"> text: string, Text to output.</tt> </tt>
|
||||
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"><tt class="py-docstring"> comment: string, Python comment.</tt> </tt>
|
||||
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">comment</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-name">divider</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">*</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">+</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'# '</tt> </tt>
|
||||
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">comment</tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">x</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> <tt class="py-name">comment</tt> <tt class="py-op">=</tt> <tt class="py-name">divider</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">' # '</tt><tt class="py-op">,</tt> <tt class="py-name">comment</tt><tt class="py-op">,</tt> <tt class="py-string">'\n'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'\n'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.indent"></a><div id="_SchemaToStruct.indent-def"><a name="L226"></a><tt class="py-lineno">226</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.indent-toggle" onclick="return toggle('_SchemaToStruct.indent');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#indent">indent</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.indent-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.indent-expanded"><a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> <tt class="py-docstring">"""Increase indentation level."""</tt> </tt>
|
||||
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
|
||||
</div><a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.undent"></a><div id="_SchemaToStruct.undent-def"><a name="L230"></a><tt class="py-lineno">230</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.undent-toggle" onclick="return toggle('_SchemaToStruct.undent');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#undent">undent</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.undent-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.undent-expanded"><a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"> <tt class="py-docstring">"""Decrease indentation level."""</tt> </tt>
|
||||
<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
|
||||
</div><a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct._to_str_impl"></a><div id="_SchemaToStruct._to_str_impl-def"><a name="L234"></a><tt class="py-lineno">234</tt> <a class="py-toggle" href="#" id="_SchemaToStruct._to_str_impl-toggle" onclick="return toggle('_SchemaToStruct._to_str_impl');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#_to_str_impl">_to_str_impl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct._to_str_impl-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct._to_str_impl-expanded"><a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> <tt class="py-docstring">"""Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema file.</tt> </tt>
|
||||
<a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"> Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-name">stype</tt> <tt class="py-op">=</tt> <tt id="link-16" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-16', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> name: string, Name of schema in the discovery document.</tt> </tt>
|
||||
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-comment"># Return with trailing comma and newline removed.</tt> </tt>
|
||||
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="apiclient.schema.Schemas._prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-10', '_prettyPrintByName', 'link-9');">_prettyPrintByName</a></tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">seen</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt>
|
||||
</div><a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> </tt>
|
||||
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-11', 'positional', 'link-6');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="Schemas._prettyPrintSchema"></a><div id="Schemas._prettyPrintSchema-def"><a name="L128"></a><tt class="py-lineno">128</tt> <a class="py-toggle" href="#" id="Schemas._prettyPrintSchema-toggle" onclick="return toggle('Schemas._prettyPrintSchema');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#_prettyPrintSchema">_prettyPrintSchema</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">,</tt> <tt class="py-param">seen</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">dent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas._prettyPrintSchema-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas._prettyPrintSchema-expanded"><a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype of schema.</tt> </tt>
|
||||
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema.</tt> </tt>
|
||||
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"> seen: list of string, Names of schema already seen. Used to handle</tt> </tt>
|
||||
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> recursive definitions.</tt> </tt>
|
||||
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">seen</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-name">seen</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> </tt>
|
||||
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-12" class="py-name"><a title="apiclient.schema._SchemaToStruct" class="py-name" href="#" onclick="return doclink('link-12', '_SchemaToStruct', 'link-7');">_SchemaToStruct</a></tt><tt class="py-op">(</tt><tt id="link-13" class="py-name" targets="Module apiclient.schema=apiclient.schema-module.html"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-13', 'schema', 'link-13');">schema</a></tt><tt class="py-op">,</tt> <tt class="py-name">seen</tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">=</tt><tt class="py-name">dent</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="apiclient.schema._SchemaToStruct.to_str" class="py-name" href="#" onclick="return doclink('link-14', 'to_str', 'link-8');">to_str</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="apiclient.schema.Schemas._prettyPrintByName" class="py-name" href="#" onclick="return doclink('link-15', '_prettyPrintByName', 'link-9');">_prettyPrintByName</a></tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.prettyPrintSchema"></a><div id="Schemas.prettyPrintSchema-def"><a name="L145"></a><tt class="py-lineno">145</tt> <a class="py-toggle" href="#" id="Schemas.prettyPrintSchema-toggle" onclick="return toggle('Schemas.prettyPrintSchema');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#prettyPrintSchema">prettyPrintSchema</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.prettyPrintSchema-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.prettyPrintSchema-expanded"><a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> <tt class="py-docstring">"""Get pretty printed object prototype of schema.</tt> </tt>
|
||||
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema.</tt> </tt>
|
||||
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-docstring"> string, A string that contains a prototype object with</tt> </tt>
|
||||
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-docstring"> comments that conforms to the given schema.</tt> </tt>
|
||||
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-comment"># Return with trailing comma and newline removed.</tt> </tt>
|
||||
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method apiclient.schema.Schemas._prettyPrintSchema()=apiclient.schema.Schemas-class.html#_prettyPrintSchema"><a title="apiclient.schema.Schemas._prettyPrintSchema" class="py-name" href="#" onclick="return doclink('link-16', '_prettyPrintSchema', 'link-16');">_prettyPrintSchema</a></tt><tt class="py-op">(</tt><tt id="link-17" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-17', 'schema', 'link-13');">schema</a></tt><tt class="py-op">,</tt> <tt class="py-name">dent</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt>
|
||||
</div><a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> </tt>
|
||||
<a name="Schemas.get"></a><div id="Schemas.get-def"><a name="L158"></a><tt class="py-lineno">158</tt> <a class="py-toggle" href="#" id="Schemas.get-toggle" onclick="return toggle('Schemas.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema.Schemas-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="Schemas.get-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Schemas.get-expanded"><a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> <tt class="py-docstring">"""Get deserialized JSON schema from the schema name.</tt> </tt>
|
||||
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-docstring"> name: string, Schema name.</tt> </tt>
|
||||
<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">schemas</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
|
||||
</div></div><a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct"></a><div id="_SchemaToStruct-def"><a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"> </tt>
|
||||
<a name="L167"></a><tt class="py-lineno">167</tt> <a class="py-toggle" href="#" id="_SchemaToStruct-toggle" onclick="return toggle('_SchemaToStruct');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html">_SchemaToStruct</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_SchemaToStruct-expanded"><a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert schema to a prototype object."""</tt> </tt>
|
||||
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"> </tt>
|
||||
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-18', 'positional', 'link-6');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">3</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="_SchemaToStruct.__init__"></a><div id="_SchemaToStruct.__init__-def"><a name="L171"></a><tt class="py-lineno">171</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.__init__-toggle" onclick="return toggle('_SchemaToStruct.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">,</tt> <tt class="py-param">seen</tt><tt class="py-op">,</tt> <tt class="py-param">dent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.__init__-expanded"><a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt>
|
||||
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema.</tt> </tt>
|
||||
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"><tt class="py-docstring"> seen: list, List of names of schema already seen while parsing. Used to</tt> </tt>
|
||||
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-docstring"> handle recursive definitions.</tt> </tt>
|
||||
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-docstring"> dent: int, Initial indentation depth.</tt> </tt>
|
||||
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-comment"># The result of this parsing kept as list of strings.</tt> </tt>
|
||||
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> </tt>
|
||||
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt class="py-comment"># The final value of the parsing.</tt> </tt>
|
||||
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
||||
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> </tt>
|
||||
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-comment"># The parsed JSON schema.</tt> </tt>
|
||||
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-19', 'schema', 'link-13');">schema</a></tt> <tt class="py-op">=</tt> <tt id="link-20" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-20', 'schema', 'link-13');">schema</a></tt> </tt>
|
||||
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> </tt>
|
||||
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-comment"># Indentation level.</tt> </tt>
|
||||
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">=</tt> <tt class="py-name">dent</tt> </tt>
|
||||
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> </tt>
|
||||
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> <tt class="py-comment"># Method that when called returns a prototype object for the schema with</tt> </tt>
|
||||
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> <tt class="py-comment"># the given name.</tt> </tt>
|
||||
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">from_cache</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
||||
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> </tt>
|
||||
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> <tt class="py-comment"># List of names of schema already seen while parsing.</tt> </tt>
|
||||
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">seen</tt> <tt class="py-op">=</tt> <tt class="py-name">seen</tt> </tt>
|
||||
</div><a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.emit"></a><div id="_SchemaToStruct.emit-def"><a name="L199"></a><tt class="py-lineno">199</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.emit-toggle" onclick="return toggle('_SchemaToStruct.emit');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#emit">emit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.emit-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.emit-expanded"><a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> <tt class="py-docstring">"""Add text as a line to the output.</tt> </tt>
|
||||
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"><tt class="py-docstring"> text: string, Text to output.</tt> </tt>
|
||||
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">" "</tt> <tt class="py-op">*</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'\n'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.emitBegin"></a><div id="_SchemaToStruct.emitBegin-def"><a name="L207"></a><tt class="py-lineno">207</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.emitBegin-toggle" onclick="return toggle('_SchemaToStruct.emitBegin');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#emitBegin">emitBegin</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.emitBegin-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.emitBegin-expanded"><a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-docstring">"""Add text to the output, but with no line terminator.</tt> </tt>
|
||||
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"><tt class="py-docstring"> text: string, Text to output.</tt> </tt>
|
||||
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">" "</tt> <tt class="py-op">*</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.emitEnd"></a><div id="_SchemaToStruct.emitEnd-def"><a name="L215"></a><tt class="py-lineno">215</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.emitEnd-toggle" onclick="return toggle('_SchemaToStruct.emitEnd');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#emitEnd">emitEnd</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">comment</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.emitEnd-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.emitEnd-expanded"><a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-docstring">"""Add text and comment to the output with line terminator.</tt> </tt>
|
||||
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"><tt class="py-docstring"> text: string, Text to output.</tt> </tt>
|
||||
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"><tt class="py-docstring"> comment: string, Python comment.</tt> </tt>
|
||||
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">comment</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-name">divider</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">*</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">+</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'# '</tt> </tt>
|
||||
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">comment</tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">x</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"> <tt class="py-name">comment</tt> <tt class="py-op">=</tt> <tt class="py-name">divider</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">' # '</tt><tt class="py-op">,</tt> <tt class="py-name">comment</tt><tt class="py-op">,</tt> <tt class="py-string">'\n'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">text</tt><tt class="py-op">,</tt> <tt class="py-string">'\n'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
</div><a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.indent"></a><div id="_SchemaToStruct.indent-def"><a name="L231"></a><tt class="py-lineno">231</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.indent-toggle" onclick="return toggle('_SchemaToStruct.indent');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#indent">indent</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.indent-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.indent-expanded"><a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-docstring">"""Increase indentation level."""</tt> </tt>
|
||||
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
|
||||
</div><a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.undent"></a><div id="_SchemaToStruct.undent-def"><a name="L235"></a><tt class="py-lineno">235</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.undent-toggle" onclick="return toggle('_SchemaToStruct.undent');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#undent">undent</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.undent-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.undent-expanded"><a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"> <tt class="py-docstring">"""Decrease indentation level."""</tt> </tt>
|
||||
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">dent</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
|
||||
</div><a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct._to_str_impl"></a><div id="_SchemaToStruct._to_str_impl-def"><a name="L239"></a><tt class="py-lineno">239</tt> <a class="py-toggle" href="#" id="_SchemaToStruct._to_str_impl-toggle" onclick="return toggle('_SchemaToStruct._to_str_impl');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#_to_str_impl">_to_str_impl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">schema</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct._to_str_impl-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct._to_str_impl-expanded"><a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"> <tt class="py-docstring">"""Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"><tt class="py-docstring"> schema: object, Parsed JSON schema file.</tt> </tt>
|
||||
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"><tt class="py-docstring"> Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-name">stype</tt> <tt class="py-op">=</tt> <tt id="link-21" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-21', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-17', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'object'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Method apiclient.schema._SchemaToStruct.emitEnd()=apiclient.schema._SchemaToStruct-class.html#emitEnd"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-18', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'{'</tt><tt class="py-op">,</tt> <tt id="link-19" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-19', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-22', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'object'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Method apiclient.schema._SchemaToStruct.emitEnd()=apiclient.schema._SchemaToStruct-class.html#emitEnd"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-23', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'{'</tt><tt class="py-op">,</tt> <tt id="link-24" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-24', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-20', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name" targets="Method apiclient.schema._SchemaToStruct.indent()=apiclient.schema._SchemaToStruct-class.html#indent"><a title="apiclient.schema._SchemaToStruct.indent" class="py-name" href="#" onclick="return doclink('link-21', 'indent', 'link-21');">indent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'properties'</tt> <tt class="py-keyword">in</tt> <tt id="link-22" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-22', 'schema', 'link-9');">schema</a></tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">pname</tt><tt class="py-op">,</tt> <tt class="py-name">pschema</tt> <tt class="py-keyword">in</tt> <tt id="link-23" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-23', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-25', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Method apiclient.schema._SchemaToStruct.indent()=apiclient.schema._SchemaToStruct-class.html#indent"><a title="apiclient.schema._SchemaToStruct.indent" class="py-name" href="#" onclick="return doclink('link-26', 'indent', 'link-26');">indent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'properties'</tt> <tt class="py-keyword">in</tt> <tt id="link-27" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-27', 'schema', 'link-13');">schema</a></tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">pname</tt><tt class="py-op">,</tt> <tt class="py-name">pschema</tt> <tt class="py-keyword">in</tt> <tt id="link-28" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-28', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-24', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'properties'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Method apiclient.schema._SchemaToStruct.emitBegin()=apiclient.schema._SchemaToStruct-class.html#emitBegin"><a title="apiclient.schema._SchemaToStruct.emitBegin" class="py-name" href="#" onclick="return doclink('link-25', 'emitBegin', 'link-25');">emitBegin</a></tt><tt class="py-op">(</tt><tt class="py-string">'"%s": '</tt> <tt class="py-op">%</tt> <tt class="py-name">pname</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Method apiclient.schema._SchemaToStruct._to_str_impl()=apiclient.schema._SchemaToStruct-class.html#_to_str_impl"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-26', '_to_str_impl', 'link-26');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt class="py-name">pschema</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'additionalProperties'</tt> <tt class="py-keyword">in</tt> <tt id="link-27" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-27', 'schema', 'link-9');">schema</a></tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitBegin" class="py-name" href="#" onclick="return doclink('link-28', 'emitBegin', 'link-25');">emitBegin</a></tt><tt class="py-op">(</tt><tt class="py-string">'"a_key": '</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-29', '_to_str_impl', 'link-26');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt id="link-30" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-30', 'schema', 'link-9');">schema</a></tt><tt class="py-op">[</tt><tt class="py-string">'additionalProperties'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Method apiclient.schema._SchemaToStruct.undent()=apiclient.schema._SchemaToStruct-class.html#undent"><a title="apiclient.schema._SchemaToStruct.undent" class="py-name" href="#" onclick="return doclink('link-31', 'undent', 'link-31');">undent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method apiclient.schema._SchemaToStruct.emit()=apiclient.schema._SchemaToStruct-class.html#emit"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-32', 'emit', 'link-32');">emit</a></tt><tt class="py-op">(</tt><tt class="py-string">'},'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'$ref'</tt> <tt class="py-keyword">in</tt> <tt id="link-33" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-33', 'schema', 'link-9');">schema</a></tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> <tt class="py-name">schemaName</tt> <tt class="py-op">=</tt> <tt id="link-34" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-34', 'schema', 'link-9');">schema</a></tt><tt class="py-op">[</tt><tt class="py-string">'$ref'</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"> <tt class="py-name">description</tt> <tt class="py-op">=</tt> <tt id="link-35" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-35', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-29', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'properties'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name" targets="Method apiclient.schema._SchemaToStruct.emitBegin()=apiclient.schema._SchemaToStruct-class.html#emitBegin"><a title="apiclient.schema._SchemaToStruct.emitBegin" class="py-name" href="#" onclick="return doclink('link-30', 'emitBegin', 'link-30');">emitBegin</a></tt><tt class="py-op">(</tt><tt class="py-string">'"%s": '</tt> <tt class="py-op">%</tt> <tt class="py-name">pname</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Method apiclient.schema._SchemaToStruct._to_str_impl()=apiclient.schema._SchemaToStruct-class.html#_to_str_impl"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-31', '_to_str_impl', 'link-31');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt class="py-name">pschema</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'additionalProperties'</tt> <tt class="py-keyword">in</tt> <tt id="link-32" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-32', 'schema', 'link-13');">schema</a></tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitBegin" class="py-name" href="#" onclick="return doclink('link-33', 'emitBegin', 'link-30');">emitBegin</a></tt><tt class="py-op">(</tt><tt class="py-string">'"a_key": '</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-34', '_to_str_impl', 'link-31');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt id="link-35" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-35', 'schema', 'link-13');">schema</a></tt><tt class="py-op">[</tt><tt class="py-string">'additionalProperties'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method apiclient.schema._SchemaToStruct.undent()=apiclient.schema._SchemaToStruct-class.html#undent"><a title="apiclient.schema._SchemaToStruct.undent" class="py-name" href="#" onclick="return doclink('link-36', 'undent', 'link-36');">undent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name" targets="Method apiclient.schema._SchemaToStruct.emit()=apiclient.schema._SchemaToStruct-class.html#emit"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-37', 'emit', 'link-37');">emit</a></tt><tt class="py-op">(</tt><tt class="py-string">'},'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'$ref'</tt> <tt class="py-keyword">in</tt> <tt id="link-38" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-38', 'schema', 'link-13');">schema</a></tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> <tt class="py-name">schemaName</tt> <tt class="py-op">=</tt> <tt id="link-39" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-39', 'schema', 'link-13');">schema</a></tt><tt class="py-op">[</tt><tt class="py-string">'$ref'</tt><tt class="py-op">]</tt> </tt>
|
||||
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> <tt class="py-name">description</tt> <tt class="py-op">=</tt> <tt id="link-40" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-40', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-36', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">from_cache</tt><tt class="py-op">(</tt><tt class="py-name">schemaName</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">seen</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-37', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">description</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-38', 'emit', 'link-32');">emit</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'boolean'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-39" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-39', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-41', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">from_cache</tt><tt class="py-op">(</tt><tt class="py-name">schemaName</tt><tt class="py-op">,</tt> <tt class="py-name">seen</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">seen</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-42', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">description</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-43', 'emit', 'link-37');">emit</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'boolean'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-44" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-44', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-40', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'True or False'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-41', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s,'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-42" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-42', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-45', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'True or False'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-46', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s,'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-47" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-47', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-43', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'string'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-44" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-44', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-48', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'string'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-49" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-49', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-45', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'A String'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-46', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'"%s",'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-47" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-47', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-50', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'A String'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-51', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'"%s",'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-52" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-52', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-48', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'integer'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-49" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-49', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-53', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'integer'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-54" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-54', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-50', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'42'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-51', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s,'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-52" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-52', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-55', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'42'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-56', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s,'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-57" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-57', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-53', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'number'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-54" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-54', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-58', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'number'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt id="link-59" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-59', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-55', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'3.14'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-56', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s,'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-57" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-57', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-60', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'default'</tt><tt class="py-op">,</tt> <tt class="py-string">'3.14'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-61', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s,'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-62" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-62', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-58', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'null'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-59', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'None,'</tt><tt class="py-op">,</tt> <tt id="link-60" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-60', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-63', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'null'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-64', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'None,'</tt><tt class="py-op">,</tt> <tt id="link-65" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-65', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-61', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'any'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-62', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'"",'</tt><tt class="py-op">,</tt> <tt id="link-63" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-63', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-66', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'any'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-67', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'"",'</tt><tt class="py-op">,</tt> <tt id="link-68" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-68', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-64', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'array'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-65', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'['</tt><tt class="py-op">,</tt> <tt id="link-66" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-66', 'schema', 'link-9');">schema</a></tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.appengine.OAuth2Handler.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-69', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">stype</tt> <tt class="py-op">==</tt> <tt class="py-string">'array'</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-70', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">'['</tt><tt class="py-op">,</tt> <tt id="link-71" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-71', 'schema', 'link-13');">schema</a></tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="apiclient.schema.Schemas.get
|
||||
oauth2client.client.MemoryCache.get
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-67', 'get', 'link-3');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="apiclient.schema._SchemaToStruct.indent" class="py-name" href="#" onclick="return doclink('link-68', 'indent', 'link-21');">indent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitBegin" class="py-name" href="#" onclick="return doclink('link-69', 'emitBegin', 'link-25');">emitBegin</a></tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-70', '_to_str_impl', 'link-26');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt id="link-71" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-71', 'schema', 'link-9');">schema</a></tt><tt class="py-op">[</tt><tt class="py-string">'items'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="apiclient.schema._SchemaToStruct.undent" class="py-name" href="#" onclick="return doclink('link-72', 'undent', 'link-31');">undent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-73', 'emit', 'link-32');">emit</a></tt><tt class="py-op">(</tt><tt class="py-string">'],'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-74', 'emit', 'link-32');">emit</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unknown type! %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">stype</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-75', 'emitEnd', 'link-18');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> </tt>
|
||||
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">string</tt> </tt>
|
||||
</div><a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.to_str"></a><div id="_SchemaToStruct.to_str-def"><a name="L294"></a><tt class="py-lineno">294</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.to_str-toggle" onclick="return toggle('_SchemaToStruct.to_str');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#to_str">to_str</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">from_cache</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.to_str-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.to_str-expanded"><a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-docstring">"""Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"><tt class="py-docstring"> from_cache: callable(name, seen), Callable that retrieves an object</tt> </tt>
|
||||
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"><tt class="py-docstring"> prototype for a schema with the given name. Seen is a list of schema</tt> </tt>
|
||||
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"><tt class="py-docstring"> names already seen as we recursively descend the schema definition.</tt> </tt>
|
||||
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-72', 'get', 'link-5');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="apiclient.schema._SchemaToStruct.indent" class="py-name" href="#" onclick="return doclink('link-73', 'indent', 'link-26');">indent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitBegin" class="py-name" href="#" onclick="return doclink('link-74', 'emitBegin', 'link-30');">emitBegin</a></tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-75', '_to_str_impl', 'link-31');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt id="link-76" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-76', 'schema', 'link-13');">schema</a></tt><tt class="py-op">[</tt><tt class="py-string">'items'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="apiclient.schema._SchemaToStruct.undent" class="py-name" href="#" onclick="return doclink('link-77', 'undent', 'link-36');">undent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-78', 'emit', 'link-37');">emit</a></tt><tt class="py-op">(</tt><tt class="py-string">'],'</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
||||
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="apiclient.schema._SchemaToStruct.emit" class="py-name" href="#" onclick="return doclink('link-79', 'emit', 'link-37');">emit</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unknown type! %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">stype</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="apiclient.schema._SchemaToStruct.emitEnd" class="py-name" href="#" onclick="return doclink('link-80', 'emitEnd', 'link-23');">emitEnd</a></tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> </tt>
|
||||
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
|
||||
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">string</tt> </tt>
|
||||
</div><a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> </tt>
|
||||
<a name="_SchemaToStruct.to_str"></a><div id="_SchemaToStruct.to_str-def"><a name="L299"></a><tt class="py-lineno">299</tt> <a class="py-toggle" href="#" id="_SchemaToStruct.to_str-toggle" onclick="return toggle('_SchemaToStruct.to_str');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.schema._SchemaToStruct-class.html#to_str">to_str</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">from_cache</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
||||
</div><div id="_SchemaToStruct.to_str-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_SchemaToStruct.to_str-expanded"><a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-docstring">"""Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"><tt class="py-docstring"> Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"><tt class="py-docstring"> The lines of the code will all be properly indented.</tt> </tt>
|
||||
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">from_cache</tt> <tt class="py-op">=</tt> <tt class="py-name">from_cache</tt> </tt>
|
||||
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-76', '_to_str_impl', 'link-26');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-77', 'schema', 'link-9');">schema</a></tt><tt class="py-op">)</tt> </tt>
|
||||
</div></div><a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> </tt><script type="text/javascript">
|
||||
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
||||
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"><tt class="py-docstring"> from_cache: callable(name, seen), Callable that retrieves an object</tt> </tt>
|
||||
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"><tt class="py-docstring"> prototype for a schema with the given name. Seen is a list of schema</tt> </tt>
|
||||
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"><tt class="py-docstring"> names already seen as we recursively descend the schema definition.</tt> </tt>
|
||||
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
||||
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
||||
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"><tt class="py-docstring"> Prototype object based on the schema, in Python code with comments.</tt> </tt>
|
||||
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"><tt class="py-docstring"> The lines of the code will all be properly indented.</tt> </tt>
|
||||
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
||||
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">from_cache</tt> <tt class="py-op">=</tt> <tt class="py-name">from_cache</tt> </tt>
|
||||
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="apiclient.schema._SchemaToStruct._to_str_impl" class="py-name" href="#" onclick="return doclink('link-81', '_to_str_impl', 'link-31');">_to_str_impl</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name"><a title="apiclient.schema" class="py-name" href="#" onclick="return doclink('link-82', 'schema', 'link-13');">schema</a></tt><tt class="py-op">)</tt> </tt>
|
||||
</div></div><a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"> </tt><script type="text/javascript">
|
||||
<!--
|
||||
expandto(location.href);
|
||||
// -->
|
||||
@@ -438,7 +427,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:32 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:11 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -108,13 +108,11 @@ Schemas for an API.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#_prettyPrintByName" class="summary-sig-name" onclick="show_private();">_prettyPrintByName</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">name</span>,
|
||||
<span class="summary-sig-arg">seen</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">dent</span>=<span class="summary-sig-default">0</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#_prettyPrintByName" class="summary-sig-name" onclick="show_private();">_prettyPrintByName</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Get pretty printed object prototype from the schema name.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintByName">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -146,13 +144,11 @@ Schemas for an API.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#_prettyPrintSchema" class="summary-sig-name" onclick="show_private();">_prettyPrintSchema</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">schema</span>,
|
||||
<span class="summary-sig-arg">seen</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">dent</span>=<span class="summary-sig-default">0</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#_prettyPrintSchema" class="summary-sig-name" onclick="show_private();">_prettyPrintSchema</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Get pretty printed object prototype of schema.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -296,13 +292,11 @@ Args:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintByName</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">name</span>,
|
||||
<span class="sig-arg">seen</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">dent</span>=<span class="sig-default">0</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintByName</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintByName">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -320,6 +314,10 @@ Returns:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(2)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -360,13 +358,11 @@ Returns:
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintSchema</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">schema</span>,
|
||||
<span class="sig-arg">seen</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">dent</span>=<span class="sig-default">0</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintSchema</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -384,6 +380,10 @@ Returns:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(2)</code></li>
|
||||
</ul></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -467,7 +467,7 @@ Args:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -90,13 +90,11 @@ Convert schema to a prototype object.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
||||
<span class="summary-sig-arg">schema</span>,
|
||||
<span class="summary-sig-arg">seen</span>,
|
||||
<span class="summary-sig-arg">dent</span>=<span class="summary-sig-default">0</span>)</span><br />
|
||||
<td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
|
||||
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
||||
Constructor.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.__init__">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -298,14 +296,12 @@ Convert schema to a prototype object.
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
||||
<span class="sig-arg">schema</span>,
|
||||
<span class="sig-arg">seen</span>,
|
||||
<span class="sig-arg">dent</span>=<span class="sig-default">0</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
|
||||
<span class="sig-arg">**kwargs</span>)</span>
|
||||
<br /><em class="fname">(Constructor)</em>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.__init__">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
@@ -320,6 +316,10 @@ Args:
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Decorators:</dt>
|
||||
<dd><ul class="nomargin-top">
|
||||
<li><code>@util.positional(3)</code></li>
|
||||
</ul></dd>
|
||||
<dt>Overrides:
|
||||
object.__init__
|
||||
</dt>
|
||||
@@ -492,7 +492,7 @@ Returns:
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -110,14 +110,6 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.crypt.AppIdentityError-class.html">oauth2client.crypt.AppIdentityError</a></strong>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file.Error-class.html">oauth2client.multistore_file.Error</a></strong>:
|
||||
<em class="summary">Base error for this module.</em>
|
||||
<ul>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file.NewerCredentialStoreError-class.html">oauth2client.multistore_file.NewerCredentialStoreError</a></strong>:
|
||||
<em class="summary">The credential store is a newer version that supported.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.client.Error-class.html">oauth2client.client.Error</a></strong>:
|
||||
<em class="summary">Base error for this module.</em>
|
||||
<ul>
|
||||
@@ -138,11 +130,11 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.clientsecrets.Error-class.html">oauth2client.clientsecrets.Error</a></strong>:
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file.Error-class.html">oauth2client.multistore_file.Error</a></strong>:
|
||||
<em class="summary">Base error for this module.</em>
|
||||
<ul>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.clientsecrets.InvalidClientSecretsError-class.html">oauth2client.clientsecrets.InvalidClientSecretsError</a></strong>:
|
||||
<em class="summary">Format of ClientSecrets file is invalid.</em>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file.NewerCredentialStoreError-class.html">oauth2client.multistore_file.NewerCredentialStoreError</a></strong>:
|
||||
<em class="summary">The credential store is a newer version that supported.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -157,6 +149,9 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.errors.InvalidChunkSizeError-class.html">apiclient.errors.InvalidChunkSizeError</a></strong>:
|
||||
<em class="summary">The given chunksize is not valid.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.errors.InvalidJsonError-class.html">apiclient.errors.InvalidJsonError</a></strong>:
|
||||
<em class="summary">The JSON returned could not be parsed.</em>
|
||||
</li>
|
||||
@@ -183,9 +178,20 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.clientsecrets.Error-class.html">oauth2client.clientsecrets.Error</a></strong>:
|
||||
<em class="summary">Base error for this module.</em>
|
||||
<ul>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.clientsecrets.InvalidClientSecretsError-class.html">oauth2client.clientsecrets.InvalidClientSecretsError</a></strong>:
|
||||
<em class="summary">Format of ClientSecrets file is invalid.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.InvalidClientSecretsError-class.html">oauth2client.appengine.InvalidClientSecretsError</a></strong>:
|
||||
<em class="summary">The client_secrets.json file is malformed or missing required fields.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.InvalidXsrfTokenError-class.html">oauth2client.appengine.InvalidXsrfTokenError</a></strong>:
|
||||
<em class="summary">The XSRF token is invalid or expired.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -208,6 +214,9 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.AppAssertionCredentials-class.html">oauth2client.appengine.AppAssertionCredentials</a></strong>:
|
||||
<em class="summary">Credentials object for App Engine Assertion Grants</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.gce.AppAssertionCredentials-class.html">oauth2client.gce.AppAssertionCredentials</a></strong>:
|
||||
<em class="summary">Credentials object for Compute Engine Assertion Grants</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.client.SignedJwtAssertionCredentials-class.html">oauth2client.client.SignedJwtAssertionCredentials</a></strong>:
|
||||
<em class="summary">Credentials object used for OAuth 2.0 Signed JWT assertion grants.</em>
|
||||
</li>
|
||||
@@ -258,14 +267,16 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http.MediaUpload-class.html">apiclient.http.MediaUpload</a></strong>:
|
||||
<em class="summary">Describes a media object to upload.</em>
|
||||
<ul>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http.MediaIoBaseUpload-class.html">apiclient.http.MediaIoBaseUpload</a></strong>:
|
||||
<em class="summary">A MediaUpload for a io.Base objects.</em>
|
||||
<ul>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http.MediaFileUpload-class.html">apiclient.http.MediaFileUpload</a></strong>:
|
||||
<em class="summary">A MediaUpload for a file.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http.MediaInMemoryUpload-class.html">apiclient.http.MediaInMemoryUpload</a></strong>:
|
||||
<em class="summary">MediaUpload for a chunk of bytes.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http.MediaIoBaseUpload-class.html">apiclient.http.MediaIoBaseUpload</a></strong>:
|
||||
<em class="summary">A MediaUpload for a io.Base objects.</em>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -281,6 +292,9 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.CredentialsModel-class.html">oauth2client.appengine.CredentialsModel</a></strong>:
|
||||
<em class="summary">Storage for OAuth 2.0 Credentials</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.SiteXsrfSecretKey-class.html">oauth2client.appengine.SiteXsrfSecretKey</a></strong>:
|
||||
<em class="summary">Storage for the sites XSRF secret key.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.model.Model-class.html">apiclient.model.Model</a></strong>:
|
||||
@@ -326,14 +340,6 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink">google.appengine.ext.webapp._webapp25.RequestHandler</strong>:
|
||||
<em class="summary">Our base HTTP request handler.</em>
|
||||
<ul>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.OAuth2Handler-class.html">oauth2client.appengine.OAuth2Handler</a></strong>:
|
||||
<em class="summary">Handler for the redirect_uri of the OAuth 2.0 dance.</em>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http.RequestMockBuilder-class.html">apiclient.http.RequestMockBuilder</a></strong>:
|
||||
<em class="summary">A simple mock of HttpRequest</em>
|
||||
</li>
|
||||
@@ -349,13 +355,13 @@ contains some hooks for decoding encoded and multipart messages.</em>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.keyring_storage.Storage-class.html">oauth2client.keyring_storage.Storage</a></strong>:
|
||||
<em class="summary">Store and retrieve a single credential to and from the keyring.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.file.Storage-class.html">oauth2client.file.Storage</a></strong>:
|
||||
<em class="summary">Store and retrieve a single credential to and from a file.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.django_orm.Storage-class.html">oauth2client.django_orm.Storage</a></strong>:
|
||||
<em class="summary">Store and retrieve a single credential to and from
|
||||
the datastore.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.file.Storage-class.html">oauth2client.file.Storage</a></strong>:
|
||||
<em class="summary">Store and retrieve a single credential to and from a file.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.appengine.StorageByKeyName-class.html">oauth2client.appengine.StorageByKeyName</a></strong>:
|
||||
<em class="summary">Store and retrieve a single credential to and from
|
||||
the App Engine datastore.</em>
|
||||
@@ -385,6 +391,9 @@ the App Engine datastore.</em>
|
||||
<li> <strong class="uidlink"><a href="apiclient.schema._SchemaToStruct-class.html" onclick="show_private();">apiclient.schema._SchemaToStruct</a></strong>:
|
||||
<em class="summary">Convert schema to a prototype object.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink"><a href="apiclient.http._StreamSlice-class.html" onclick="show_private();">apiclient.http._StreamSlice</a></strong>:
|
||||
<em class="summary">Truncated stream.</em>
|
||||
</li>
|
||||
<li> <strong class="uidlink">type</strong>:
|
||||
<em class="summary">type(object) -> the object's type...</em>
|
||||
<ul>
|
||||
@@ -422,7 +431,7 @@ the App Engine datastore.</em>
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:01:59 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
BIN
docs/epy/class_hierarchy_for__streamsli.gif
Normal file
|
After Width: | Height: | Size: 828 B |
BIN
docs/epy/class_hierarchy_for_appasserti_2.gif
Normal file
|
After Width: | Height: | Size: 4.0 KiB |
|
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 6.6 KiB |
|
Before Width: | Height: | Size: 6.2 KiB After Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 16 KiB |
BIN
docs/epy/class_hierarchy_for_invalidchu.gif
Normal file
|
After Width: | Height: | Size: 3.4 KiB |
BIN
docs/epy/class_hierarchy_for_invalidxsr.gif
Normal file
|
After Width: | Height: | Size: 3.0 KiB |
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 2.7 KiB |
|
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 2.9 KiB |
|
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.5 KiB |
|
Before Width: | Height: | Size: 6.4 KiB After Width: | Height: | Size: 7.5 KiB |
BIN
docs/epy/class_hierarchy_for_sitexsrfse.gif
Normal file
|
After Width: | Height: | Size: 2.5 KiB |
@@ -276,7 +276,7 @@ a new object with type S, a subtype of T
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -294,7 +294,7 @@ the object's type
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -240,7 +240,7 @@ page was last updated. </p>
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:01:59 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -355,7 +355,7 @@ Initialize the class instance and read the headers.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:27 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -78,11 +78,13 @@
|
||||
<li> <strong class="uidlink"><a href="oauth2client.crypt-module.html">oauth2client.crypt</a></strong> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.django_orm-module.html">oauth2client.django_orm</a></strong>: <em class="summary">OAuth 2.0 utilities for Django.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.file-module.html">oauth2client.file</a></strong>: <em class="summary">Utilities for OAuth.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.gce-module.html">oauth2client.gce</a></strong>: <em class="summary">Utilities for Google Compute Engine</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.keyring_storage-module.html">oauth2client.keyring_storage</a></strong>: <em class="summary">A keyring based Storage.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.locked_file-module.html">oauth2client.locked_file</a></strong>: <em class="summary">Locked file interface that should work on Unix and Windows pythons.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file-module.html">oauth2client.multistore_file</a></strong>: <em class="summary">Multi-credential file store with lock support.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.tools-module.html">oauth2client.tools</a></strong>: <em class="summary">Command-line tools for authenticating via OAuth 2.0</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.util-module.html">oauth2client.util</a></strong>: <em class="summary">Common utility library.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.xsrfutil-module.html">oauth2client.xsrfutil</a></strong>: <em class="summary">Helper methods for creating & verifying XSRF tokens.</em> </li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -109,7 +111,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:01:59 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -82,11 +82,13 @@
|
||||
<li> <strong class="uidlink"><a href="oauth2client.crypt-module.html">oauth2client.crypt</a></strong> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.django_orm-module.html">oauth2client.django_orm</a></strong>: <em class="summary">OAuth 2.0 utilities for Django.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.file-module.html">oauth2client.file</a></strong>: <em class="summary">Utilities for OAuth.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.gce-module.html">oauth2client.gce</a></strong>: <em class="summary">Utilities for Google Compute Engine</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.keyring_storage-module.html">oauth2client.keyring_storage</a></strong>: <em class="summary">A keyring based Storage.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.locked_file-module.html">oauth2client.locked_file</a></strong>: <em class="summary">Locked file interface that should work on Unix and Windows pythons.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.multistore_file-module.html">oauth2client.multistore_file</a></strong>: <em class="summary">Multi-credential file store with lock support.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.tools-module.html">oauth2client.tools</a></strong>: <em class="summary">Command-line tools for authenticating via OAuth 2.0</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.util-module.html">oauth2client.util</a></strong>: <em class="summary">Common utility library.</em> </li>
|
||||
<li> <strong class="uidlink"><a href="oauth2client.xsrfutil-module.html">oauth2client.xsrfutil</a></strong>: <em class="summary">Helper methods for creating & verifying XSRF tokens.</em> </li>
|
||||
</ul></td></tr>
|
||||
</table>
|
||||
|
||||
@@ -139,7 +141,7 @@
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -83,7 +83,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:32 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:10 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -113,7 +113,7 @@ we get a simplejson module from.
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -115,7 +115,7 @@ expandto(location.href);
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:31 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:10 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||
@@ -89,6 +89,22 @@ Utilities for making it easier to use OAuth 2.0 on Google App Engine.
|
||||
The client_secrets.json file is malformed or missing required fields.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="oauth2client.appengine.InvalidXsrfTokenError-class.html" class="summary-name">InvalidXsrfTokenError</a><br />
|
||||
The XSRF token is invalid or expired.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="oauth2client.appengine.SiteXsrfSecretKey-class.html" class="summary-name">SiteXsrfSecretKey</a><br />
|
||||
Storage for the sites XSRF secret key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
@@ -146,14 +162,6 @@ the App Engine datastore.
|
||||
An OAuth2Decorator that builds from a clientsecrets file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="oauth2client.appengine.OAuth2Handler-class.html" class="summary-name">OAuth2Handler</a><br />
|
||||
Handler for the redirect_uri of the OAuth 2.0 dance.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!-- ==================== FUNCTIONS ==================== -->
|
||||
<a name="section-Functions"></a>
|
||||
@@ -172,19 +180,16 @@ the App Engine datastore.
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="oauth2client.appengine-module.html#oauth2decorator_from_clientsecrets" class="summary-sig-name">oauth2decorator_from_clientsecrets</a>(<span class="summary-sig-arg">filename</span>,
|
||||
<span class="summary-sig-arg">scope</span>,
|
||||
<span class="summary-sig-arg">message</span>=<span class="summary-sig-default">None</span>,
|
||||
<span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>)</span><br />
|
||||
Creates an OAuth2Decorator populated from a clientsecrets file.</td>
|
||||
<td><span class="summary-sig"><a name="_generate_new_xsrf_secret_key"></a><span class="summary-sig-name">_generate_new_xsrf_secret_key</span>()</span><br />
|
||||
Returns a random XSRF secret key.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="oauth2client.appengine-pysrc.html#oauth2decorator_from_clientsecrets">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.appengine-pysrc.html#_generate_new_xsrf_secret_key">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -198,9 +203,46 @@ the App Engine datastore.
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a name="main"></a><span class="summary-sig-name">main</span>()</span></td>
|
||||
<td><span class="summary-sig"><a href="oauth2client.appengine-module.html#xsrf_secret_key" class="summary-sig-name">xsrf_secret_key</a>()</span><br />
|
||||
Return the secret key for use for XSRF protection.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="oauth2client.appengine-pysrc.html#main">source code</a></span>
|
||||
<span class="codelink"><a href="oauth2client.appengine-pysrc.html#xsrf_secret_key">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="oauth2client.appengine-module.html#_build_state_value" class="summary-sig-name" onclick="show_private();">_build_state_value</a>(<span class="summary-sig-arg">request_handler</span>,
|
||||
<span class="summary-sig-arg">user</span>)</span><br />
|
||||
Composes the value for the 'state' parameter.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="oauth2client.appengine-pysrc.html#_build_state_value">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="private">
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td><span class="summary-sig"><a href="oauth2client.appengine-module.html#_parse_state_value" class="summary-sig-name" onclick="show_private();">_parse_state_value</a>(<span class="summary-sig-arg">state</span>,
|
||||
<span class="summary-sig-arg">user</span>)</span><br />
|
||||
Parse the value of the 'state' parameter.</td>
|
||||
<td align="right" valign="top">
|
||||
<span class="codelink"><a href="oauth2client.appengine-pysrc.html#_parse_state_value">source code</a></span>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@@ -244,7 +286,7 @@ the App Engine datastore.
|
||||
<td width="15%" align="right" valign="top" class="summary">
|
||||
<span class="summary-type"> </span>
|
||||
</td><td class="summary">
|
||||
<a href="oauth2client.appengine-module.html#application" class="summary-name">application</a> = <code title="webapp.WSGIApplication([('/oauth2callback', OAuth2Handler)])">webapp.WSGIApplication([('/oauth2callback', OAut<code class="variable-ellipsis">...</code></code>
|
||||
<a name="XSRF_MEMCACHE_ID"></a><span class="summary-name">XSRF_MEMCACHE_ID</span> = <code title="'xsrf_secret_key'"><code class="variable-quote">'</code><code class="variable-string">xsrf_secret_key</code><code class="variable-quote">'</code></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -273,78 +315,99 @@ the App Engine datastore.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="oauth2decorator_from_clientsecrets"></a>
|
||||
<a name="xsrf_secret_key"></a>
|
||||
<div>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">oauth2decorator_from_clientsecrets</span>(<span class="sig-arg">filename</span>,
|
||||
<span class="sig-arg">scope</span>,
|
||||
<span class="sig-arg">message</span>=<span class="sig-default">None</span>,
|
||||
<span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">xsrf_secret_key</span>()</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="oauth2client.appengine-pysrc.html#oauth2decorator_from_clientsecrets">source code</a></span>
|
||||
><span class="codelink"><a href="oauth2client.appengine-pysrc.html#xsrf_secret_key">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Creates an OAuth2Decorator populated from a clientsecrets file.
|
||||
Return the secret key for use for XSRF protection.
|
||||
|
||||
Args:
|
||||
filename: string, File name of client secrets.
|
||||
scope: string or list of strings, scope(s) of the credentials being
|
||||
requested.
|
||||
message: string, A friendly string to display to the user if the
|
||||
clientsecrets file is missing or invalid. The message may contain HTML and
|
||||
will be presented on the web interface for any method that uses the
|
||||
decorator.
|
||||
cache: An optional cache service client that implements get() and set()
|
||||
methods. See clientsecrets.loadfile() for details.
|
||||
If the Site entity does not have a secret key, this method will also create
|
||||
one and persist it.
|
||||
|
||||
Returns: An OAuth2Decorator
|
||||
Returns:
|
||||
The secret key.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<br />
|
||||
<!-- ==================== VARIABLES DETAILS ==================== -->
|
||||
<a name="section-VariablesDetails"></a>
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr bgcolor="#70b0f0" class="table-header">
|
||||
<td colspan="2" class="table-header">
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||||
<tr valign="top">
|
||||
<td align="left"><span class="table-header">Variables Details</span></td>
|
||||
<td align="right" valign="top"
|
||||
><span class="options">[<a href="#section-VariablesDetails"
|
||||
class="privatelink" onclick="toggle_private();"
|
||||
>hide private</a>]</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="application"></a>
|
||||
<div>
|
||||
<a name="_build_state_value"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<h3 class="epydoc">application</h3>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_build_state_value</span>(<span class="sig-arg">request_handler</span>,
|
||||
<span class="sig-arg">user</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="oauth2client.appengine-pysrc.html#_build_state_value">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Composes the value for the 'state' parameter.
|
||||
|
||||
Packs the current request URI and an XSRF token into an opaque string that
|
||||
can be passed to the authentication server via the 'state' parameter.
|
||||
|
||||
Args:
|
||||
request_handler: webapp.RequestHandler, The request.
|
||||
user: google.appengine.api.users.User, The current user.
|
||||
|
||||
Returns:
|
||||
The state value as a string.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
<a name="_parse_state_value"></a>
|
||||
<div class="private">
|
||||
<table class="details" border="1" cellpadding="3"
|
||||
cellspacing="0" width="100%" bgcolor="white">
|
||||
<tr><td>
|
||||
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr valign="top"><td>
|
||||
<h3 class="epydoc"><span class="sig"><span class="sig-name">_parse_state_value</span>(<span class="sig-arg">state</span>,
|
||||
<span class="sig-arg">user</span>)</span>
|
||||
</h3>
|
||||
</td><td align="right" valign="top"
|
||||
><span class="codelink"><a href="oauth2client.appengine-pysrc.html#_parse_state_value">source code</a></span>
|
||||
</td>
|
||||
</tr></table>
|
||||
|
||||
<pre class="literalblock">
|
||||
Parse the value of the 'state' parameter.
|
||||
|
||||
Parses the value and validates the XSRF token in the state parameter.
|
||||
|
||||
Args:
|
||||
state: string, The value of the state parameter.
|
||||
user: google.appengine.api.users.User, The current user.
|
||||
|
||||
Raises:
|
||||
InvalidXsrfTokenError: if the XSRF token is invalid.
|
||||
|
||||
Returns:
|
||||
The redirect URI.
|
||||
|
||||
</pre>
|
||||
<dl class="fields">
|
||||
<dt>Value:</dt>
|
||||
<dd><table><tr><td><pre class="variable">
|
||||
webapp.WSGIApplication([('/oauth2callback', OAuth2Handler)])
|
||||
</pre></td></tr></table>
|
||||
</dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</div>
|
||||
@@ -372,7 +435,7 @@ webapp.WSGIApplication([('/oauth2callback', OAuth2Handler)])
|
||||
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
||||
<tr>
|
||||
<td align="left" class="footer">
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:25 2012
|
||||
Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:00 2012
|
||||
</td>
|
||||
<td align="right" class="footer">
|
||||
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
||||
|
||||