public final class ScenesBaseClient extends Object
Modifier and Type | Method and Description |
---|---|
com.azure.core.experimental.http.DynamicRequest |
createSatelliteDataIngestionJob(String jobId)
Create a satellite data ingestion job.
|
com.azure.core.experimental.http.DynamicRequest |
download(String filePath)
Downloads and returns file stream as response for the given input filePath.
|
com.azure.core.experimental.http.DynamicRequest |
getSatelliteDataIngestionJobDetails(String jobId)
Get a satellite data ingestion job.
|
com.azure.core.experimental.http.DynamicRequest |
invoke()
Create an empty DynamicRequest with the serializer and pipeline initialized for this client.
|
com.azure.core.experimental.http.DynamicRequest |
list(String provider,
String farmerId,
String boundaryId)
Returns a paginated list of scene resources.
|
com.azure.core.experimental.http.DynamicRequest |
listNext(String nextLink)
Get the next page of items.
|
public com.azure.core.experimental.http.DynamicRequest list(String provider, String farmerId, String boundaryId)
Optional Query Parameters
Name | Type | Description |
---|---|---|
source | String | Source name of scene data, default value Sentinel_2_L2A (Sentinel 2 L2A). |
startDateTime | OffsetDateTime | Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ. |
endDateTime | OffsetDateTime | Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ. |
maxCloudCoveragePercentage | Double | Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0]. |
maxDarkPixelCoveragePercentage | Double | Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0]. |
imageNames | List<String> | List of image names to be filtered. |
imageResolutions | List<Double> | List of image resolutions in meters to be filtered. |
imageFormats | List<String> | List of image formats to be filtered. |
maxPageSize | Integer | Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. |
skipToken | String | Skip token for getting next set of results. |
Response Body Schema
{
value: [
{
sceneDateTime: OffsetDateTime
provider: String
source: String
imageFiles: [
{
fileLink: String
name: String
imageFormat: String(TIF)
resolution: Double
}
]
imageFormat: String(TIF)
cloudCoverPercentage: Double
darkPixelPercentage: Double
ndviMedianValue: Double
boundaryId: String
farmerId: String
id: String
eTag: String
}
]
skipToken: String
nextLink: String
}
provider
- Provider name of scene data.farmerId
- FarmerId.boundaryId
- BoundaryId.public com.azure.core.experimental.http.DynamicRequest createSatelliteDataIngestionJob(String jobId)
Request Body Schema
{
farmerId: String
boundaryId: String
startDateTime: OffsetDateTime
endDateTime: OffsetDateTime
provider: String(Microsoft)
source: String(Sentinel_2_L2A)
data: {
imageNames: [
String
]
imageFormats: [
String
]
imageResolutions: [
double
]
}
id: String
status: String
durationInSeconds: Double
message: String
createdDateTime: OffsetDateTime
lastActionDateTime: OffsetDateTime
startTime: OffsetDateTime
endTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
Response Body Schema
(recursive schema, see above)
jobId
- JobId provided by user.public com.azure.core.experimental.http.DynamicRequest getSatelliteDataIngestionJobDetails(String jobId)
Response Body Schema
{
farmerId: String
boundaryId: String
startDateTime: OffsetDateTime
endDateTime: OffsetDateTime
provider: String(Microsoft)
source: String(Sentinel_2_L2A)
data: {
imageNames: [
String
]
imageFormats: [
String
]
imageResolutions: [
double
]
}
id: String
status: String
durationInSeconds: Double
message: String
createdDateTime: OffsetDateTime
lastActionDateTime: OffsetDateTime
startTime: OffsetDateTime
endTime: OffsetDateTime
name: String
description: String
properties: {
String: Object
}
}
jobId
- ID of the job.public com.azure.core.experimental.http.DynamicRequest download(String filePath)
filePath
- cloud storage path of scene file.public com.azure.core.experimental.http.DynamicRequest listNext(String nextLink)
Response Body Schema
{
value: [
{
sceneDateTime: OffsetDateTime
provider: String
source: String
imageFiles: [
{
fileLink: String
name: String
imageFormat: String(TIF)
resolution: Double
}
]
imageFormat: String(TIF)
cloudCoverPercentage: Double
darkPixelPercentage: Double
ndviMedianValue: Double
boundaryId: String
farmerId: String
id: String
eTag: String
}
]
skipToken: String
nextLink: String
}
nextLink
- The nextLink parameter.public com.azure.core.experimental.http.DynamicRequest invoke()
Copyright © 2021 Microsoft Corporation. All rights reserved.