GetSearchBboxAssetsOptions Class

Definition

Options for the getSearchBboxAssets operation.

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

Constructors

Name Description
GetSearchBboxAssetsOptions(String, Single, Single, Single, Single)

Initializes a new instance of GetSearchBboxAssetsOptions.

Properties

Name Description
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).

ItemsLimit

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

MaxX

Bounding box max X.

MaxY

Bounding box max Y.

MinX

Bounding box min X.

MinY

Bounding box min Y.

ScanLimit

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

SearchId

Search Id (pgSTAC Search Hash).

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

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<GetSearchBboxAssetsOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<GetSearchBboxAssetsOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<GetSearchBboxAssetsOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<GetSearchBboxAssetsOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<GetSearchBboxAssetsOptions>.Write(ModelReaderWriterOptions)

Applies to