PlanetaryComputerModelFactory.StacSearchParameters Method

Definition

Namespace:: Azure.Analytics.PlanetaryComputer

Assembly:: Azure.Analytics.PlanetaryComputer.dll

Package:: Azure.Analytics.PlanetaryComputer v1.0.0

Source:: PlanetaryComputerModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Search model. * Defines parameters for a STAC search POST request.

public static Azure.Analytics.PlanetaryComputer.StacSearchParameters StacSearchParameters(System.Collections.Generic.IEnumerable<string> collections = default, System.Collections.Generic.IEnumerable<string> ids = default, System.Collections.Generic.IEnumerable<float> boundingBox = default, Azure.Analytics.PlanetaryComputer.GeoJsonGeometry intersects = default, string datetime = default, int? limit = default, System.Collections.Generic.IDictionary<string,BinaryData> conformanceClass = default, System.Collections.Generic.IDictionary<string,BinaryData> query = default, System.Collections.Generic.IEnumerable<Azure.Analytics.PlanetaryComputer.StacSortExtension> sortBy = default, System.Collections.Generic.IEnumerable<Azure.Analytics.PlanetaryComputer.SearchOptionsFields> fields = default, System.Collections.Generic.IDictionary<string,BinaryData> filter = default, string filterCoordinateReferenceSystem = default, Azure.Analytics.PlanetaryComputer.FilterLanguage? filterLang = default, string token = default);

static member StacSearchParameters : seq<string> * seq<string> * seq<single> * Azure.Analytics.PlanetaryComputer.GeoJsonGeometry * string * Nullable<int> * System.Collections.Generic.IDictionary<string, BinaryData> * System.Collections.Generic.IDictionary<string, BinaryData> * seq<Azure.Analytics.PlanetaryComputer.StacSortExtension> * seq<Azure.Analytics.PlanetaryComputer.SearchOptionsFields> * System.Collections.Generic.IDictionary<string, BinaryData> * string * Nullable<Azure.Analytics.PlanetaryComputer.FilterLanguage> * string -> Azure.Analytics.PlanetaryComputer.StacSearchParameters

Public Shared Function StacSearchParameters (Optional collections As IEnumerable(Of String) = Nothing, Optional ids As IEnumerable(Of String) = Nothing, Optional boundingBox As IEnumerable(Of Single) = Nothing, Optional intersects As GeoJsonGeometry = Nothing, Optional datetime As String = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional conformanceClass As IDictionary(Of String, BinaryData) = Nothing, Optional query As IDictionary(Of String, BinaryData) = Nothing, Optional sortBy As IEnumerable(Of StacSortExtension) = Nothing, Optional fields As IEnumerable(Of SearchOptionsFields) = Nothing, Optional filter As IDictionary(Of String, BinaryData) = Nothing, Optional filterCoordinateReferenceSystem As String = Nothing, Optional filterLang As Nullable(Of FilterLanguage) = Nothing, Optional token As String = Nothing) As StacSearchParameters

Parameters

collections: IEnumerable<String>

List of collection IDs to search within.

ids: IEnumerable<String>

List of specific item IDs to return.

boundingBox: IEnumerable<Single>

Bounding box for spatial filtering in format [west, south, east, north].

intersects: GeoJsonGeometry

GeoJSON geometry for spatial filtering.

datetime: String

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:

A date-time: "2018-02-12T23:20:50Z"
A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

Only features that have a temporal property that intersects the value of `datetime` are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.