DataClient.GetCollectionTileJsonByTms 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 collection with TileMatrixSetId as path.

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

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

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

Parameters

options

GetCollectionTileJsonByTmsOptions

The options for the collection 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.