DataClient.GetItemPreviewWithFormatAsync Method

Definition

[Protocol Method] Create preview of a STAC item dataset with format.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response> GetItemPreviewWithFormatAsync(Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions options, Azure.RequestContext context = default);
abstract member GetItemPreviewWithFormatAsync : Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetItemPreviewWithFormatAsync : Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function GetItemPreviewWithFormatAsync (options As GetItemPreviewWithFormatOptions, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

options
GetItemPreviewWithFormatOptions

The options for the getItemPreviewWithFormat request.

context
RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

The response returned from the service.

Exceptions

options is null.

Service returned a non-success status code.

Applies to