scenes

Creates, updates, deletes, gets or lists a scenes resource.

Overview

Name	scenes
Type	Resource
Id	azure_extras.agrifood_farming.scenes

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_raw	exec	provider, partyId, boundaryId, source, endpoint	startDateTime, endDateTime, maxCloudCoveragePercentage, maxDarkPixelCoveragePercentage, skipToken	Returns a paginated list of scene resources.
get_satellite_data_ingestion_job_details	exec	job_id, endpoint		Get a satellite data ingestion job.
create_satellite_data_ingestion_job	exec	job_id, endpoint		Create a satellite data ingestion job.
get_stac_feature	exec	collection_id, feature_id, endpoint		Get a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id.
download	exec	filePath, endpoint		Downloads and returns file Stream as response for the given input filePath.
search_features	exec	collection_id, endpoint	maxpagesize, skip	Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
boundaryId	string	BoundaryId. Required.
collection_id	string	Collection Id to be searched. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". Required.
endpoint	string	The service endpoint host (no scheme). (default: )
feature_id	string	Feature Id to be fetched. Required.
filePath	string	cloud storage path of scene file. Required.
job_id	string	JobId provided by user. Required.
partyId	string	PartyId. Required.
provider	string	Provider name of scene data. Required.
source	string	Source name of scene data, Available Values: Sentinel_2_L2A, Sentinel_2_L1C. Required.
endDateTime	string (date-time)	Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ. Default value is None.
maxCloudCoveragePercentage	number	Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0]. Default value is 100.
maxDarkPixelCoveragePercentage	number	Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0]. Default value is 100.
maxpagesize	integer	Maximum number of features needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10. Default value is 10.
skip	integer	Skip token for getting next set of results. Default value is None.
skipToken	string	Skip token for getting next set of results. Default value is None.
startDateTime	string (date-time)	Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ. Default value is None.

Lifecycle Methods

list_raw

Returns a paginated list of scene resources.

EXEC azure_extras.agrifood_farming.scenes.list_raw 
@provider='{{ provider }}' --required, 
@partyId='{{ partyId }}' --required, 
@boundaryId='{{ boundaryId }}' --required, 
@source='{{ source }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@startDateTime='{{ startDateTime }}', 
@endDateTime='{{ endDateTime }}', 
@maxCloudCoveragePercentage='{{ maxCloudCoveragePercentage }}', 
@maxDarkPixelCoveragePercentage='{{ maxDarkPixelCoveragePercentage }}', 
@skipToken='{{ skipToken }}'
;

get_satellite_data_ingestion_job_details

Get a satellite data ingestion job.

EXEC azure_extras.agrifood_farming.scenes.get_satellite_data_ingestion_job_details 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_satellite_data_ingestion_job

Create a satellite data ingestion job.

EXEC azure_extras.agrifood_farming.scenes.create_satellite_data_ingestion_job 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_stac_feature

Get a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id.

EXEC azure_extras.agrifood_farming.scenes.get_stac_feature 
@collection_id='{{ collection_id }}' --required, 
@feature_id='{{ feature_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

download

Downloads and returns file Stream as response for the given input filePath.

EXEC azure_extras.agrifood_farming.scenes.download 
@filePath='{{ filePath }}' --required, 
@endpoint='{{ endpoint }}' --required
;

search_features

Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.

EXEC azure_extras.agrifood_farming.scenes.search_features 
@collection_id='{{ collection_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@maxpagesize='{{ maxpagesize }}', 
@skip='{{ skip }}'
;