PlanetaryComputerModelFactory.GetItemInfoOptions Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Options for item info operations.

public static Azure.Analytics.PlanetaryComputer.GetItemInfoOptions GetItemInfoOptions(string collectionId = default, string itemId = default, string subdatasetName = default, System.Collections.Generic.IEnumerable<int> subdatasetBands = default, string crs = default, string datetime = default, System.Collections.Generic.IEnumerable<string> sel = default, Azure.Analytics.PlanetaryComputer.SelMethod? selMethod = default, System.Collections.Generic.IEnumerable<string> assets = default);

static member GetItemInfoOptions : string * string * string * seq<int> * string * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.SelMethod> * seq<string> -> Azure.Analytics.PlanetaryComputer.GetItemInfoOptions

Public Shared Function GetItemInfoOptions (Optional collectionId As String = Nothing, Optional itemId As String = Nothing, Optional subdatasetName As String = Nothing, Optional subdatasetBands As IEnumerable(Of Integer) = Nothing, Optional crs As String = Nothing, Optional datetime As String = Nothing, Optional sel As IEnumerable(Of String) = Nothing, Optional selMethod As Nullable(Of SelMethod) = Nothing, Optional assets As IEnumerable(Of String) = Nothing) As GetItemInfoOptions

Parameters

collectionId

String

STAC Collection Identifier.

itemId

String

STAC Item Identifier.

subdatasetName

String

The name of a subdataset within the asset.

subdatasetBands

IEnumerable<Int32>

The index of a subdataset band within the asset.

crs

String

Coordinate Reference System.

datetime

String

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples:

• A date-time: "2018-02-12T23:20:50Z"
• A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
• Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

Only features that have a temporal property that intersects the value of `datetime` are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.

sel

IEnumerable<String>

Xarray Indexing using dimension names {dimension}={value}.

selMethod

Nullable<SelMethod>

Xarray indexing method to use for inexact matches.

assets

IEnumerable<String>

Asset's names.

Returns

GetItemInfoOptions

A new GetItemInfoOptions instance for mocking.