GetCollectionAssetsForTileOptions Class

Definition

Options for the getCollectionAssetsForTile operation.

public class GetCollectionAssetsForTileOptions : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.GetCollectionAssetsForTileOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.GetCollectionAssetsForTileOptions>
type GetCollectionAssetsForTileOptions = class
    interface IJsonModel<GetCollectionAssetsForTileOptions>
    interface IPersistableModel<GetCollectionAssetsForTileOptions>
Public Class GetCollectionAssetsForTileOptions
Implements IJsonModel(Of GetCollectionAssetsForTileOptions), IPersistableModel(Of GetCollectionAssetsForTileOptions)
Inheritance
GetCollectionAssetsForTileOptions
Implements

Constructors

Name Description
GetCollectionAssetsForTileOptions(String, String, Single, Single, Single)

Initializes a new instance of GetCollectionAssetsForTileOptions.

Properties

Name Description
Bbox

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

CollectionId

STAC Collection Identifier.

Crs

Coordinate Reference System.

Datetime

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

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

Ids

Array of Item ids.

ItemsLimit

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

Query

JSON query expression for filtering items.

ScanLimit

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

Sel

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

SelMethod

Xarray indexing method to use for inexact matches.

SkipCovered

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

SortBy

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

SubdatasetBands

The index of a subdataset band within the asset.

SubdatasetName

The name of a subdataset within the asset.

TileMatrixSetId

Identifier selecting one of the TileMatrixSetId supported.

TimeLimit

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

X

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

Y

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

Z

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

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<GetCollectionAssetsForTileOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<GetCollectionAssetsForTileOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<GetCollectionAssetsForTileOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<GetCollectionAssetsForTileOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<GetCollectionAssetsForTileOptions>.Write(ModelReaderWriterOptions)

Applies to