DataClient.GetItemPreviewWithFormat 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 with format.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response GetItemPreviewWithFormat(Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions options, Azure.RequestContext context = default);

abstract member GetItemPreviewWithFormat : Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions * Azure.RequestContext -> Azure.Response
override this.GetItemPreviewWithFormat : Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions * Azure.RequestContext -> Azure.Response

Public Overridable Function GetItemPreviewWithFormat (options As GetItemPreviewWithFormatOptions, Optional context As RequestContext = Nothing) As 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

Response

The response returned from the service.

Exceptions

ArgumentNullException

options is null.

RequestFailedException

Service returned a non-success status code.