Refresh docs

This commit is contained in:
Joe Gregorio
2013-01-24 16:19:07 -05:00
parent e2233cd7a2
commit 52a5c53138
368 changed files with 18038 additions and 8093 deletions

View File

@@ -278,7 +278,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -119,7 +119,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -126,7 +126,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -159,7 +159,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -127,7 +127,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -158,7 +158,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -160,7 +160,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -118,7 +118,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -120,7 +120,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -127,7 +127,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -235,7 +235,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -165,7 +165,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -160,7 +160,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -176,7 +176,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -162,7 +162,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -169,7 +169,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -119,7 +119,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -119,7 +119,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -126,7 +126,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -233,7 +233,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -164,7 +164,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -158,7 +158,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -160,7 +160,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -167,7 +167,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -118,7 +118,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -143,7 +143,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -122,13 +122,13 @@ Returns:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -138,7 +138,7 @@ Returns:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -147,8 +147,8 @@ Returns:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -178,13 +178,13 @@ Returns:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -194,7 +194,7 @@ Returns:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -203,8 +203,8 @@ Returns:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -251,13 +251,13 @@ Args:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -267,7 +267,7 @@ Args:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -276,8 +276,8 @@ Args:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -298,13 +298,13 @@ Returns:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -314,7 +314,7 @@ Returns:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -323,8 +323,8 @@ Returns:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -359,13 +359,13 @@ Returns:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -375,7 +375,7 @@ Returns:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -384,8 +384,8 @@ Returns:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -407,7 +407,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -432,13 +432,13 @@ Args:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -448,7 +448,7 @@ Args:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -457,8 +457,8 @@ Args:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -479,13 +479,13 @@ Returns:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -495,7 +495,7 @@ Returns:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -504,8 +504,8 @@ Returns:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -533,13 +533,13 @@ Args:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -549,7 +549,7 @@ Args:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -558,8 +558,8 @@ Args:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
@@ -580,13 +580,13 @@ Returns:
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
@@ -596,7 +596,7 @@ Returns:
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
@@ -605,8 +605,8 @@ Returns:
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},

View File

@@ -141,7 +141,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -200,7 +200,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -168,7 +168,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -118,6 +118,7 @@ Returns:
"href": "A String", # Link to the web property to which this profile belongs.
"type": "analytics#webproperty", # Value is "analytics#webproperty".
},
"type": "A String", # Profile type. Supported types: WEB or APP.
"id": "A String", # Profile ID.
"selfLink": "A String", # Link for this profile.
"accountId": "A String", # Account ID to which this profile belongs.

View File

@@ -258,7 +258,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -202,6 +202,7 @@ Returns:
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -391,6 +392,7 @@ Args:
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -528,6 +530,7 @@ Returns:
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -689,6 +692,7 @@ Returns:
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
"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.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -742,7 +746,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -764,6 +768,7 @@ Args:
},
"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.
"preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
}

View File

@@ -121,7 +121,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -272,7 +272,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -184,7 +184,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -502,7 +502,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -151,39 +151,7 @@ Returns:
},
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"volumeInfo": { # General volume information.
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
@@ -226,8 +194,51 @@ Returns:
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"layerId": "A String", # The layer id of this layer (e.g. "geo").
},
],
},
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
},
],
"kind": "books#volumes", # Resource type.

View File

@@ -168,7 +168,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -117,6 +117,7 @@ Returns:
],
"contentVersion": "A String", # The content version this resource is for.
"layerId": "A String", # The layer id for this summary.
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"annotationsDataLink": "A String", # Link to get data for this annotation.
"selfLink": "A String", # URL to this resource.
}</pre>
@@ -152,6 +153,7 @@ Returns:
],
"contentVersion": "A String", # The content version this resource is for.
"layerId": "A String", # The layer id for this summary.
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"annotationsDataLink": "A String", # Link to get data for this annotation.
"selfLink": "A String", # URL to this resource.
},

View File

@@ -78,7 +78,7 @@ h1, h2, h3 {
<code><a href="#get">get(volumeId, layerId, annotationId, source=None, locale=None)</a></code></p>
<p class="firstline">Gets the volume annotation.</p>
<p class="toc_element">
<code><a href="#list">list(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)</a></code></p>
<code><a href="#list">list(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, volumeAnnotationsVersion=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)</a></code></p>
<p class="firstline">Gets the volume annotations for a volume and layer.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -139,7 +139,7 @@ Returns:
</div>
<div class="method">
<code class="details" id="list">list(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)</code>
<code class="details" id="list">list(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, volumeAnnotationsVersion=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)</code>
<pre>Gets the volume annotations for a volume and layer.
Args:
@@ -149,6 +149,7 @@ Args:
endPosition: string, The end position to end retrieving data from.
locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
startOffset: string, The start offset to start retrieving data from.
volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting.
pageToken: string, The value of the nextToken from the previous page.
updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
endOffset: string, The end offset to end retrieving data from.
@@ -204,6 +205,7 @@ Returns:
},
],
"kind": "books#volumeannotations", # Resource type
"version": "A String", # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
"totalItems": 42, # The total number of volume annotations found.
}</pre>
</div>
@@ -219,7 +221,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -237,39 +237,7 @@ Returns:
},
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"volumeInfo": { # General volume information.
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
@@ -312,8 +280,51 @@ Returns:
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"layerId": "A String", # The layer id of this layer (e.g. "geo").
},
],
},
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
},
],
"kind": "books#volumes", # Resource type.

View File

@@ -411,7 +411,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -156,39 +156,7 @@ Returns:
},
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"volumeInfo": { # General volume information.
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
@@ -231,8 +199,51 @@ Returns:
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"layerId": "A String", # The layer id of this layer (e.g. "geo").
},
],
},
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
},
],
"kind": "books#volumes", # Resource type.

View File

@@ -78,7 +78,7 @@ h1, h2, h3 {
<code><a href="#get">get(volumeId, source=None, contentVersion=None)</a></code></p>
<p class="firstline">Retrieves my reading position information for a volume.</p>
<p class="toc_element">
<code><a href="#setPosition">setPosition(volumeId, timestamp, position, source=None, contentVersion=None, action=None)</a></code></p>
<code><a href="#setPosition">setPosition(volumeId, timestamp, position, deviceCookie=None, source=None, contentVersion=None, action=None)</a></code></p>
<p class="firstline">Sets my reading position information for a volume.</p>
<h3>Method Details</h3>
<div class="method">
@@ -105,13 +105,14 @@ Returns:
</div>
<div class="method">
<code class="details" id="setPosition">setPosition(volumeId, timestamp, position, source=None, contentVersion=None, action=None)</code>
<code class="details" id="setPosition">setPosition(volumeId, timestamp, position, deviceCookie=None, source=None, contentVersion=None, action=None)</code>
<pre>Sets my reading position information for a volume.
Args:
volumeId: string, ID of volume for which to update the reading position. (required)
timestamp: string, RFC 3339 UTC format timestamp associated with this reading position. (required)
position: string, Position string for the new volume reading position. (required)
deviceCookie: string, Random persistent device cookie optional on set position.
source: string, String to identify the originator of this request.
contentVersion: string, Volume content version for which this reading position applies.
action: string, Action that caused this reading position to be set.

View File

@@ -152,39 +152,7 @@ Returns:
},
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"volumeInfo": { # General volume information.
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
@@ -227,8 +195,51 @@ Returns:
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"layerId": "A String", # The layer id of this layer (e.g. "geo").
},
],
},
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
},
],
"kind": "books#volumes", # Resource type.

View File

@@ -79,6 +79,11 @@ h1, h2, h3 {
</p>
<p class="firstline">Returns the associated Resource.</p>
<p class="toc_element">
<code><a href="books_v1.volumes.recommended.html">recommended()</a></code>
</p>
<p class="firstline">Returns the recommended Resource.</p>
<p class="toc_element">
<code><a href="#get">get(volumeId, projection=None, source=None, country=None, partner=None)</a></code></p>
<p class="firstline">Gets volume information for a single volume.</p>
@@ -158,39 +163,7 @@ Returns:
},
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"volumeInfo": { # General volume information.
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
@@ -233,8 +206,51 @@ Returns:
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"layerId": "A String", # The layer id of this layer (e.g. "geo").
},
],
},
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
}</pre>
</div>
@@ -339,39 +355,7 @@ Returns:
},
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"volumeInfo": { # General volume information.
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
@@ -414,8 +398,51 @@ Returns:
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"layerId": "A String", # The layer id of this layer (e.g. "geo").
},
],
},
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
},
],
"kind": "books#volumes", # Resource type.

View File

@@ -0,0 +1,244 @@
<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="books_v1.html">Books API</a> . <a href="books_v1.volumes.html">volumes</a> . <a href="books_v1.volumes.recommended.html">recommended</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(source=None, locale=None)</a></code></p>
<p class="firstline">Return a list of recommended books for the current user.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(source=None, locale=None)</code>
<pre>Return a list of recommended books for the current user.
Args:
source: string, String to identify the originator of this request.
locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
Returns:
An object of the form:
{
"totalItems": 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
"items": [ # A list of volumes.
{
"kind": "books#volume", # Resource type for a volume. (In LITE projection.)
"accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
"webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
"publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
"embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
"downloadAccess": { # Information about a volume's download license access restrictions.
"nonce": "A String", # Client nonce for verification. Download access and client-validation only.
"kind": "books#downloadAccessRestriction", # Resource type.
"justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
"maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
"downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
"signature": "A String", # Response signature.
"volumeId": "A String", # Identifies the volume for which this entry applies.
"deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
"source": "A String", # Client app identifier for verification. Download access and client-validation only.
"restricted": True or False, # Whether this volume has any download access restrictions.
"reasonCode": "A String", # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
"message": "A String", # Error/warning message.
},
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
"pdf": { # Information about pdf content. (In LITE projection.)
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
"downloadLink": "A String", # URL to download pdf. (In LITE projection.)
"acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
},
"viewability": "A String", # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.
"epub": { # Information about epub content. (In LITE projection.)
"isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
"downloadLink": "A String", # URL to download epub. (In LITE projection.)
"acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
},
"accessViewStatus": "A String", # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)
},
"searchInfo": { # Search result information related to this volume.
"textSnippet": "A String", # A text snippet containing the search query.
},
"saleInfo": { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
"country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
"retailPrice": { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
},
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
"onSaleDate": "A String", # The date on which this book is available for sale.
"listPrice": { # Suggested retail price. (In LITE projection.)
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
},
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"volumeInfo": { # General volume information.
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"pageCount": 42, # Total number of pages.
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
"large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
"extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
},
"publishedDate": "A String", # Date of publication. (In LITE projection.)
"previewLink": "A String", # URL to preview this volume on the Google Books site.
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"ratingsCount": 42, # The number of review ratings for this volume.
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
"dimensions": { # Physical dimensions of this volume.
"width": "A String", # Width of this volume (in cm).
"thickness": "A String", # Thickness of this volume (in cm).
"height": "A String", # Height or length of this volume (in cm).
},
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
"industryIdentifiers": [ # Industry standard identifiers for this volume.
{
"identifier": "A String", # Industry specific volume identifier.
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
},
],
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
"A String",
],
"title": "A String", # Volume title. (In LITE projection.)
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
"A String",
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
"layerId": "A String", # The layer id of this layer (e.g. "geo").
},
],
},
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"review": { # This user's review of this volume, if one exists.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"kind": "books#review", # Resource type for a review.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"title": "A String", # Title for this review.
"volumeId": "A String", # Volume that this review is for.
"content": "A String", # Review text.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
"description": "A String", # Name of the source.
},
"date": "A String", # Date of this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
},
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"kind": "books#readingPosition", # Resource type for a reading position.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
"pdfPosition": "A String", # Position in a PDF file.
"gbTextPosition": "A String", # Position in a volume for text-based content.
},
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
},
},
],
"kind": "books#volumes", # Resource type.
}</pre>
</div>
</body></html>

View File

@@ -184,7 +184,7 @@ Args:
"id": "A String", # Identifier of the calendar.
}
colorRgbFormat: boolean, Whether to use the 'frontendColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'color' field will be set to the best matching option automatically. Optional. The default is False.
colorRgbFormat: boolean, Whether to use the 'foregroundColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'colorId' field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
@@ -287,7 +287,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -329,7 +329,7 @@ Args:
"id": "A String", # Identifier of the calendar.
}
colorRgbFormat: boolean, Whether to use the 'frontendColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'color' field will be set to the best matching option automatically. Optional. The default is False.
colorRgbFormat: boolean, Whether to use the 'foregroundColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'colorId' field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:
@@ -404,7 +404,7 @@ Args:
"id": "A String", # Identifier of the calendar.
}
colorRgbFormat: boolean, Whether to use the 'frontendColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'color' field will be set to the best matching option automatically. Optional. The default is False.
colorRgbFormat: boolean, Whether to use the 'foregroundColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'colorId' field will be set to the best matching option automatically. Optional. The default is False.
Returns:
An object of the form:

View File

@@ -87,7 +87,7 @@ h1, h2, h3 {
<code><a href="#insert">insert(calendarId, body, sendNotifications=None, maxAttendees=None)</a></code></p>
<p class="firstline">Creates an event.</p>
<p class="toc_element">
<code><a href="#instances">instances(calendarId, eventId, pageToken=None, alwaysIncludeEmail=None, maxResults=None, showDeleted=None, timeZone=None, originalStart=None, maxAttendees=None)</a></code></p>
<code><a href="#instances">instances(calendarId, eventId, timeMin=None, pageToken=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</a></code></p>
<p class="firstline">Returns instances of the specified recurring event.</p>
<p class="toc_element">
<code><a href="#instances_next">instances_next(previous_request, previous_response)</a></code></p>
@@ -763,19 +763,21 @@ Returns:
</div>
<div class="method">
<code class="details" id="instances">instances(calendarId, eventId, pageToken=None, alwaysIncludeEmail=None, maxResults=None, showDeleted=None, timeZone=None, originalStart=None, maxAttendees=None)</code>
<code class="details" id="instances">instances(calendarId, eventId, timeMin=None, pageToken=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)</code>
<pre>Returns instances of the specified recurring event.
Args:
calendarId: string, Calendar identifier. (required)
eventId: string, Recurring event identifier. (required)
timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
pageToken: string, Token specifying which result page to return. Optional.
alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
maxResults: integer, Maximum number of events returned on one result page. Optional.
showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
maxResults: integer, Maximum number of events returned on one result page. Optional.
timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
originalStart: string, The original start time of the instance in the result. Optional.
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
Returns:
An object of the form:
@@ -937,7 +939,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -1124,7 +1126,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -145,6 +145,7 @@ Returns:
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
},
],
"kind": "civicinfo#voterInfoResponse", # The kind, fixed to "civicinfo#voterInfoResponse".
@@ -208,6 +209,7 @@ Returns:
},
},
"name": "A String", # The name of the jurisdiction.
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
},
],
"election": { # Information about the election that was queried. # The election that was queried.
@@ -238,6 +240,7 @@ Returns:
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
},
],
"contests": [ # Contests that will appear on the voter's ballot
@@ -281,6 +284,7 @@ Returns:
"referendumUrl": "A String", # A link the referendum. This field is only populated for contests of type 'Referendum'.
"electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
"referendumTitle": "A String", # The title of the referendum. (e.g. 'Proposition 42') This field is only populated for contests of type 'Referendum'.
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
"special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
},
],

View File

@@ -0,0 +1,272 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.disks.html">disks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, disk)</a></code></p>
<p class="firstline">Deletes the specified persistent disk resource.</p>
<p class="toc_element">
<code><a href="#get">get(project, disk)</a></code></p>
<p class="firstline">Returns the specified persistent disk resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a persistent disk resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of persistent disk resources contained within the specified project.</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="delete">delete(project, disk)</code>
<pre>Deletes the specified persistent disk resource.
Args:
project: string, Name of the project scoping this request. (required)
disk: string, Name of the persistent disk resource to delete. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, disk)</code>
<pre>Returns the specified persistent disk resource.
Args:
project: string, Name of the project scoping this request. (required)
disk: string, Name of the persistent disk resource to return. (required)
Returns:
An object of the form:
{
"status": "A String", # The status of disk creation (output only).
"sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
"kind": "compute#disk", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sizeGb": "A String", # Size of the persistent disk, specified in GB.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
"zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"options": "A String", # Internal use only.
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
<pre>Creates a persistent disk resource in the specified project using the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # The status of disk creation (output only).
"sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
"kind": "compute#disk", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sizeGb": "A String", # Size of the persistent disk, specified in GB.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
"zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"options": "A String", # Internal use only.
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of persistent disk resources contained within the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The persistent disk resources.
{
"status": "A String", # The status of disk creation (output only).
"sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
"kind": "compute#disk", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sizeGb": "A String", # Size of the persistent disk, specified in GB.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
"zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"options": "A String", # Internal use only.
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
},
],
"kind": "compute#diskList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,463 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.firewalls.html">firewalls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, firewall)</a></code></p>
<p class="firstline">Deletes the specified firewall resource.</p>
<p class="toc_element">
<code><a href="#get">get(project, firewall)</a></code></p>
<p class="firstline">Returns the specified firewall resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a firewall resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of firewall resources available to the specified project.</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>
<p class="toc_element">
<code><a href="#patch">patch(project, firewall, body)</a></code></p>
<p class="firstline">Updates the specified firewall resource with the data included in the request. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(project, firewall, body)</a></code></p>
<p class="firstline">Updates the specified firewall resource with the data included in the request.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(project, firewall)</code>
<pre>Deletes the specified firewall resource.
Args:
project: string, Name of the project scoping this request. (required)
firewall: string, Name of the firewall resource to delete. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, firewall)</code>
<pre>Returns the specified firewall resource.
Args:
project: string, Name of the project scoping this request. (required)
firewall: string, Name of the firewall resource to return. (required)
Returns:
An object of the form:
{
"kind": "compute#firewall", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
# Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
"A String",
],
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
<pre>Creates a firewall resource in the specified project using the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
{
"kind": "compute#firewall", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
# Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
"A String",
],
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of firewall resources available to the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The firewall resources.
{
"kind": "compute#firewall", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
# Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
"A String",
],
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
},
],
"kind": "compute#firewallList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>
<div class="method">
<code class="details" id="patch">patch(project, firewall, body)</code>
<pre>Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
Args:
project: string, Name of the project scoping this request. (required)
firewall: string, Name of the firewall resource to update. (required)
body: object, The request body. (required)
The object takes the form of:
{
"kind": "compute#firewall", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
# Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
"A String",
],
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(project, firewall, body)</code>
<pre>Updates the specified firewall resource with the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
firewall: string, Name of the firewall resource to update. (required)
body: object, The request body. (required)
The object takes the form of:
{
"kind": "compute#firewall", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
"A String",
],
"network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
"targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
"allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
"ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
# Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
"A String",
],
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
</body></html>

View File

@@ -0,0 +1,132 @@
<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="compute_v1beta13.html">Compute Engine API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="compute_v1beta13.disks.html">disks()</a></code>
</p>
<p class="firstline">Returns the disks Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.firewalls.html">firewalls()</a></code>
</p>
<p class="firstline">Returns the firewalls Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.images.html">images()</a></code>
</p>
<p class="firstline">Returns the images Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.instances.html">instances()</a></code>
</p>
<p class="firstline">Returns the instances Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.kernels.html">kernels()</a></code>
</p>
<p class="firstline">Returns the kernels Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.machineTypes.html">machineTypes()</a></code>
</p>
<p class="firstline">Returns the machineTypes Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.networks.html">networks()</a></code>
</p>
<p class="firstline">Returns the networks Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.projects.html">projects()</a></code>
</p>
<p class="firstline">Returns the projects Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.snapshots.html">snapshots()</a></code>
</p>
<p class="firstline">Returns the snapshots Resource.</p>
<p class="toc_element">
<code><a href="compute_v1beta13.zones.html">zones()</a></code>
</p>
<p class="firstline">Returns the zones Resource.</p>
</body></html>

View File

@@ -0,0 +1,284 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.images.html">images</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, image)</a></code></p>
<p class="firstline">Deletes the specified image resource.</p>
<p class="toc_element">
<code><a href="#get">get(project, image)</a></code></p>
<p class="firstline">Returns the specified image resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates an image resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of image resources available to the specified project.</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="delete">delete(project, image)</code>
<pre>Deletes the specified image resource.
Args:
project: string, Name of the project scoping this request. (required)
image: string, Name of the image resource to delete. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, image)</code>
<pre>Returns the specified image resource.
Args:
project: string, Name of the project scoping this request. (required)
image: string, Name of the image resource to return. (required)
Returns:
An object of the form:
{
"kind": "compute#image", # Type of the resource.
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
"rawDisk": { # The raw disk image parameters.
"containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
"source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
},
"preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
"diskSnapshot": { # Not yet implemented.
"source": "A String", # URL of the disk snapshot.
},
"sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
<pre>Creates an image resource in the specified project using the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
{
"kind": "compute#image", # Type of the resource.
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
"rawDisk": { # The raw disk image parameters.
"containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
"source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
},
"preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
"diskSnapshot": { # Not yet implemented.
"source": "A String", # URL of the disk snapshot.
},
"sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of image resources available to the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The disk image resources.
{
"kind": "compute#image", # Type of the resource.
"description": "A String", # Textual description of the resource; provided by the client when the resource is created.
"rawDisk": { # The raw disk image parameters.
"containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
"source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
"sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
},
"preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
"diskSnapshot": { # Not yet implemented.
"source": "A String", # URL of the disk snapshot.
},
"sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
},
],
"kind": "compute#imageList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,537 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addAccessConfig">addAccessConfig(project, instance, network_interface, body)</a></code></p>
<p class="firstline">Adds an access config to an instance's network interface.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, instance)</a></code></p>
<p class="firstline">Deletes the specified instance resource.</p>
<p class="toc_element">
<code><a href="#deleteAccessConfig">deleteAccessConfig(project, instance, access_config, network_interface)</a></code></p>
<p class="firstline">Deletes an access config from an instance's network interface.</p>
<p class="toc_element">
<code><a href="#get">get(project, instance)</a></code></p>
<p class="firstline">Returns the specified instance resource.</p>
<p class="toc_element">
<code><a href="#getSerialPortOutput">getSerialPortOutput(project, instance)</a></code></p>
<p class="firstline">Returns the specified instance's serial port output.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of instance resources contained within the specified project.</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="addAccessConfig">addAccessConfig(project, instance, network_interface, body)</code>
<pre>Adds an access config to an instance's network interface.
Args:
project: string, Project name. (required)
instance: string, Instance name. (required)
network_interface: string, Network interface name. (required)
body: object, The request body. (required)
The object takes the form of:
{
"kind": "compute#accessConfig", # Type of the resource.
"type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
"name": "A String", # Name of this access configuration.
"natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, instance)</code>
<pre>Deletes the specified instance resource.
Args:
project: string, Name of the project scoping this request. (required)
instance: string, Name of the instance resource to delete. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, instance, access_config, network_interface)</code>
<pre>Deletes an access config from an instance's network interface.
Args:
project: string, Project name. (required)
instance: string, Instance name. (required)
access_config: string, Access config name. (required)
network_interface: string, Network interface name. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, instance)</code>
<pre>Returns the specified instance resource.
Args:
project: string, Name of the project scoping this request. (required)
instance: string, Name of the instance resource to return. (required)
Returns:
An object of the form:
{
"status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
"kind": "compute#instance", # Type of the resource.
"machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
"tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
"image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{
"deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
"kind": "compute#attachedDisk", # Type of the resource.
"index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
"source": "A String", # Persistent disk only; the URL of the persistent disk resource.
"mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
"deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
"type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
},
],
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
"statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
{
"scopes": [ # The list of scopes to be made available for this service account.
"A String",
],
"kind": "compute#serviceAccount", # Type of the resource.
"email": "A String", # Email address of the service account.
},
],
"networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{
"network": "A String", # URL of the network resource attached to this interface.
"accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{
"kind": "compute#accessConfig", # Type of the resource.
"type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
"name": "A String", # Name of this access configuration.
"natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
},
],
"networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
"kind": "compute#networkInterface", # Type of the resource.
"name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
"kind": "compute#metadata", # Type of the resource.
},
}</pre>
</div>
<div class="method">
<code class="details" id="getSerialPortOutput">getSerialPortOutput(project, instance)</code>
<pre>Returns the specified instance's serial port output.
Args:
project: string, Name of the project scoping this request. (required)
instance: string, Name of the instance scoping this request. (required)
Returns:
An object of the form:
{ # An instance serial console output.
"kind": "compute#serialPortOutput", # Type of the resource.
"selfLink": "A String", # Server defined URL for the resource.
"contents": "A String", # The contents of the console output.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
<pre>Creates an instance resource in the specified project using the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
"kind": "compute#instance", # Type of the resource.
"machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
"tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
"image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{
"deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
"kind": "compute#attachedDisk", # Type of the resource.
"index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
"source": "A String", # Persistent disk only; the URL of the persistent disk resource.
"mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
"deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
"type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
},
],
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
"statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
{
"scopes": [ # The list of scopes to be made available for this service account.
"A String",
],
"kind": "compute#serviceAccount", # Type of the resource.
"email": "A String", # Email address of the service account.
},
],
"networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{
"network": "A String", # URL of the network resource attached to this interface.
"accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{
"kind": "compute#accessConfig", # Type of the resource.
"type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
"name": "A String", # Name of this access configuration.
"natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
},
],
"networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
"kind": "compute#networkInterface", # Type of the resource.
"name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
"kind": "compute#metadata", # Type of the resource.
},
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of instance resources contained within the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # A list of instance resources.
{
"status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
"kind": "compute#instance", # Type of the resource.
"machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
"tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
],
"image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
{
"deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
"kind": "compute#attachedDisk", # Type of the resource.
"index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
"source": "A String", # Persistent disk only; the URL of the persistent disk resource.
"mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
"deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
"type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
},
],
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
"statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
"serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
{
"scopes": [ # The list of scopes to be made available for this service account.
"A String",
],
"kind": "compute#serviceAccount", # Type of the resource.
"email": "A String", # Email address of the service account.
},
],
"networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{
"network": "A String", # URL of the network resource attached to this interface.
"accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
{
"kind": "compute#accessConfig", # Type of the resource.
"type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
"name": "A String", # Name of this access configuration.
"natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
},
],
"networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
"kind": "compute#networkInterface", # Type of the resource.
"name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
"kind": "compute#metadata", # Type of the resource.
},
},
],
"kind": "compute#instanceList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,153 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.kernels.html">kernels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project, kernel)</a></code></p>
<p class="firstline">Returns the specified kernel resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of kernel resources available to the specified project.</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(project, kernel)</code>
<pre>Returns the specified kernel resource.
Args:
project: string, Name of the project scoping this request. (required)
kernel: string, Name of the kernel resource to return. (required)
Returns:
An object of the form:
{
"kind": "compute#kernel", # Type of the resource.
"description": "A String", # An optional textual description of the resource.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of kernel resources available to the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The kernel resources.
{
"kind": "compute#kernel", # Type of the resource.
"description": "A String", # An optional textual description of the resource.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource.
},
],
"kind": "compute#kernelList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,179 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.machineTypes.html">machineTypes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project, machineType)</a></code></p>
<p class="firstline">Returns the specified machine type resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of machine type resources available to the specified project.</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(project, machineType)</code>
<pre>Returns the specified machine type resource.
Args:
project: string, Name of the project scoping this request. (required)
machineType: string, Name of the machine type resource to return. (required)
Returns:
An object of the form:
{
"guestCpus": 42, # Count of CPUs exposed to the instance.
"imageSpaceGb": 42, # Space allotted for the image, defined in GB.
"kind": "compute#machineType", # Type of the resource.
"ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
{
"diskGb": 42, # Size of the ephemeral disk, defined in GB.
},
],
"maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
"description": "A String", # An optional textual description of the resource.
"maximumPersistentDisks": 42, # Maximum persistent disks allowed.
"memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
"availableZone": [ # The zones that this machine type can run in.
"A String",
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of machine type resources available to the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The machine type resources.
{
"guestCpus": 42, # Count of CPUs exposed to the instance.
"imageSpaceGb": 42, # Space allotted for the image, defined in GB.
"kind": "compute#machineType", # Type of the resource.
"ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
{
"diskGb": 42, # Size of the ephemeral disk, defined in GB.
},
],
"maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
"description": "A String", # An optional textual description of the resource.
"maximumPersistentDisks": 42, # Maximum persistent disks allowed.
"memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
"availableZone": [ # The zones that this machine type can run in.
"A String",
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource.
},
],
"kind": "compute#machineTypeList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,260 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.networks.html">networks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, network)</a></code></p>
<p class="firstline">Deletes the specified network resource.</p>
<p class="toc_element">
<code><a href="#get">get(project, network)</a></code></p>
<p class="firstline">Returns the specified network resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a network resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of network resources available to the specified project.</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="delete">delete(project, network)</code>
<pre>Deletes the specified network resource.
Args:
project: string, Name of the project scoping this request. (required)
network: string, Name of the network resource to delete. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, network)</code>
<pre>Returns the specified network resource.
Args:
project: string, Name of the project scoping this request. (required)
network: string, Name of the network resource to return. (required)
Returns:
An object of the form:
{
"kind": "compute#network", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
"gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
<pre>Creates a network resource in the specified project using the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
{
"kind": "compute#network", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
"gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of network resources available to the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The network resources.
{
"kind": "compute#network", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
"gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
},
],
"kind": "compute#networkList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,208 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.operations.html">operations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, operation)</a></code></p>
<p class="firstline">Deletes the specified operation resource.</p>
<p class="toc_element">
<code><a href="#get">get(project, operation)</a></code></p>
<p class="firstline">Retrieves the specified operation resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of operation resources contained within the specified project.</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="delete">delete(project, operation)</code>
<pre>Deletes the specified operation resource.
Args:
project: string, Name of the project scoping this request. (required)
operation: string, Name of the operation resource to delete. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, operation)</code>
<pre>Retrieves the specified operation resource.
Args:
project: string, Name of the project scoping this request. (required)
operation: string, Name of the operation resource to return. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of operation resources contained within the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The operation resources.
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
},
],
"kind": "compute#operationList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,177 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project)</a></code></p>
<p class="firstline">Returns the specified project resource.</p>
<p class="toc_element">
<code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</a></code></p>
<p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(project)</code>
<pre>Returns the specified project resource.
Args:
project: string, Name of the project resource to retrieve. (required)
Returns:
An object of the form:
{
"kind": "compute#project", # Type of the resource.
"description": "A String", # An optional textual description of the resource.
"commonInstanceMetadata": { # Metadata key/value pairs available to all instances contained in this project.
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
"kind": "compute#metadata", # Type of the resource.
},
"externalIpAddresses": [ # Internet available IP addresses available for use in this project.
"A String",
],
"quotas": [ # Quotas assigned to this project.
{
"usage": 3.14, # Current usage of this metric.
"metric": "A String", # Name of the quota metric.
"limit": 3.14, # Quota limit for this metric.
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body)</code>
<pre>Sets metadata common to all instances within the specified project using the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
{
"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
{
"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
},
],
"kind": "compute#metadata", # Type of the resource.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
</body></html>

View File

@@ -0,0 +1,266 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.snapshots.html">snapshots</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, snapshot)</a></code></p>
<p class="firstline">Deletes the specified persistent disk snapshot resource.</p>
<p class="toc_element">
<code><a href="#get">get(project, snapshot)</a></code></p>
<p class="firstline">Returns the specified persistent disk snapshot resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a persistent disk snapshot resource in the specified project using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of persistent disk snapshot resources contained within the specified project.</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="delete">delete(project, snapshot)</code>
<pre>Deletes the specified persistent disk snapshot resource.
Args:
project: string, Name of the project scoping this request. (required)
snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, snapshot)</code>
<pre>Returns the specified persistent disk snapshot resource.
Args:
project: string, Name of the project scoping this request. (required)
snapshot: string, Name of the persistent disk snapshot resource to return. (required)
Returns:
An object of the form:
{
"status": "A String", # The status of the persistent disk snapshot (output only).
"kind": "compute#snapshot", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
"sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
"diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, body)</code>
<pre>Creates a persistent disk snapshot resource in the specified project using the data included in the request.
Args:
project: string, Name of the project scoping this request. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # The status of the persistent disk snapshot (output only).
"kind": "compute#snapshot", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
"sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
"diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
}
Returns:
An object of the form:
{
"status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
"kind": "compute#operation", # Type of the resource.
"name": "A String", # Name of the resource.
"startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
"httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
"user": "A String", # User who requested the operation, for example "user@example.com" (output only).
"error": { # If errors occurred during processing of this operation, this field will be populated (output only).
"errors": [ # The array of errors encountered while processing this operation.
{
"message": "A String", # An optional, human-readable error message.
"code": "A String", # The error type identifier for this error.
"location": "A String", # Indicates the field in the request which caused the error. This property is optional.
},
],
},
"targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
"operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
"statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
"insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
"httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
"progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
"clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
"endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"targetLink": "A String", # URL of the resource the operation is mutating (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of persistent disk snapshot resources contained within the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The persistent snapshot resources.
{
"status": "A String", # The status of the persistent disk snapshot (output only).
"kind": "compute#snapshot", # Type of the resource.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
"sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
"diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
},
],
"kind": "compute#snapshotList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -0,0 +1,177 @@
<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="compute_v1beta13.html">Compute Engine API</a> . <a href="compute_v1beta13.zones.html">zones</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project, zone)</a></code></p>
<p class="firstline">Returns the specified zone resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of zone resources available to the specified project.</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(project, zone)</code>
<pre>Returns the specified zone resource.
Args:
project: string, Name of the project scoping this request. (required)
zone: string, Name of the zone resource to return. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the zone. "UP" or "DOWN".
"kind": "compute#zone", # Type of the resource.
"availableMachineType": [ # The machine types that can be used in this zone (output only).
"A String",
],
"description": "A String", # Textual description of the resource.
"maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
{
"endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
"beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
"name": "A String", # Name of the maintenance window.
"description": "A String", # Textual description of the maintenance window.
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of zone resources available to the specified project.
Args:
project: string, Name of the project scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token used to continue a truncated list request (output only).
"items": [ # The zone resources.
{
"status": "A String", # Status of the zone. "UP" or "DOWN".
"kind": "compute#zone", # Type of the resource.
"availableMachineType": [ # The machine types that can be used in this zone (output only).
"A String",
],
"description": "A String", # Textual description of the resource.
"maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
{
"endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
"beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
"name": "A String", # Name of the maintenance window.
"description": "A String", # Textual description of the maintenance window.
},
],
"creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for the resource (output only).
"name": "A String", # Name of the resource.
},
],
"kind": "compute#zoneList", # Type of resource.
"id": "A String", # Unique identifier for the resource; defined by the server (output only).
"selfLink": "A String", # Server defined URL for this resource (output only).
}</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>

View File

@@ -84,4 +84,19 @@ h1, h2, h3 {
</p>
<p class="firstline">Returns the jobs Resource.</p>
<p class="toc_element">
<code><a href="coordinate_v1.location.html">location()</a></code>
</p>
<p class="firstline">Returns the location Resource.</p>
<p class="toc_element">
<code><a href="coordinate_v1.schedule.html">schedule()</a></code>
</p>
<p class="firstline">Returns the schedule Resource.</p>
<p class="toc_element">
<code><a href="coordinate_v1.worker.html">worker()</a></code>
</p>
<p class="firstline">Returns the worker Resource.</p>
</body></html>

View File

@@ -435,7 +435,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -0,0 +1,138 @@
<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.location.html">location</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(teamId, workerEmail, startTimestampMs, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a list of locations for a worker.</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="list">list(teamId, workerEmail, startTimestampMs, pageToken=None, maxResults=None)</code>
<pre>Retrieves a list of locations for a worker.
Args:
teamId: string, Team ID (required)
workerEmail: string, Worker email address. (required)
startTimestampMs: string, Start timestamp in milliseconds since the epoch. (required)
pageToken: string, Continuation token
maxResults: integer, Maximum number of results to return in one page.
Returns:
An object of the form:
{ # Response from a List Locations request.
"nextPageToken": "A String", # A token to provide to get the next page of results.
"items": [ # Locations in the collection.
{ # Recorded location of a worker.
"latitude": 3.14, # Latitude.
"collectionTime": "A String", # The collection time in milliseconds since the epoch.
"confidenceRadius": 3.14, # The location accuracy in meters. This is the radius of a 95% confidence interval around the location measurement.
"kind": "coordinate#locationRecord", # Identifies this object as a location.
"longitude": 3.14, # Longitude.
},
],
"kind": "coordinate#locationList", # Identifies this object as a list of locations.
"tokenPagination": { # Pagination information. # Pagination information for token pagination.
"nextPageToken": "A String", # A token to provide to get the next page of results.
"previousPageToken": "A String", # A token to provide to get the previous page of results.
"kind": "coordinate#tokenPagination", # Identifies this object as pagination information.
},
"pageInfo": { # Page information. # General pagination information.
"totalResults": 42, # Number of results available.
"kind": "coordinate#pageInfo", # Identifies this object as page information.
"resultPerPage": 42, # Number of results per page.
"startIndex": 42, # Page start index.
},
}</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>

View File

@@ -0,0 +1,170 @@
<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.schedule.html">schedule</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(teamId, jobId)</a></code></p>
<p class="firstline">Retrieves the schedule for a job.</p>
<p class="toc_element">
<code><a href="#patch">patch(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</a></code></p>
<p class="firstline">Replaces the schedule of a job with the provided schedule. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</a></code></p>
<p class="firstline">Replaces the schedule of a job with the provided schedule.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(teamId, jobId)</code>
<pre>Retrieves the schedule for a job.
Args:
teamId: string, Team ID (required)
jobId: string, Job number (required)
Returns:
An object of the form:
{ # Job schedule.
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
"endTime": "A String", # Scheduled end time in milliseconds since epoch.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</code>
<pre>Replaces the schedule of a job with the provided schedule. This method supports patch semantics.
Args:
teamId: string, Team ID (required)
jobId: string, Job number (required)
body: object, The request body. (required)
The object takes the form of:
{ # Job schedule.
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
"endTime": "A String", # Scheduled end time in milliseconds since epoch.
}
allDay: boolean, Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
startTime: string, Scheduled start time in milliseconds since epoch.
endTime: string, Scheduled end time in milliseconds since epoch.
Returns:
An object of the form:
{ # Job schedule.
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
"endTime": "A String", # Scheduled end time in milliseconds since epoch.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(teamId, jobId, body, allDay=None, startTime=None, endTime=None)</code>
<pre>Replaces the schedule of a job with the provided schedule.
Args:
teamId: string, Team ID (required)
jobId: string, Job number (required)
body: object, The request body. (required)
The object takes the form of:
{ # Job schedule.
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
"endTime": "A String", # Scheduled end time in milliseconds since epoch.
}
allDay: boolean, Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
startTime: string, Scheduled start time in milliseconds since epoch.
endTime: string, Scheduled end time in milliseconds since epoch.
Returns:
An object of the form:
{ # Job schedule.
"kind": "coordinate#schedule", # Identifies this object as a job schedule.
"allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
"startTime": "A String", # Scheduled start time in milliseconds since epoch.
"endTime": "A String", # Scheduled end time in milliseconds since epoch.
}</pre>
</div>
</body></html>

View File

@@ -0,0 +1,102 @@
<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.worker.html">worker</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 workers in a team.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(teamId)</code>
<pre>Retrieves a list of workers in a team.
Args:
teamId: string, Team ID (required)
Returns:
An object of the form:
{ # Response from a List Workers request.
"items": [ # Workers in the collection.
{ # A worker in a Coordinate team.
"kind": "coordinate#worker", # Identifies this object as a worker.
"id": "A String", # Worker email address.
},
],
"kind": "coordinate#workerList", # Identifies this object as a list of workers.
}</pre>
</div>
</body></html>

View File

@@ -137,7 +137,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -160,7 +160,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -217,7 +217,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -229,7 +229,9 @@ Returns:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
@@ -676,7 +678,9 @@ Args:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
@@ -1117,7 +1121,9 @@ Returns:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
@@ -1579,7 +1585,9 @@ Returns:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
@@ -1928,7 +1936,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -2045,7 +2053,9 @@ Args:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
@@ -2486,7 +2496,9 @@ Returns:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
@@ -2987,7 +2999,9 @@ Args:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.
@@ -3428,7 +3442,9 @@ Returns:
"A String",
],
},
"format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"format": "A String", # The output format of the report, one of:
# - "CSV"
# - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
"ownerProfileId": "A String", # The user profile id of the owner of this report.
"reachCriteria": { # The report criteria for a report of type "REACH".
"activities": { # Represents an activity group. # Activity group.

View File

@@ -120,6 +120,7 @@ Returns:
"A String",
],
"minimum": "A String", # The minimum value of this parameter.
"readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
"location": "A String", # Whether this parameter goes in the query or the path for REST requests.
"pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
"additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
@@ -190,6 +191,7 @@ Returns:
"A String",
],
"minimum": "A String", # The minimum value of this parameter.
"readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
"location": "A String", # Whether this parameter goes in the query or the path for REST requests.
"pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
"additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
@@ -223,6 +225,7 @@ Returns:
"A String",
],
"minimum": "A String", # The minimum value of this parameter.
"readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
"location": "A String", # Whether this parameter goes in the query or the path for REST requests.
"pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
"additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
@@ -274,6 +277,7 @@ Returns:
"A String",
],
"minimum": "A String", # The minimum value of this parameter.
"readOnly": True or False, # The value is read-only, generated by the service. The value can not be modified by the client. It the value is included in a POST, PUT or PATCH request, it will be ignored by the service.
"location": "A String", # Whether this parameter goes in the query or the path for REST requests.
"pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
"additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.

View File

@@ -83,7 +83,7 @@ h1, h2, h3 {
<pre>Gets the information about the current user along with Drive API settings
Args:
includeSubscribed: boolean, Whether to include subscribed items when calculating the number of remaining change IDs
includeSubscribed: boolean, When calculating the number of remaining change IDs, whether to include shared files and public files the user has opened. When set to false, this counts only change IDs for owned files and any shared or public files that the user has explictly added to a folder in Drive.
startChangeId: string, Change ID to start counting from when calculating number of remaining change IDs
maxChangeIdCount: string, Maximum number of remaining change IDs to count

View File

@@ -99,6 +99,7 @@ Returns:
"deleted": True or False, # Whether the file has been deleted.
"file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -120,6 +121,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -134,6 +136,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -147,29 +150,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -207,7 +220,7 @@ Returns:
<pre>Lists the changes for a user.
Args:
includeSubscribed: boolean, Whether to include subscribed items.
includeSubscribed: boolean, Whether to include shared files and public files the user has opened. When set to false, the list will include owned files plus any shared or public files the user has explictly added to a folder in Drive.
includeDeleted: boolean, Whether to include deleted items.
pageToken: string, Page token for changes.
maxResults: integer, Maximum number of changes to return.
@@ -225,6 +238,7 @@ Returns:
"deleted": True or False, # Whether the file has been deleted.
"file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -246,6 +260,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -260,6 +275,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -273,29 +289,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -345,7 +371,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -188,7 +188,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -119,7 +119,7 @@ Returns:
An object of the form:
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
@@ -180,7 +180,7 @@ Args:
The object takes the form of:
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
@@ -235,7 +235,7 @@ Returns:
An object of the form:
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
@@ -304,7 +304,7 @@ Returns:
"nextPageToken": "A String", # The token to use to request the next page of results.
"items": [ # List of comments.
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
@@ -369,7 +369,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -383,7 +383,7 @@ Args:
The object takes the form of:
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
@@ -438,7 +438,7 @@ Returns:
An object of the form:
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
@@ -500,7 +500,7 @@ Args:
The object takes the form of:
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.
@@ -555,7 +555,7 @@ Returns:
An object of the form:
{ # A JSON representation of a comment on a file in Google Drive.
"status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
"status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
# - "open" - The comment is still open.
# - "resolved" - The comment has been resolved by one of its replies.
"selfLink": "A String", # A link back to this comment.

View File

@@ -75,7 +75,7 @@ h1, h2, h3 {
<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#copy">copy(fileId, body, pinned=None, convert=None, ocr=None, sourceLanguage=None, ocrLanguage=None, targetLanguage=None, timedTextTrackName=None, timedTextLanguage=None)</a></code></p>
<code><a href="#copy">copy(fileId, body, pinned=None, convert=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None)</a></code></p>
<p class="firstline">Creates a copy of the specified file.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId)</a></code></p>
@@ -84,7 +84,7 @@ h1, h2, h3 {
<code><a href="#get">get(fileId, projection=None, updateViewedDate=None)</a></code></p>
<p class="firstline">Gets a file's metadata by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, media_body=None, convert=None, ocr=None, sourceLanguage=None, ocrLanguage=None, targetLanguage=None, timedTextLanguage=None, timedTextTrackName=None, pinned=None)</a></code></p>
<code><a href="#insert">insert(body=None, media_body=None, convert=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None, pinned=None)</a></code></p>
<p class="firstline">Insert a new file.</p>
<p class="toc_element">
<code><a href="#list">list(q=None, projection=None, pageToken=None, maxResults=None)</a></code></p>
@@ -93,7 +93,7 @@ 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(fileId, body, newRevision=None, pinned=None, targetLanguage=None, ocrLanguage=None, ocr=None, sourceLanguage=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p>
<code><a href="#patch">patch(fileId, body, newRevision=None, pinned=None, ocrLanguage=None, ocr=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p>
<p class="firstline">Updates file metadata and/or content. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#touch">touch(fileId)</a></code></p>
@@ -105,11 +105,11 @@ h1, h2, h3 {
<code><a href="#untrash">untrash(fileId)</a></code></p>
<p class="firstline">Restores a file from the trash.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, body=None, newRevision=None, media_body=None, targetLanguage=None, ocrLanguage=None, ocr=None, pinned=None, sourceLanguage=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p>
<code><a href="#update">update(fileId, body=None, newRevision=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p>
<p class="firstline">Updates file metadata and/or content</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="copy">copy(fileId, body, pinned=None, convert=None, ocr=None, sourceLanguage=None, ocrLanguage=None, targetLanguage=None, timedTextTrackName=None, timedTextLanguage=None)</code>
<code class="details" id="copy">copy(fileId, body, pinned=None, convert=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None)</code>
<pre>Creates a copy of the specified file.
Args:
@@ -119,6 +119,7 @@ Args:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -140,6 +141,7 @@ Args:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -154,6 +156,7 @@ Args:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -167,29 +170,39 @@ Args:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -219,18 +232,17 @@ Args:
pinned: boolean, Whether to pin the head revision of the new copy.
convert: boolean, Whether to convert this file to the corresponding Google Docs format.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
sourceLanguage: string, The language of the original file to be translated.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
targetLanguage: string, Target language to translate the file to. If no sourceLanguage is provided, the API will attempt to detect the language.
timedTextTrackName: string, The timed text track name.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
Returns:
An object of the form:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -252,6 +264,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -266,6 +279,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -279,29 +293,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -356,6 +380,7 @@ Returns:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -377,6 +402,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -391,6 +417,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -404,29 +431,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -456,7 +493,7 @@ Returns:
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, media_body=None, convert=None, ocr=None, sourceLanguage=None, ocrLanguage=None, targetLanguage=None, timedTextLanguage=None, timedTextTrackName=None, pinned=None)</code>
<code class="details" id="insert">insert(body=None, media_body=None, convert=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None, pinned=None)</code>
<pre>Insert a new file.
Args:
@@ -465,6 +502,7 @@ Args:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -486,6 +524,7 @@ Args:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -500,6 +539,7 @@ Args:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -513,29 +553,39 @@ Args:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -565,10 +615,8 @@ Args:
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
convert: boolean, Whether to convert this file to the corresponding Google Docs format.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
sourceLanguage: string, The language of the original file to be translated.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
targetLanguage: string, Target language to translate the file to. If no sourceLanguage is provided, the API will attempt to detect the language.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
pinned: boolean, Whether to pin the head revision of the uploaded file.
@@ -578,6 +626,7 @@ Returns:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -599,6 +648,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -613,6 +663,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -626,29 +677,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -699,6 +760,7 @@ Returns:
"items": [ # The actual list of files.
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -720,6 +782,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -734,6 +797,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -747,29 +811,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -814,11 +888,11 @@ Args:
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>
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(fileId, body, newRevision=None, pinned=None, targetLanguage=None, ocrLanguage=None, ocr=None, sourceLanguage=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</code>
<code class="details" id="patch">patch(fileId, body, newRevision=None, pinned=None, ocrLanguage=None, ocr=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</code>
<pre>Updates file metadata and/or content. This method supports patch semantics.
Args:
@@ -828,6 +902,7 @@ Args:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -849,6 +924,7 @@ Args:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -863,6 +939,7 @@ Args:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -876,29 +953,39 @@ Args:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -928,10 +1015,8 @@ Args:
newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision will be replaced.
pinned: boolean, Whether to pin the new revision.
targetLanguage: string, Target language to translate the file to. If no sourceLanguage is provided, the API will attempt to detect the language.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
sourceLanguage: string, The language of the original file to be translated.
updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
timedTextTrackName: string, The timed text track name.
convert: boolean, Whether to convert this file to the corresponding Google Docs format.
@@ -943,6 +1028,7 @@ Returns:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -964,6 +1050,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -978,6 +1065,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -991,29 +1079,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -1054,6 +1152,7 @@ Returns:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -1075,6 +1174,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -1089,6 +1189,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -1102,29 +1203,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -1165,6 +1276,7 @@ Returns:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -1186,6 +1298,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -1200,6 +1313,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -1213,29 +1327,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -1276,6 +1400,7 @@ Returns:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -1297,6 +1422,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -1311,6 +1437,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -1324,29 +1451,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -1376,7 +1513,7 @@ Returns:
</div>
<div class="method">
<code class="details" id="update">update(fileId, body=None, newRevision=None, media_body=None, targetLanguage=None, ocrLanguage=None, ocr=None, pinned=None, sourceLanguage=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</code>
<code class="details" id="update">update(fileId, body=None, newRevision=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, updateViewedDate=None, timedTextTrackName=None, convert=None, setModifiedDate=None, timedTextLanguage=None)</code>
<pre>Updates file metadata and/or content
Args:
@@ -1386,6 +1523,7 @@ Args:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -1407,6 +1545,7 @@ Args:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -1421,6 +1560,7 @@ Args:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -1434,29 +1574,39 @@ Args:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.
@@ -1486,11 +1636,9 @@ Args:
newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision will be replaced.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
targetLanguage: string, Target language to translate the file to. If no sourceLanguage is provided, the API will attempt to detect the language.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
pinned: boolean, Whether to pin the new revision.
sourceLanguage: string, The language of the original file to be translated.
updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
timedTextTrackName: string, The timed text track name.
convert: boolean, Whether to convert this file to the corresponding Google Docs format.
@@ -1502,6 +1650,7 @@ Returns:
{ # The metadata for a file.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"appDataContents": True or False, # Whether this file is in the appdata folder.
"thumbnailLink": "A String", # A link to the file's thumbnail.
"labels": { # A group of labels for the file.
"restricted": True or False, # Whether viewers are prevented from downloading this file.
@@ -1523,6 +1672,7 @@ Returns:
"A String",
],
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"parents": [ # Collection of parent folders which contain this file.
# Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
@@ -1537,6 +1687,7 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"shared": True or False, # Whether the file has been shared.
"thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
@@ -1550,29 +1701,39 @@ Returns:
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"iconLink": "A String", # A link to the file's icon.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
"exposureTime": 3.14, # The length of the exposure, in seconds.
"cameraMake": "A String", # The make of the camera used to create the photo.
"maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"isoSpeed": 42, # The ISO speed used to create the photo.
"focalLength": 3.14, # The focal length used to create the photo, in millimeters.
"height": 42, # The height of the image in pixels.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"exposureMode": "A String", # The exposure mode used to create the photo.
"colorSpace": "A String", # The color space of the photo.
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
"subjectDistance": 42, # The distance to the subject of the photo, in meters.
"height": 42, # The height of the image in pixels.
"lens": "A String", # The lens used to create the photo.
"date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"width": 42, # The width of the image in pixels.
"meteringMode": "A String", # The metering mode used to create the photo.
"flashUsed": True or False, # Whether a flash was used to create the photo.
"aperture": 3.14, # The aperture used to create the photo (f-number).
"rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
"width": 42, # The width of the image in pixels.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
"userPermission": { # A single permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"kind": "drive#permission", # This is always drive#permission.
"name": "A String", # The name for this permission.

View File

@@ -252,7 +252,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -207,7 +207,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -827,7 +827,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -75,7 +75,7 @@ h1, h2, h3 {
<h1><a href="fusiontables_v1.html">Fusion Tables API</a> . <a href="fusiontables_v1.table.html">table</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#copy">copy(tableId)</a></code></p>
<code><a href="#copy">copy(tableId, copyPresentation=None)</a></code></p>
<p class="firstline">Copies a table.</p>
<p class="toc_element">
<code><a href="#delete">delete(tableId)</a></code></p>
@@ -103,11 +103,12 @@ h1, h2, h3 {
<p class="firstline">Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="copy">copy(tableId)</code>
<code class="details" id="copy">copy(tableId, copyPresentation=None)</code>
<pre>Copies a table.
Args:
tableId: string, ID of the table that is being copied. (required)
copyPresentation: boolean, Whether to also copy tabs, styles, and templates. Default is false.
Returns:
An object of the form:
@@ -327,7 +328,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -207,7 +207,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -213,7 +213,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -200,7 +200,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -393,7 +393,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -189,7 +189,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -0,0 +1,98 @@
<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="groupsmigration_v1.html">Groups Migration API</a> . <a href="groupsmigration_v1.archive.html">archive</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#insert">insert(groupId, media_body=None)</a></code></p>
<p class="firstline">Inserts a new mail into the archive of the Google group.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="insert">insert(groupId, media_body=None)</code>
<pre>Inserts a new mail into the archive of the Google group.
Args:
groupId: string, The group ID (required)
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # JSON response template for groups migration API.
"kind": "groupsmigration#groups", # The kind of insert resource this is.
"responseCode": "A String", # The status of the insert request.
}</pre>
</div>
</body></html>

View 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="groupsmigration_v1.html">Groups Migration API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="groupsmigration_v1.archive.html">archive()</a></code>
</p>
<p class="firstline">Returns the archive Resource.</p>
</body></html>

View File

@@ -235,7 +235,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -249,7 +249,7 @@ Args:
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>
</pre>
</div>
<div class="method">

View File

@@ -98,12 +98,13 @@ Returns:
"picture": "A String", # URL of the user's picture image.
"locale": "A String", # The user's default locale.
"gender": "A String", # The user's gender.
"email": "A String", # The user's email address.
"id": "A String", # The focus obfuscated gaia id of the user.
"birthday": "A String", # The user's birthday. The year is not present.
"link": "A String", # URL of the profile page.
"given_name": "A String", # The user's first name.
"timezone": "A String", # The user's default timezone.
"id": "A String", # The focus obfuscated gaia id of the user.
"email": "A String", # The user's email address.
"hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
"verified_email": True or False, # Boolean flag which is true if the email address is verified.
}</pre>
</div>

View File

@@ -93,12 +93,13 @@ Returns:
"picture": "A String", # URL of the user's picture image.
"locale": "A String", # The user's default locale.
"gender": "A String", # The user's gender.
"email": "A String", # The user's email address.
"id": "A String", # The focus obfuscated gaia id of the user.
"birthday": "A String", # The user's birthday. The year is not present.
"link": "A String", # URL of the profile page.
"given_name": "A String", # The user's first name.
"timezone": "A String", # The user's default timezone.
"id": "A String", # The focus obfuscated gaia id of the user.
"email": "A String", # The user's email address.
"hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
"verified_email": True or False, # Boolean flag which is true if the email address is verified.
}</pre>
</div>

View File

@@ -285,7 +285,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -277,7 +277,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -250,7 +250,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -223,7 +223,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -179,7 +179,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -235,7 +235,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -374,7 +374,7 @@ Args:
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>
</pre>
</div>
</body></html>

View File

@@ -211,7 +211,6 @@ Returns:
"description": "A String", # Description of the access granted, suitable for display.
},
"verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
# - "checkin" - Check in to a location.
# - "post" - Publish content to the stream.
# - "share" - Reshare an activity.
"etag": "A String", # ETag of this response for caching purposes.
@@ -354,7 +353,6 @@ Returns:
"description": "A String", # Description of the access granted, suitable for display.
},
"verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
# - "checkin" - Check in to a location.
# - "post" - Publish content to the stream.
# - "share" - Reshare an activity.
"etag": "A String", # ETag of this response for caching purposes.
@@ -368,7 +366,7 @@ Returns:
"updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
"nextLink": "A String", # Link to the next page of activities.
"etag": "A String", # ETag of this response for caching purposes.
"id": "A String", # The ID of this collection of activities.
"id": "A String", # The ID of this collection of activities. Deprecated.
"selfLink": "A String", # Link to this activity resource.
}</pre>
</div>
@@ -384,7 +382,7 @@ Args:
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>
</pre>
</div>
<div class="method">
@@ -520,7 +518,6 @@ Returns:
"description": "A String", # Description of the access granted, suitable for display.
},
"verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
# - "checkin" - Check in to a location.
# - "post" - Publish content to the stream.
# - "share" - Reshare an activity.
"etag": "A String", # ETag of this response for caching purposes.
@@ -534,7 +531,7 @@ Returns:
"updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
"nextLink": "A String", # Link to the next page of activities.
"etag": "A String", # ETag of this response for caching purposes.
"id": "A String", # The ID of this collection of activities.
"id": "A String", # The ID of this collection of activities. Deprecated.
"selfLink": "A String", # Link to this activity resource.
}</pre>
</div>
@@ -550,7 +547,7 @@ Args:
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>
</pre>
</div>
</body></html>

Some files were not shown because too many files have changed in this diff Show More