DataClient.GetItemTileJsonByTms Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

DataClient.cs

Return TileJSON document for a STAC item with TileMatrixSetId as path.

public virtual Azure.Response<Azure.Analytics.PlanetaryComputer.TileJsonMetadata> GetItemTileJsonByTms(Azure.Analytics.PlanetaryComputer.GetItemTileJsonByTmsOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member GetItemTileJsonByTms : Azure.Analytics.PlanetaryComputer.GetItemTileJsonByTmsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.TileJsonMetadata>
override this.GetItemTileJsonByTms : Azure.Analytics.PlanetaryComputer.GetItemTileJsonByTmsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.TileJsonMetadata>

Public Overridable Function GetItemTileJsonByTms (options As GetItemTileJsonByTmsOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TileJsonMetadata)

Parameters

options

GetItemTileJsonByTmsOptions

The options for the item TileJSON by TMS query.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Response<TileJsonMetadata>

Exceptions

ArgumentNullException

options is null.

RequestFailedException

Service returned a non-success status code.