PlanetaryComputerModelFactory.GetItemCollectionOptions Method

Definition

Options for the getItemCollection operation.

public static Azure.Analytics.PlanetaryComputer.GetItemCollectionOptions GetItemCollectionOptions(string collectionId = default, int? limit = default, System.Collections.Generic.IEnumerable<string> boundingBox = default, string datetime = default, Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode? sign = default, int? durationInMinutes = default, string token = default);
static member GetItemCollectionOptions : string * Nullable<int> * seq<string> * string * Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * string -> Azure.Analytics.PlanetaryComputer.GetItemCollectionOptions
Public Shared Function GetItemCollectionOptions (Optional collectionId As String = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional boundingBox As IEnumerable(Of String) = Nothing, Optional datetime As String = Nothing, Optional sign As Nullable(Of StacAssetUrlSigningMode) = Nothing, Optional durationInMinutes As Nullable(Of Integer) = Nothing, Optional token As String = Nothing) As GetItemCollectionOptions

Parameters

collectionId
String

Catalog collection id.

limit
Nullable<Int32>

The optional limit parameter recommends the number of items that should be present in the response document. Minimum = 1. Maximum = 10000. Default = 10.

boundingBox
IEnumerable<String>

Only features that have a geometry that intersects the bounding box are selected.

datetime
String

Either a date-time or an interval, open or closed.

sign
Nullable<StacAssetUrlSigningMode>

Whether to sign the asset urls.

durationInMinutes
Nullable<Int32>

The duration in minutes for which the signed url is valid.

token
String

The token to use for signing the asset urls.

Returns

A new GetItemCollectionOptions instance for mocking.

Applies to