GetCollectionPointAssetsOptions Class

Definition

Options for the getCollectionPointAssets operation.

public class GetCollectionPointAssetsOptions : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.GetCollectionPointAssetsOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.GetCollectionPointAssetsOptions>
type GetCollectionPointAssetsOptions = class
    interface IJsonModel<GetCollectionPointAssetsOptions>
    interface IPersistableModel<GetCollectionPointAssetsOptions>
Public Class GetCollectionPointAssetsOptions
Implements IJsonModel(Of GetCollectionPointAssetsOptions), IPersistableModel(Of GetCollectionPointAssetsOptions)
Inheritance
GetCollectionPointAssetsOptions
Implements

Constructors

Name Description
GetCollectionPointAssetsOptions(String, Single, Single)

Initializes a new instance of GetCollectionPointAssetsOptions.

Properties

Name Description
Bbox

Bounding box (west, south, east, north).

CollectionId

STAC Collection Identifier.

CoordinateReferenceSystem

Coordinate Reference System of the input coords. Default to epsg:4326.

Crs

Coordinate Reference System.

Datetime

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.
ExitWhenFull

Return as soon as the geometry is fully covered (defaults to True).

Ids

Array of Item ids.

ItemsLimit

Return as soon as we have N items per geometry (defaults to 100).

Latitude

Latitude.

Longitude

Longitude.

Query

JSON query expression for filtering items.

ScanLimit

Return as soon as we scan N items (defaults to 10000).

Sel

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

SelMethod

Xarray indexing method to use for inexact matches.

SkipCovered

Skip any items that would show up completely under the previous items (defaults to True).

SortBy

Sorting expression (e.g. +/-property).

SubdatasetBands

The index of a subdataset band within the asset.

SubdatasetName

The name of a subdataset within the asset.

TimeLimit

Return after N seconds to avoid long requests (defaults to 5).

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<GetCollectionPointAssetsOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<GetCollectionPointAssetsOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<GetCollectionPointAssetsOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<GetCollectionPointAssetsOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<GetCollectionPointAssetsOptions>.Write(ModelReaderWriterOptions)

Applies to