PlanetaryComputerModelFactory.GetItemCollectionOptions Method
Definition
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.
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.
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.
Whether to sign the asset urls.
- token
- String
The token to use for signing the asset urls.
Returns
A new GetItemCollectionOptions instance for mocking.