Google Git
Sign in
android / platform / external / python / google-api-python-client / 4e9a44db2c8638bbe49c8e54ac140f1559827cc4 / . / docs / dyn / mapsengine_v1.rasters.html
blob: 8c7a2f60be411d2fa9caac0f0979515829f5bde5 [file] [log] [blame]
<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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasters.html">rasters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="mapsengine_v1.rasters.files.html">files()</a></code>
</p>
<p class="firstline">Returns the files Resource.</p>
<p class="toc_element">
<code><a href="mapsengine_v1.rasters.parents.html">parents()</a></code>
</p>
<p class="firstline">Returns the parents Resource.</p>
<p class="toc_element">
<code><a href="mapsengine_v1.rasters.permissions.html">permissions()</a></code>
</p>
<p class="firstline">Returns the permissions Resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(id)</a></code></p>
<p class="firstline">Delete a raster.</p>
<p class="toc_element">
<code><a href="#get">get(id)</a></code></p>
<p class="firstline">Return metadata for a single raster.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, modifiedBefore=None, creatorEmail=None, processingStatus=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
<p class="firstline">Return all rasters readable by the current user.</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(id, body)</a></code></p>
<p class="firstline">Mutate a raster asset.</p>
<p class="toc_element">
<code><a href="#process">process(id)</a></code></p>
<p class="firstline">Process a raster asset.</p>
<p class="toc_element">
<code><a href="#upload">upload(body)</a></code></p>
<p class="firstline">Create a skeleton raster asset for upload.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(id)</code>
<pre>Delete a raster.
Args:
id: string, The ID of the raster. Only the raster creator or project owner are permitted to delete. If the raster is included in a layer or mosaic, the request will fail. Remove it from all parents prior to deleting. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(id)</code>
<pre>Return metadata for a single raster.
Args:
id: string, The ID of the raster. (required)
Returns:
An object of the form:
{ # A geo-referenced raster.
"files": [ # The files associated with this Raster.
{ # A single File, which is a component of an Asset.
"size": "A String", # The size of the file in bytes.
"uploadStatus": "A String", # The upload status of the file.
"filename": "A String", # The name of the file.
},
],
"attribution": "A String", # The name of the attribution to be used for this Raster.
"description": "A String", # The description of this Raster, supplied by the author.
"processingStatus": "A String", # The processing status of this Raster.
"draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
"projectId": "A String", # The ID of the project that this Raster is in.
"tags": [ # Tags of this Raster.
"A String",
],
"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).
"name": "A String", # The name of this Raster, supplied by the author.
"maskType": "autoMask", # The mask processing type of this Raster.
"etag": "A String", # The ETag, used to refer to the current version of the asset.
"creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
"acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
"start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"precision": "A String", # The precision of acquisition time.
},
"lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
"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).
"writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
"id": "A String", # A globally unique ID, used to refer to this Raster.
"rasterType": "A String", # The type of this Raster. Always "image" today.
"bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
3.14,
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, modifiedBefore=None, creatorEmail=None, processingStatus=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
<pre>Return all rasters readable by the current user.
Args:
projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com. (required)
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.
creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
processingStatus: string, A parameter
Allowed values
complete - The raster has completed processing.
failed - The raster has failed processing.
notReady - The raster is not ready for processing.
processing - The raster is processing.
ready - The raster is ready for processing.
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.
role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
Allowed values
owner - The user can read, write and administer the asset.
reader - The user can read the asset.
writer - The user can read and write the asset.
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.
tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
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.
search: string, An unstructured search string used to filter the set of results based on asset metadata.
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.
Returns:
An object of the form:
{ # The response returned by a call to rasters.List.
"nextPageToken": "A String", # Next page token.
"rasters": [ # Resources returned.
{ # A geo-referenced raster.
"files": [ # The files associated with this Raster.
{ # A single File, which is a component of an Asset.
"size": "A String", # The size of the file in bytes.
"uploadStatus": "A String", # The upload status of the file.
"filename": "A String", # The name of the file.
},
],
"attribution": "A String", # The name of the attribution to be used for this Raster.
"description": "A String", # The description of this Raster, supplied by the author.
"processingStatus": "A String", # The processing status of this Raster.
"draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
"projectId": "A String", # The ID of the project that this Raster is in.
"tags": [ # Tags of this Raster.
"A String",
],
"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).
"name": "A String", # The name of this Raster, supplied by the author.
"maskType": "autoMask", # The mask processing type of this Raster.
"etag": "A String", # The ETag, used to refer to the current version of the asset.
"creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
"acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
"start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"precision": "A String", # The precision of acquisition time.
},
"lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
"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).
"writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
"id": "A String", # A globally unique ID, used to refer to this Raster.
"rasterType": "A String", # The type of this Raster. Always "image" today.
"bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
3.14,
],
},
],
}</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(id, body)</code>
<pre>Mutate a raster asset.
Args:
id: string, The ID of the raster. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A geo-referenced raster.
"files": [ # The files associated with this Raster.
{ # A single File, which is a component of an Asset.
"size": "A String", # The size of the file in bytes.
"uploadStatus": "A String", # The upload status of the file.
"filename": "A String", # The name of the file.
},
],
"attribution": "A String", # The name of the attribution to be used for this Raster.
"description": "A String", # The description of this Raster, supplied by the author.
"processingStatus": "A String", # The processing status of this Raster.
"draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
"projectId": "A String", # The ID of the project that this Raster is in.
"tags": [ # Tags of this Raster.
"A String",
],
"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).
"name": "A String", # The name of this Raster, supplied by the author.
"maskType": "autoMask", # The mask processing type of this Raster.
"etag": "A String", # The ETag, used to refer to the current version of the asset.
"creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
"acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
"start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"precision": "A String", # The precision of acquisition time.
},
"lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
"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).
"writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
"id": "A String", # A globally unique ID, used to refer to this Raster.
"rasterType": "A String", # The type of this Raster. Always "image" today.
"bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
3.14,
],
}
</pre>
</div>
<div class="method">
<code class="details" id="process">process(id)</code>
<pre>Process a raster asset.
Args:
id: string, The ID of the raster. (required)
Returns:
An object of the form:
{ # The response returned by a call to any asset's Process method.
}</pre>
</div>
<div class="method">
<code class="details" id="upload">upload(body)</code>
<pre>Create a skeleton raster asset for upload.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A geo-referenced raster.
"files": [ # The files associated with this Raster.
{ # A single File, which is a component of an Asset.
"size": "A String", # The size of the file in bytes.
"uploadStatus": "A String", # The upload status of the file.
"filename": "A String", # The name of the file.
},
],
"attribution": "A String", # The name of the attribution to be used for this Raster.
"description": "A String", # The description of this Raster, supplied by the author.
"processingStatus": "A String", # The processing status of this Raster.
"draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
"projectId": "A String", # The ID of the project that this Raster is in.
"tags": [ # Tags of this Raster.
"A String",
],
"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).
"name": "A String", # The name of this Raster, supplied by the author.
"maskType": "autoMask", # The mask processing type of this Raster.
"etag": "A String", # The ETag, used to refer to the current version of the asset.
"creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
"acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
"start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"precision": "A String", # The precision of acquisition time.
},
"lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
"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).
"writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
"id": "A String", # A globally unique ID, used to refer to this Raster.
"rasterType": "A String", # The type of this Raster. Always "image" today.
"bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
3.14,
],
}
Returns:
An object of the form:
{ # A geo-referenced raster.
"files": [ # The files associated with this Raster.
{ # A single File, which is a component of an Asset.
"size": "A String", # The size of the file in bytes.
"uploadStatus": "A String", # The upload status of the file.
"filename": "A String", # The name of the file.
},
],
"attribution": "A String", # The name of the attribution to be used for this Raster.
"description": "A String", # The description of this Raster, supplied by the author.
"processingStatus": "A String", # The processing status of this Raster.
"draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
"projectId": "A String", # The ID of the project that this Raster is in.
"tags": [ # Tags of this Raster.
"A String",
],
"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).
"name": "A String", # The name of this Raster, supplied by the author.
"maskType": "autoMask", # The mask processing type of this Raster.
"etag": "A String", # The ETag, used to refer to the current version of the asset.
"creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
"acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
"start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
"precision": "A String", # The precision of acquisition time.
},
"lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
"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).
"writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
"id": "A String", # A globally unique ID, used to refer to this Raster.
"rasterType": "A String", # The type of this Raster. Always "image" today.
"bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
3.14,
],
}</pre>
</div>
</body></html>