StacClient.GetItemAsync Method

Definition

Namespace:: Azure.Analytics.PlanetaryComputer

Assembly:: Azure.Analytics.PlanetaryComputer.dll

Package:: Azure.Analytics.PlanetaryComputer v1.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
GetItemAsync(String, String, String, Nullable<Int32>, RequestContext)	[Protocol Method] Fetch a single STAC Item This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetItemAsync(String, String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)	Fetch a single STAC Item.

Name

Description

GetItemAsync(String, String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Fetch a single STAC Item

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

GetItemAsync(String, String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Fetch a single STAC Item.

GetItemAsync(String, String, String, Nullable<Int32>, RequestContext)

Source:: StacClient.cs

[Protocol Method] Fetch a single STAC Item

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> GetItemAsync(string collectionId, string itemId, string sign, int? durationInMinutes, Azure.RequestContext context);

abstract member GetItemAsync : string * string * string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetItemAsync : string * string * string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetItemAsync (collectionId As String, itemId As String, sign As String, durationInMinutes As Nullable(Of Integer), context As RequestContext) As Task(Of Response)

Parameters

collectionId: String

Catalog collection id.

itemId: String

STAC Item id.

sign: String

Whether to sign asset URLs in the response.

durationInMinutes: Nullable<Int32>

URL signature duration in minutes.

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

collectionId or itemId is null.

ArgumentException

collectionId or itemId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Applies to

GetItemAsync(String, String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Source:: StacClient.cs

Fetch a single STAC Item.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.StacItem>> GetItemAsync(string collectionId, string itemId, Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode? sign = default, int? durationInMinutes = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetItemAsync : string * string * Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.StacItem>>
override this.GetItemAsync : string * string * Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.StacItem>>

Public Overridable Function GetItemAsync (collectionId As String, itemId As String, Optional sign As Nullable(Of StacAssetUrlSigningMode) = Nothing, Optional durationInMinutes As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of StacItem))