StacSearchParameters Class

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

StacSearchParameters.cs

Search model. * Defines parameters for a STAC search POST request.

public class StacSearchParameters : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.StacSearchParameters>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.StacSearchParameters>

type StacSearchParameters = class
    interface IJsonModel<StacSearchParameters>
    interface IPersistableModel<StacSearchParameters>

Public Class StacSearchParameters
Implements IJsonModel(Of StacSearchParameters), IPersistableModel(Of StacSearchParameters)

Inheritance

Object

StacSearchParameters

Implements

IJsonModel<StacSearchParameters> IPersistableModel<StacSearchParameters> IPersistableModel<T>

Constructors

Name	Description
StacSearchParameters()	Initializes a new instance of StacSearchParameters.

Properties

Name	Description
BoundingBox	Bounding box for spatial filtering in format [west, south, east, north].
Collections	List of collection IDs to search within.
ConformanceClass	Conf Overrides datetime validation from the base request model. To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo". BinaryData.FromString("\"foo\""). : Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.
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.
Fields	Specifies which fields to include or exclude in the STAC search results. See the STAC Fields Extension.
Filter	CQL2 Filter See the STAC Filter Extension. To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo". BinaryData.FromString("\"foo\""). : Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.
FilterCoordinateReferenceSystem	Coordinate reference system for the filter.
FilterLang	Filter language to use for the filter expression.
Ids	List of specific item IDs to return.
Intersects	GeoJSON geometry for spatial filtering.
Limit	Maximum number of results to return.
Query	STAC Query See the STAC Query Extension. To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo". BinaryData.FromString("\"foo\""). : Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.
SortBy	Sort criteria for the search results. See the STAC Sort Extension.
Token	Pagination token for fetching the next set of results.

Methods

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

Operators

Name	Description
Implicit(StacSearchParameters to RequestContent)

Explicit Interface Implementations

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