RegisterMosaic Class

Definition

Input parameters for registering a new mosaic of STAC items.

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

Constructors

Name Description
RegisterMosaic()

Initializes a new instance of RegisterMosaic.

Properties

Name Description
BoundingBox

Geographic bounding box to filter items [west, south, east, north].

Collections

List of STAC collection IDs to include in the mosaic.

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

Filter

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" }.

FilterLanguage

Query language format used in the filter parameter.

Ids

List of specific STAC item IDs to include in the mosaic.

Intersects

GeoJSON geometry to spatially filter items by intersection.

Metadata

Additional metadata to associate with the mosaic.

Query

Query

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

Criteria for ordering items in the mosaic.

Methods

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

Explicit Interface Implementations

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

Applies to