DataClient.GetItemPreviewAsync(GetItemPreviewOptions, RequestContext) Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

DataClient.cs

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

• 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> GetItemPreviewAsync(Azure.Analytics.PlanetaryComputer.GetItemPreviewOptions options, Azure.RequestContext context = default);

abstract member GetItemPreviewAsync : Azure.Analytics.PlanetaryComputer.GetItemPreviewOptions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetItemPreviewAsync : Azure.Analytics.PlanetaryComputer.GetItemPreviewOptions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetItemPreviewAsync (options As GetItemPreviewOptions, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

options

GetItemPreviewOptions

The options for the getItemPreview request.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

options is null.

RequestFailedException

Service returned a non-success status code.