DataClient.GetItemTileJsonAsync 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.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.TileJsonMetadata>> GetItemTileJsonAsync(Azure.Analytics.PlanetaryComputer.GetItemTileJsonOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member GetItemTileJsonAsync : Azure.Analytics.PlanetaryComputer.GetItemTileJsonOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.TileJsonMetadata>>
override this.GetItemTileJsonAsync : Azure.Analytics.PlanetaryComputer.GetItemTileJsonOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.TileJsonMetadata>>

Public Overridable Function GetItemTileJsonAsync (options As GetItemTileJsonOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TileJsonMetadata))

Parameters

options

GetItemTileJsonOptions

The options for the item TileJSON query.

cancellationToken

CancellationToken

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

Returns

Task<Response<TileJsonMetadata>>

Exceptions

ArgumentNullException

options is null.

RequestFailedException

Service returned a non-success status code.