PlanetaryComputerModelFactory.GetSearchBboxAssetsOptions 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.

Options for the getSearchBboxAssets operation.

public static Azure.Analytics.PlanetaryComputer.GetSearchBboxAssetsOptions GetSearchBboxAssetsOptions(string searchId = default, int? scanLimit = default, int? itemsLimit = default, int? timeLimit = default, bool? exitWhenFull = default, bool? skipCovered = default, string subdatasetName = default, System.Collections.Generic.IEnumerable<int> subdatasetBands = default, string crs = default, string datetime = default, System.Collections.Generic.IEnumerable<string> sel = default, Azure.Analytics.PlanetaryComputer.SelMethod? selMethod = default, float minX = 0, float minY = 0, float maxX = 0, float maxY = 0, string coordinateReferenceSystem = default);

static member GetSearchBboxAssetsOptions : string * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * string * seq<int> * string * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.SelMethod> * single * single * single * single * string -> Azure.Analytics.PlanetaryComputer.GetSearchBboxAssetsOptions

Public Shared Function GetSearchBboxAssetsOptions (Optional searchId As String = Nothing, Optional scanLimit As Nullable(Of Integer) = Nothing, Optional itemsLimit As Nullable(Of Integer) = Nothing, Optional timeLimit As Nullable(Of Integer) = Nothing, Optional exitWhenFull As Nullable(Of Boolean) = Nothing, Optional skipCovered As Nullable(Of Boolean) = Nothing, Optional subdatasetName As String = Nothing, Optional subdatasetBands As IEnumerable(Of Integer) = Nothing, Optional crs As String = Nothing, Optional datetime As String = Nothing, Optional sel As IEnumerable(Of String) = Nothing, Optional selMethod As Nullable(Of SelMethod) = Nothing, Optional minX As Single = 0, Optional minY As Single = 0, Optional maxX As Single = 0, Optional maxY As Single = 0, Optional coordinateReferenceSystem As String = Nothing) As GetSearchBboxAssetsOptions

Parameters

searchId: String

Search Id (pgSTAC Search Hash).

scanLimit: Nullable<Int32>

Return as soon as we scan N items (defaults to 10000).

itemsLimit: Nullable<Int32>

Return as soon as we have N items per geometry (defaults to 100).

timeLimit: Nullable<Int32>

Return after N seconds to avoid long requests (defaults to 5).

exitWhenFull: Nullable<Boolean>

Return as soon as the geometry is fully covered (defaults to True).

skipCovered: Nullable<Boolean>

Skip any items that would show up completely under the previous items (defaults to True).

subdatasetName: String

The name of a subdataset within the asset.

subdatasetBands: IEnumerable<Int32>

The index of a subdataset band within the asset.

crs: String

Coordinate Reference System.

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.