PlanetaryComputerModelFactory.GetSearchAssetsForTileOptions Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Options for the getSearchAssetsForTile operation.

public static Azure.Analytics.PlanetaryComputer.GetSearchAssetsForTileOptions GetSearchAssetsForTileOptions(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, string tileMatrixSetId = default, string collectionId = default, float z = 0, float x = 0, float y = 0);

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

Public Shared Function GetSearchAssetsForTileOptions (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 tileMatrixSetId As String = Nothing, Optional collectionId As String = Nothing, Optional z As Single = 0, Optional x As Single = 0, Optional y As Single = 0) As GetSearchAssetsForTileOptions

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.

sel

IEnumerable<String>

Xarray Indexing using dimension names {dimension}={value}.

selMethod

Nullable<SelMethod>

Xarray indexing method to use for inexact matches.

tileMatrixSetId

String

Identifier selecting one of the TileMatrixSetId supported.

collectionId

String

STAC Collection Identifier.

z

Single

Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.

x

Single

Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.

y

Single

Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.

Returns

GetSearchAssetsForTileOptions

A new GetSearchAssetsForTileOptions instance for mocking.