StacClient.GetItem Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
GetItem(String, String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)	Fetch a single STAC Item.
GetItem(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.

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

Source:

StacClient.cs

Fetch a single STAC Item.

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

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

Public Overridable Function GetItem (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 Response(Of StacItem)

Parameters

collectionId

String

Catalog collection id.

itemId

String

STAC Item id.

sign

Nullable<StacAssetUrlSigningMode>

Whether to sign asset URLs in the response.

durationInMinutes

Nullable<Int32>

URL signature duration in minutes.

cancellationToken

CancellationToken

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

Returns

Response<StacItem>

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.

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

abstract member GetItem : string * string * string * Nullable<int> * Azure.RequestContext -> Azure.Response
override this.GetItem : string * string * string * Nullable<int> * Azure.RequestContext -> Azure.Response

Public Overridable Function GetItem (collectionId As String, itemId As String, sign As String, durationInMinutes As Nullable(Of Integer), context As RequestContext) As 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

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.