DataClient.GetItemInfoAsync(GetItemInfoOptions, CancellationToken) Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

DataClient.cs

Return dataset's basic info for a STAC item.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.TilerInfoMapResult>> GetItemInfoAsync(Azure.Analytics.PlanetaryComputer.GetItemInfoOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member GetItemInfoAsync : Azure.Analytics.PlanetaryComputer.GetItemInfoOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.TilerInfoMapResult>>
override this.GetItemInfoAsync : Azure.Analytics.PlanetaryComputer.GetItemInfoOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.TilerInfoMapResult>>

Public Overridable Function GetItemInfoAsync (options As GetItemInfoOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TilerInfoMapResult))

Parameters

options

GetItemInfoOptions

The options for the item info query.

cancellationToken

CancellationToken

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

Returns

Task<Response<TilerInfoMapResult>>

Exceptions

ArgumentNullException

options is null.

RequestFailedException

Service returned a non-success status code.