PlanetaryComputerModelFactory.GetCollectionAssetsForTileNoTmsOptions Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Options for the getCollectionAssetsForTileNoTms operation.

public static Azure.Analytics.PlanetaryComputer.GetCollectionAssetsForTileNoTmsOptions GetCollectionAssetsForTileNoTmsOptions(string collectionId = default, int? scanLimit = default, int? itemsLimit = default, int? timeLimit = default, bool? exitWhenFull = default, bool? skipCovered = default, string ids = default, string bbox = default, string query = default, string sortBy = default, string datetime = default, string subdatasetName = default, System.Collections.Generic.IEnumerable<int> subdatasetBands = default, string crs = default, System.Collections.Generic.IEnumerable<string> sel = default, Azure.Analytics.PlanetaryComputer.SelMethod? selMethod = default, float z = 0, float x = 0, float y = 0, Azure.Analytics.PlanetaryComputer.TileMatrixSetId? tileMatrixSetId = default);

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

Public Shared Function GetCollectionAssetsForTileNoTmsOptions (Optional collectionId 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 ids As String = Nothing, Optional bbox As String = Nothing, Optional query As String = Nothing, Optional sortBy As String = Nothing, Optional datetime As String = Nothing, Optional subdatasetName As String = Nothing, Optional subdatasetBands As IEnumerable(Of Integer) = Nothing, Optional crs As String = Nothing, Optional sel As IEnumerable(Of String) = Nothing, Optional selMethod As Nullable(Of SelMethod) = Nothing, Optional z As Single = 0, Optional x As Single = 0, Optional y As Single = 0, Optional tileMatrixSetId As Nullable(Of TileMatrixSetId) = Nothing) As GetCollectionAssetsForTileNoTmsOptions

Parameters

collectionId

String

STAC Collection Identifier.

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).

ids

String

Array of Item ids.

bbox

String

Bounding box (west, south, east, north).

query

String

JSON query expression for filtering items.

sortBy

String

Sorting expression (e.g. +/-property).

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.

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.

sel

IEnumerable<String>

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

selMethod

Nullable<SelMethod>

Xarray indexing method to use for inexact matches.

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.

tileMatrixSetId

Nullable<TileMatrixSetId>

Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad')

Returns

GetCollectionAssetsForTileNoTmsOptions

A new GetCollectionAssetsForTileNoTmsOptions instance for mocking.