| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasterCollections.html">rasterCollections</a> . <a href="mapsengine_v1.rasterCollections.rasters.html">rasters</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#list">list(id, modifiedAfter=None, createdAfter=None, pageToken=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p> |
| 79 | <p class="firstline">Return all rasters within a raster collection.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="list">list(id, modifiedAfter=None, createdAfter=None, pageToken=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code> |
| 86 | <pre>Return all rasters within a raster collection. |
| 87 | |
| 88 | Args: |
| 89 | id: string, The ID of the raster collection to which these rasters belong. (required) |
| 90 | modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time. |
| 91 | createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time. |
| 92 | pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. |
| 93 | maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100. |
| 94 | createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time. |
| 95 | bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned. |
| 96 | creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address. |
| 97 | modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time. |
| 98 | |
| 99 | Returns: |
| 100 | An object of the form: |
| 101 | |
| 102 | { # The response returned by a call to rasterCollections.rasters.List. |
| 103 | "nextPageToken": "A String", # Next page token. |
| 104 | "rasters": [ # Resources returned. |
| 105 | { # A raster resource. |
| 106 | "name": "A String", # The name of this Raster, supplied by the author. |
| 107 | "tags": [ # Tags of this Raster. |
| 108 | "A String", |
| 109 | ], |
| 110 | "rasterType": "image", # The type of this Raster. Always "image" today. |
| 111 | "projectId": "A String", # The ID of the project that this Raster is in. |
| 112 | "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). |
| 113 | "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Raster. The numbers represent latitudes and longitudes in decimal degrees. |
| 114 | 3.14, |
| 115 | ], |
| 116 | "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). |
| 117 | "id": "A String", # A globally unique ID, used to refer to this Raster. |
| 118 | "description": "A String", # The description of this Raster, supplied by the author. |
| 119 | }, |
| 120 | ], |
| 121 | }</pre> |
| 122 | </div> |
| 123 | |
| 124 | <div class="method"> |
| 125 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 126 | <pre>Retrieves the next page of results. |
| 127 | |
| 128 | Args: |
| 129 | previous_request: The request for the previous page. (required) |
| 130 | previous_response: The response from the request for the previous page. (required) |
| 131 | |
| 132 | Returns: |
| 133 | A request object that you can call 'execute()' on to request the next |
| 134 | page. Returns None if there are no more items in the collection. |
| 135 | </pre> |
| 136 | </div> |
| 137 | |
| 138 | </body></html> |