@azure/planetarycomputer package

Classes

PlanetaryComputerProClient

Interfaces

AssetMetadata	Asset metadata model.
AssetStatisticsResponse	Return dataset's statistics.
BandStatistics	Statistical information about a data band.
BandStatisticsMap	Map of band names to their statistics.
ClassMapLegendResponse	ClassMap legend response model.
DataCropCollectionFeatureByFormatOptionalParams	Optional parameters.
DataCropCollectionFeatureOptionalParams	Optional parameters.
DataCropCollectionFeatureWidthByHeightOptionalParams	Optional parameters.
DataCropFeatureByFormatOptionalParams	Optional parameters.
DataCropFeatureOptionalParams	Optional parameters.
DataCropFeatureWidthByHeightOptionalParams	Optional parameters.
DataCropSearchFeatureByFormatOptionalParams	Optional parameters.
DataCropSearchFeatureOptionalParams	Optional parameters.
DataCropSearchFeatureWidthByHeightOptionalParams	Optional parameters.
DataGetClassMapLegendOptionalParams	Optional parameters.
DataGetCollectionAssetsForBboxOptionalParams	Optional parameters.
DataGetCollectionAssetsForTileNoTmsOptionalParams	Optional parameters.
DataGetCollectionAssetsForTileOptionalParams	Optional parameters.
DataGetCollectionBboxCropOptionalParams	Optional parameters.
DataGetCollectionBboxCropWithDimensionsOptionalParams	Optional parameters.
DataGetCollectionInfoOptionalParams	Optional parameters.
DataGetCollectionPointAssetsOptionalParams	Optional parameters.
DataGetCollectionPointOptionalParams	Optional parameters.
DataGetCollectionTileByFormatOptionalParams	Optional parameters.
DataGetCollectionTileByScaleAndFormatOptionalParams	Optional parameters.
DataGetCollectionTileByScaleOptionalParams	Optional parameters.
DataGetCollectionTileJsonByTmsOptionalParams	Optional parameters.
DataGetCollectionTileJsonOptionalParams	Optional parameters.
DataGetCollectionTileNoTmsByFormatOptionalParams	Optional parameters.
DataGetCollectionTileNoTmsByScaleAndFormatOptionalParams	Optional parameters.
DataGetCollectionTileNoTmsByScaleOptionalParams	Optional parameters.
DataGetCollectionTileNoTmsOptionalParams	Optional parameters.
DataGetCollectionTileOptionalParams	Optional parameters.
DataGetCollectionTilesetMetadataOptionalParams	Optional parameters.
DataGetCollectionTilesetsOptionalParams	Optional parameters.
DataGetCollectionWmtsCapabilitiesByTmsOptionalParams	Optional parameters.
DataGetCollectionWmtsCapabilitiesOptionalParams	Optional parameters.
DataGetIntervalLegendOptionalParams	Optional parameters.
DataGetItemAssetStatisticsOptionalParams	Optional parameters.
DataGetItemAvailableAssetsOptionalParams	Optional parameters.
DataGetItemBboxCropOptionalParams	Optional parameters.
DataGetItemBboxCropWithDimensionsOptionalParams	Optional parameters.
DataGetItemBoundsOptionalParams	Optional parameters.
DataGetItemFeatureStatisticsOptionalParams	Optional parameters.
DataGetItemInfoGeoJsonOptionalParams	Optional parameters.
DataGetItemInfoOptionalParams	Optional parameters.
DataGetItemPointOptionalParams	Optional parameters.
DataGetItemPreviewOptionalParams	Optional parameters.
DataGetItemPreviewWithFormatOptionalParams	Optional parameters.
DataGetItemStatisticsOptionalParams	Optional parameters.
DataGetItemTileJsonByTmsOptionalParams	Optional parameters.
DataGetItemTileJsonOptionalParams	Optional parameters.
DataGetItemWmtsCapabilitiesByTmsOptionalParams	Optional parameters.
DataGetItemWmtsCapabilitiesOptionalParams	Optional parameters.
DataGetLegendOptionalParams	Optional parameters.
DataGetSearchAssetsForTileNoTmsOptionalParams	Optional parameters.
DataGetSearchAssetsForTileOptionalParams	Optional parameters.
DataGetSearchBboxAssetsOptionalParams	Optional parameters.
DataGetSearchBboxCropOptionalParams	Optional parameters.
DataGetSearchBboxCropWithDimensionsOptionalParams	Optional parameters.
DataGetSearchInfoOptionalParams	Optional parameters.
DataGetSearchPointOptionalParams	Optional parameters.
DataGetSearchPointWithAssetsOptionalParams	Optional parameters.
DataGetSearchTileByFormatOptionalParams	Optional parameters.
DataGetSearchTileByScaleAndFormatOptionalParams	Optional parameters.
DataGetSearchTileByScaleOptionalParams	Optional parameters.
DataGetSearchTileJsonByTmsOptionalParams	Optional parameters.
DataGetSearchTileJsonOptionalParams	Optional parameters.
DataGetSearchTileNoTmsByFormatOptionalParams	Optional parameters.
DataGetSearchTileNoTmsByScaleAndFormatOptionalParams	Optional parameters.
DataGetSearchTileNoTmsByScaleOptionalParams	Optional parameters.
DataGetSearchTileNoTmsOptionalParams	Optional parameters.
DataGetSearchTileOptionalParams	Optional parameters.
DataGetSearchTilesetMetadataOptionalParams	Optional parameters.
DataGetSearchTilesetsOptionalParams	Optional parameters.
DataGetSearchWmtsCapabilitiesByTmsOptionalParams	Optional parameters.
DataGetSearchWmtsCapabilitiesOptionalParams	Optional parameters.
DataGetTileByFormatOptionalParams	Optional parameters.
DataGetTileByScaleAndFormatOptionalParams	Optional parameters.
DataGetTileByScaleOptionalParams	Optional parameters.
DataGetTileMatricesOptionalParams	Optional parameters.
DataGetTileMatrixDefinitionsOptionalParams	Optional parameters.
DataGetTileNoTmsByFormatOptionalParams	Optional parameters.
DataGetTileNoTmsByScaleAndFormatOptionalParams	Optional parameters.
DataGetTileNoTmsByScaleOptionalParams	Optional parameters.
DataGetTileNoTmsOptionalParams	Optional parameters.
DataGetTileOptionalParams	Optional parameters.
DataGetTilesetMetadataOptionalParams	Optional parameters.
DataGetTilesetsOptionalParams	Optional parameters.
DataOperations	Interface representing a Data operations.
DataRegisterMosaicsSearchOptionalParams	Optional parameters.
DefaultLocation	Defines a default geographic location for map visualization.
ErrorInfo	Error information wrapper
Feature	GeoJSON Feature object representing a geographic entity
Geometry	Represents a GeoJSON geometry object as defined by RFC 7946. Supported geometry types include: Point: A single geographic coordinate. LineString: A sequence of geographic coordinates forming a line. Polygon: A closed shape defined by linear rings. MultiPoint: A collection of Points. MultiLineString: A collection of LineStrings. MultiPolygon: A collection of Polygons. Used for spatial filtering in STAC.
IngestionCancelAllOperationsOptionalParams	Optional parameters.
IngestionCancelOperationOptionalParams	Optional parameters.
IngestionCreateOptionalParams	Optional parameters.
IngestionCreateRunOptionalParams	Optional parameters.
IngestionCreateSourceOptionalParams	Optional parameters.
IngestionDefinition	Microsoft Planetary Computer Pro geo-catalog ingestion creation model
IngestionDeleteIngestionOptionalParams	Optional parameters.
IngestionDeleteSourceOptionalParams	Optional parameters.
IngestionGetOperationOptionalParams	Optional parameters.
IngestionGetOptionalParams	Optional parameters.
IngestionGetRunOptionalParams	Optional parameters.
IngestionGetSourceOptionalParams	Optional parameters.
IngestionListManagedIdentitiesOptionalParams	Optional parameters.
IngestionListOperationsOptionalParams	Optional parameters.
IngestionListOptionalParams	Optional parameters.
IngestionListRunsOptionalParams	Optional parameters.
IngestionListSourcesOptionalParams	Optional parameters.
IngestionOperations	Interface representing a Ingestion operations.
IngestionReplaceSourceOptionalParams	Optional parameters.
IngestionRun	Microsoft Planetary Computer Pro geo-catalog ingestion run
IngestionRunOperation	Microsoft Planetary Computer Pro geo-catalog ingestion run operation
IngestionSource	Ingestion Source
IngestionSourceSummary	Ingestion source summary
IngestionUpdateOptionalParams	Optional parameters.
LineString	Represents a LineString.
ManagedIdentityConnection	Managed Identity connection information
ManagedIdentityIngestionSource	Managed Identity ingestion source
ManagedIdentityMetadata	Managed Identity metadata
MosaicMetadata	Metadata information for mosaic or search results
MultiLineString	Represents a MultiLineString.
MultiPoint	Represents a MultiPoint.
MultiPolygon	Represents a MultiPolygon.
Operation	Microsoft Planetary Computer Pro geo-catalog operation
OperationStatusHistoryItem	Operation status history item
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PartitionType	Defines how data is partitioned for efficient storage and retrieval.
PlanetaryComputerProClientOptionalParams	Optional parameters for the client.
Point	Represents a GeoJSON Point geometry.
Polygon	Represents a Polygon.
QueryableDefinitionsResponse	Queryable definitions response.
RenderOption	Defines visualization parameters for rendering data on a map.
RenderOptionCondition	Defines a condition for enabling a render option.
RenderOptionLegend	Configuration for generating a data legend.
RenderOptionVectorOptions	Defines parameters for vector tile rendering.
RestorePollerOptions
SearchOptionsFields	FieldsExtension. Attributes: include: set of fields to include. exclude: set of fields to exclude. Controls which fields to include or exclude from the response.
SharedAccessSignatureGetTokenOptionalParams	Optional parameters.
SharedAccessSignatureGetUrlOptionalParams	Optional parameters.
SharedAccessSignatureOperations	Interface representing a SharedAccessSignature operations.
SharedAccessSignatureRevokeTokenOptionalParams	Optional parameters.
SharedAccessSignatureSignedLink	Represents a link that has not been signed with a SAS token. The expiry field will be null for unsigned links.
SharedAccessSignatureToken	Represents a Shared Access Signature (SAS) token response for accessing Azure Blob Storage.
SharedAccessSignatureTokenConnection	SAS Token connection information
SharedAccessSignatureTokenIngestionSource	SAS Token ingestion source
StacAddMosaicOptionalParams	Optional parameters.
StacAsset	https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#asset-object Represents a STAC asset, which is a file or resource associated with a STAC item.
StacAssetData	FormContent model for file upload.
StacCatalogCollections	http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_feature_collections_rootcollections Represents a collection of STAC collections with links.
StacCollection	https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md Represents a STAC collection.
StacCollectionTemporalExtent	https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Represents the temporal extent of a STAC collection with time intervals.
StacConformanceClasses	https://github.com/radiantearth/stac-api-spec/blob/master/api-spec.md#ogc-api---features-endpoints Represents the OGC API conformance declaration.
StacContextExtension	https://github.com/radiantearth/stac-api-spec/tree/master/extensions/context#context-extension-specification Context information for a search response including pagination details.
StacCreateCollectionAssetOptionalParams	Optional parameters.
StacCreateCollectionOptionalParams	Optional parameters.
StacCreateItemOptionalParams	Optional parameters.
StacCreateQueryablesOptionalParams	Optional parameters.
StacCreateRenderOptionOptionalParams	Optional parameters.
StacDeleteCollectionAssetOptionalParams	Optional parameters.
StacDeleteCollectionOptionalParams	Optional parameters.
StacDeleteItemOptionalParams	Optional parameters.
StacDeleteMosaicOptionalParams	Optional parameters.
StacDeleteQueryableOptionalParams	Optional parameters.
StacDeleteRenderOptionOptionalParams	Optional parameters.
StacExtensionExtent	https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#extent-object Represents the spatial and temporal extent of a STAC collection.
StacExtensionSpatialExtent	https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Represents the spatial extent of a STAC collection with bounding boxes.
StacGetCollectionConfigurationOptionalParams	Optional parameters.
StacGetCollectionOptionalParams	Optional parameters.
StacGetCollectionQueryablesOptionalParams	Optional parameters.
StacGetCollectionThumbnailOptionalParams	Optional parameters.
StacGetCollectionsOptionalParams	Optional parameters.
StacGetConformanceClassesOptionalParams	Optional parameters.
StacGetItemCollectionOptionalParams	Optional parameters.
StacGetItemOptionalParams	Optional parameters.
StacGetLandingPageOptionalParams	Optional parameters.
StacGetMosaicOptionalParams	Optional parameters.
StacGetMosaicsOptionalParams	Optional parameters.
StacGetPartitionTypeOptionalParams	Optional parameters.
StacGetQueryablesOptionalParams	Optional parameters.
StacGetRenderOptionOptionalParams	Optional parameters.
StacGetRenderOptionsOptionalParams	Optional parameters.
StacGetTileSettingsOptionalParams	Optional parameters.
StacItem	Represents a STAC Item, which is a GeoJSON Feature with additional metadata.
StacItemAsset	https://github.com/stac-extensions/item-assets Represents a STAC item asset, which describes the assets available under any item in the collection.
StacItemBounds	Geographic extent of a dataset expressed as a bounding box
StacItemCollection	https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/itemcollection-spec.md Represents a collection of STAC Items as a GeoJSON FeatureCollection.
StacItemOrStacItemCollection	Base type for STAC items and collections with discriminator.
StacItemPointAsset	Asset information for the specified point
StacItemProperties	Properties of a STAC Item containing metadata about the asset. https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#properties-object
StacItemStatisticsGeoJson	STAC Item representing a spatiotemporal asset with statistical information
StacItemStatisticsGeoJsonProperties	Properties for STAC Item statistics GeoJSON Feature
StacLandingPage	https://github.com/radiantearth/stac-api-spec/blob/master/api-spec.md#ogc-api---features-endpoints Represents the STAC API landing page with links to available resources.
StacLink	Link model. Ref: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml Represents a link.
StacMosaic	Defines a named mosaic with filtering criteria.
StacMosaicConfiguration	Configuration for data mosaic visualization.
StacOperations	Interface representing a Stac operations.
StacProvider	https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#provider-object Represents information about a data provider for STAC collections and items.
StacQueryable	Definition of a queryable field for STAC API filtering.
StacReplaceCollectionAssetOptionalParams	Optional parameters.
StacReplaceCollectionOptionalParams	Optional parameters.
StacReplaceItemOptionalParams	Optional parameters.
StacReplaceMosaicOptionalParams	Optional parameters.
StacReplacePartitionTypeOptionalParams	Optional parameters.
StacReplaceQueryableOptionalParams	Optional parameters.
StacReplaceRenderOptionOptionalParams	Optional parameters.
StacReplaceTileSettingsOptionalParams	Optional parameters.
StacSearchOptionalParams	Optional parameters.
StacSearchParameters	Search model. * Defines parameters for a STAC search POST request.
StacSortExtension	https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension Represents a sort specification for STAC API queries.
StacUpdateItemOptionalParams	Optional parameters.
TileJsonMetadata	TileJSON metadata describing a tile set according to the TileJSON specification Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0
TileMatrix	Tile Matrix Definition A tile matrix, usually corresponding to a particular zoom level of a TileMatrixSet. ref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrix.json Definition of a tile matrix at a specific zoom level within a tile matrix set
TileMatrixSet	https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrixSet.json A definition of a tile matrix set following the Tile Matrix Set standard. For tileset metadata, such a description (in tileMatrixSet property) is only required for offline use, as an alternative to a link with a http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme relation type.
TileMatrixSetBoundingBox	Geographic extent of the tile matrix set expressed in the specified coordinate reference system
TileMatrixSetLimitsEntry	Limits for a specific tile matrix within a tileset, defining the valid row/column range
TileSetBoundingBox	Bounding box for a tile set
TileSetEntry	Summary information about a single tileset within a list of available tilesets
TileSetLink	A link object used in OGC tile resources
TileSetList	Response containing a list of available tilesets
TileSetMetadata	Detailed metadata about a specific tileset, including tile matrix set limits
TileSettings	Configuration for map tile visualization.
TilerAssetGeoJson	Represents GeoJSON with feature with an asset property
TilerCoreModelsResponsesPoint	Response model for point query operations providing values at a specific location
TilerInfo	Dataset Info.
TilerInfoGeoJsonFeature	GeoJSON Feature object containing rio-tiler model information
TilerInfoMapResponse	Return dataset's basic info.
TilerMosaicSearchRegistrationResponse	Response from a successful mosaic registration with search ID and related links
TilerStacItemStatistics	Return dataset's statistics.
TilerStacSearchDefinition	Stored search query See: https://github.com/stac-utils/pgstac/blob/3499daa2bfa700ae7bb07503795c169bf2ebafc7/sql/004_search.sql#L907-L915
TilerStacSearchRegistration	Information about a registered STAC search query
UserCollectionSettings	User-specific collection settings for visualization.
VariableMatrixWidth	Model for variableMatrixWidth

Type Aliases

BandMetadataElement	Union type for band metadata elements
ColorMapNames	Available color maps for data visualization KnownColorMapNames can be used interchangeably with ColorMapNames, this enum contains the known values that the service supports. Known values supported by the service accent: Accent colormap - qualitative colormap with distinct colors accent_r: Reversed accent colormap afmhot: Afmhot colormap - sequential black-red-yellow-white colormap afmhot_r: Reversed afmhot colormap ai4g-lulc: AI for Good land use/land cover colormap alos-fnf: ALOS forest/non-forest colormap alos-palsar-mask: ALOS PALSAR mask colormap autumn: Autumn colormap - sequential red-orange-yellow colormap autumn_r: Reversed autumn colormap binary: Binary colormap - simple black and white colormap binary_r: Reversed binary colormap blues: Blues colormap - sequential white to dark blue blues_r: Reversed blues colormap bone: Bone colormap - grayscale with slight blue tint bone_r: Reversed bone colormap brbg: BrBG colormap - diverging brown to blue-green brbg_r: Reversed BrBG colormap brg: BrG colormap - diverging brown to green brg_r: Reversed BrG colormap bugn: BuGn colormap - sequential white to dark green bugn_r: Reversed BuGn colormap bupu: BuPu colormap - sequential white to dark purple bupu_r: Reversed BuPu colormap bwr: BWR colormap - diverging blue to red bwr_r: Reversed BWR colormap c-cap: C-CAP colormap - land cover classification cfastie: Cfastie colormap - high contrast colormap chesapeake-lc-13: Chesapeake land cover 13-class colormap chesapeake-lc-7: Chesapeake land cover 7-class colormap chesapeake-lu: Chesapeake land use colormap chloris-biomass: Chloris biomass colormap cividis: Cividis colormap - sequential yellow to blue cividis_r: Reversed cividis colormap cmrmap: CMRmap colormap - perceptually uniform colormap cmrmap_r: Reversed CMRmap colormap cool: Cool colormap - sequential cyan to magenta cool_r: Reversed cool colormap coolwarm: Coolwarm colormap - diverging blue to red coolwarm_r: Reversed coolwarm colormap copper: Copper colormap - sequential black to copper copper_r: Reversed copper colormap cubehelix: Cubehelix colormap - sequential black to white with hue rotation cubehelix_r: Reversed cubehelix colormap dark2: Dark2 colormap - qualitative colormap with distinct colors dark2_r: Reversed dark2 colormap drcog-lulc: DRCog land use/land cover colormap esa-cci-lc: ESA CCI land cover colormap esa-worldcover: ESA WorldCover colormap flag: Flag colormap - qualitative colormap with distinct colors flag_r: Reversed flag colormap gap-lulc: GAP land use/land cover colormap gist_earth: Gist_earth colormap - perceptually uniform colormap gist_earth_r: Reversed gist_earth colormap gist_gray: Gist_gray colormap - grayscale colormap gist_gray_r: Reversed gist_gray colormap gist_heat: Gist_heat colormap - sequential black-red-yellow-white colormap gist_heat_r: Reversed gist_heat colormap gist_ncar: Gist_ncar colormap - perceptually uniform colormap gist_ncar_r: Reversed gist_ncar colormap gist_rainbow: Gist_rainbow colormap - perceptually uniform colormap gist_rainbow_r: Reversed gist_rainbow colormap gist_stern: Gist_stern colormap - perceptually uniform colormap gist_stern_r: Reversed gist_stern colormap gist_yarg: Gist_yarg colormap - grayscale colormap gist_yarg_r: Reversed gist_yarg colormap gnbu: GnBu colormap - sequential white to dark blue-green gnbu_r: Reversed GnBu colormap gnuplot: Gnuplot colormap - sequential black to white with hue rotation gnuplot2: Gnuplot2 colormap - sequential black to white with hue rotation gnuplot2_r: Reversed gnuplot2 colormap gnuplot_r: Reversed gnuplot colormap gray: Gray colormap - grayscale colormap gray_r: Reversed gray colormap greens: Greens colormap - sequential white to dark green greens_r: Reversed greens colormap greys: Greys colormap - sequential white to dark gray greys_r: Reversed greys colormap hot: Hot colormap - sequential black-red-yellow-white colormap hot_r: Reversed hot colormap hsv: HSV colormap - hue-saturation-value colormap hsv_r: Reversed HSV colormap inferno: Inferno colormap - sequential black to yellow colormap inferno_r: Reversed inferno colormap io-bii: IO-BII colormap - biodiversity index colormap io-lulc: IO-LULC colormap - land use/land cover colormap io-lulc-9-class: IO-LULC 9-class colormap jet: Jet colormap - sequential blue-green-yellow-red colormap jet_r: Reversed jet colormap jrc-change: JRC change colormap jrc-extent: JRC extent colormap jrc-occurrence: JRC occurrence colormap jrc-recurrence: JRC recurrence colormap jrc-seasonality: JRC seasonality colormap jrc-transitions: JRC transitions colormap lidar-classification: Lidar classification colormap lidar-hag: Lidar height above ground colormap lidar-hag-alternative: Alternative lidar height above ground colormap lidar-intensity: Lidar intensity colormap lidar-returns: Lidar returns colormap magma: Magma colormap - sequential black to yellow colormap magma_r: Reversed magma colormap modis-10A1: MODIS 10A1 colormap modis-10A2: MODIS 10A2 colormap modis-13A1|Q1: MODIS 13A1|Q1 colormap modis-14A1|A2: MODIS 14A1|A2 colormap modis-15A2H|A3H: MODIS 15A2H|A3H colormap modis-16A3GF-ET: MODIS 16A3GF-ET colormap modis-16A3GF-PET: MODIS 16A3GF-PET colormap modis-17A2H|A2HGF: MODIS 17A2H|A2HGF colormap modis-17A3HGF: MODIS 17A3HGF colormap modis-64A1: MODIS 64A1 colormap mtbs-severity: MTBS severity colormap nipy_spectral: Nipy_spectral colormap - perceptually uniform colormap nipy_spectral_r: Reversed nipy_spectral colormap nrcan-lulc: NRCAN land use/land cover colormap ocean: Ocean colormap - sequential blue to white colormap ocean_r: Reversed ocean colormap oranges: Oranges colormap - sequential white to dark orange oranges_r: Reversed oranges colormap orrd: OrRd colormap - sequential white to dark red-orange orrd_r: Reversed OrRd colormap paired: Paired colormap - qualitative colormap with distinct colors paired_r: Reversed paired colormap pastel1: Pastel1 colormap - qualitative colormap with pastel colors pastel1_r: Reversed pastel1 colormap pastel2: Pastel2 colormap - qualitative colormap with pastel colors pastel2_r: Reversed pastel2 colormap pink: Pink colormap - sequential white to dark pink pink_r: Reversed pink colormap piyg: PiYG colormap - diverging pink to green piyg_r: Reversed PiYG colormap plasma: Plasma colormap - sequential black to yellow colormap plasma_r: Reversed plasma colormap prgn: PRGn colormap - diverging purple to green prgn_r: Reversed PRGn colormap prism: Prism colormap - qualitative colormap with distinct colors prism_r: Reversed prism colormap pubu: PuBu colormap - sequential white to dark blue pubu_r: Reversed PuBu colormap pubugn: PuBuGn colormap - sequential white to dark blue-green pubugn_r: Reversed PuBuGn colormap puor: PuOr colormap - diverging purple to orange puor_r: Reversed PuOr colormap purd: PuRd colormap - sequential white to dark purple-red purd_r: Reversed PuRd colormap purples: Purples colormap - sequential white to dark purple purples_r: Reversed purples colormap qpe: QPE colormap - qualitative colormap with distinct colors rainbow: Rainbow colormap - qualitative colormap with distinct colors rainbow_r: Reversed rainbow colormap rdbu: RdBu colormap - diverging red to blue rdbu_r: Reversed RdBu colormap rdgy: RdGy colormap - diverging red to gray rdgy_r: Reversed RdGy colormap rdpu: RdPu colormap - sequential white to dark red-purple rdpu_r: Reversed RdPu colormap rdylbu: RdYlBu colormap - diverging red to yellow to blue rdylbu_r: Reversed RdYlBu colormap rdylgn: RdYlGn colormap - diverging red to yellow to green rdylgn_r: Reversed RdYlGn colormap reds: Reds colormap - sequential white to dark red reds_r: Reversed reds colormap rplumbo: Rplumbo colormap - qualitative colormap with distinct colors schwarzwald: Schwarzwald colormap - qualitative colormap with distinct colors seismic: Seismic colormap - diverging blue to red seismic_r: Reversed seismic colormap set1: Set1 colormap - qualitative colormap with distinct colors set1_r: Reversed set1 colormap set2: Set2 colormap - qualitative colormap with distinct colors set2_r: Reversed set2 colormap set3: Set3 colormap - qualitative colormap with distinct colors set3_r: Reversed set3 colormap spectral: Spectral colormap - diverging red to yellow to blue spectral_r: Reversed spectral colormap spring: Spring colormap - sequential magenta to yellow spring_r: Reversed spring colormap summer: Summer colormap - sequential green to yellow summer_r: Reversed summer colormap tab10: Tab10 colormap - qualitative colormap with distinct colors tab10_r: Reversed tab10 colormap tab20: Tab20 colormap - qualitative colormap with distinct colors tab20_r: Reversed tab20 colormap tab20b: Tab20b colormap - qualitative colormap with distinct colors tab20b_r: Reversed tab20b colormap tab20c: Tab20c colormap - qualitative colormap with distinct colors tab20c_r: Reversed tab20c colormap terrain: Terrain colormap - sequential black to white with hue rotation terrain_r: Reversed terrain colormap twilight: Twilight colormap - diverging blue to red twilight_r: Reversed twilight colormap twilight_shifted: Twilight shifted colormap - diverging blue to red twilight_shifted_r: Reversed twilight shifted colormap usda-cdl: USDA CDL colormap - land cover classification usda-cdl-corn: USDA CDL corn colormap usda-cdl-cotton: USDA CDL cotton colormap usda-cdl-soybeans: USDA CDL soybeans colormap usda-cdl-wheat: USDA CDL wheat colormap usgs-lcmap: USGS LCMAP colormap viirs-10a1: VIIRS 10A1 colormap viirs-13a1: VIIRS 13A1 colormap viirs-14a1: VIIRS 14A1 colormap viirs-15a2H: VIIRS 15A2H colormap viridis: Viridis colormap - sequential black to yellow colormap viridis_r: Reversed viridis colormap winter: Winter colormap - sequential blue to green winter_r: Reversed winter colormap wistia: Wistia colormap - sequential white to yellow wistia_r: Reversed wistia colormap ylgn: YlGn colormap - sequential white to dark green ylgn_r: Reversed YlGn colormap ylgnbu: YlGnBu colormap - sequential white to dark blue-green ylgnbu_r: Reversed YlGnBu colormap ylorbr: YlOrBr colormap - sequential white to dark orange-brown ylorbr_r: Reversed YlOrBr colormap ylorrd: YlOrRd colormap - sequential white to dark red-orange ylorrd_r: Reversed YlOrRd colormap algae: Algae colormap - sequential green colormap for ocean data algae_r: Reversed algae colormap amp: Amp colormap - sequential magenta colormap for ocean data amp_r: Reversed amp colormap balance: Balance colormap - diverging blue to red for ocean data balance_r: Reversed balance colormap curl: Curl colormap - diverging teal to red for ocean data curl_r: Reversed curl colormap deep: Deep colormap - sequential blue colormap for ocean data deep_r: Reversed deep colormap delta: Delta colormap - diverging blue to green for ocean data delta_r: Reversed delta colormap dense: Dense colormap - sequential purple colormap for ocean data dense_r: Reversed dense colormap diff: Diff colormap - diverging colormap for difference data diff_r: Reversed diff colormap haline: Haline colormap - sequential blue to yellow for salinity data haline_r: Reversed haline colormap ice: Ice colormap - sequential blue colormap for ice data ice_r: Reversed ice colormap matter: Matter colormap - sequential yellow to brown for ocean data matter_r: Reversed matter colormap oxy: Oxy colormap - diverging colormap for oxygen data oxy_r: Reversed oxy colormap phase: Phase colormap - circular colormap for phase data phase_r: Reversed phase colormap rain: Rain colormap - sequential colormap for precipitation data rain_r: Reversed rain colormap solar: Solar colormap - sequential colormap for solar radiation data solar_r: Reversed solar colormap speed: Speed colormap - sequential colormap for velocity data speed_r: Reversed speed colormap tarn: Tarn colormap - sequential colormap for topographic data tarn_r: Reversed tarn colormap tempo: Tempo colormap - sequential colormap for temporal data tempo_r: Reversed tempo colormap thermal: Thermal colormap - sequential colormap for temperature data thermal_r: Reversed thermal colormap topo: Topo colormap - sequential colormap for topographic data topo_r: Reversed topo colormap turbid: Turbid colormap - sequential colormap for turbidity data turbid_r: Reversed turbid colormap turbo: Turbo colormap - improved rainbow colormap turbo_r: Reversed turbo colormap
ContinuablePage	An interface that describes a page of results.
DataCropCollectionFeatureByFormatResponse
DataCropCollectionFeatureResponse
DataCropCollectionFeatureWidthByHeightResponse
DataCropFeatureByFormatResponse
DataCropFeatureResponse
DataCropFeatureWidthByHeightResponse
DataCropSearchFeatureByFormatResponse
DataCropSearchFeatureResponse
DataCropSearchFeatureWidthByHeightResponse
DataGetCollectionAssetsForBboxResponse
DataGetCollectionAssetsForTileNoTmsResponse
DataGetCollectionBboxCropResponse
DataGetCollectionBboxCropWithDimensionsResponse
DataGetCollectionTileByFormatResponse
DataGetCollectionTileByScaleAndFormatResponse
DataGetCollectionTileByScaleResponse
DataGetCollectionTileNoTmsByFormatResponse
DataGetCollectionTileNoTmsByScaleAndFormatResponse
DataGetCollectionTileNoTmsByScaleResponse
DataGetCollectionTileNoTmsResponse
DataGetCollectionTileResponse
DataGetCollectionWmtsCapabilitiesByTmsResponse
DataGetCollectionWmtsCapabilitiesResponse
DataGetIntervalLegendResponse
DataGetItemAvailableAssetsResponse
DataGetItemBboxCropResponse
DataGetItemBboxCropWithDimensionsResponse
DataGetItemPreviewResponse
DataGetItemPreviewWithFormatResponse
DataGetItemWmtsCapabilitiesByTmsResponse
DataGetItemWmtsCapabilitiesResponse
DataGetLegendResponse
DataGetSearchAssetsForTileNoTmsResponse
DataGetSearchBboxAssetsResponse
DataGetSearchBboxCropResponse
DataGetSearchBboxCropWithDimensionsResponse
DataGetSearchTileByFormatResponse
DataGetSearchTileByScaleAndFormatResponse
DataGetSearchTileByScaleResponse
DataGetSearchTileNoTmsByFormatResponse
DataGetSearchTileNoTmsByScaleAndFormatResponse
DataGetSearchTileNoTmsByScaleResponse
DataGetSearchTileNoTmsResponse
DataGetSearchTileResponse
DataGetSearchWmtsCapabilitiesByTmsResponse
DataGetSearchWmtsCapabilitiesResponse
DataGetTileByFormatResponse
DataGetTileByScaleAndFormatResponse
DataGetTileByScaleResponse
DataGetTileMatricesResponse
DataGetTileNoTmsByFormatResponse
DataGetTileNoTmsByScaleAndFormatResponse
DataGetTileNoTmsByScaleResponse
DataGetTileNoTmsResponse
DataGetTileResponse
FeatureType	Type identifier for GeoJSON Feature objects KnownFeatureType can be used interchangeably with FeatureType, this enum contains the known values that the service supports. Known values supported by the service Feature: Standard GeoJSON Feature type identifier
FileContents	Valid values for the contents of a binary file.
FilterLanguage	Choices for filter-lang value in a POST request. Based on https://github.com/stac-api-extensions/filter#queryables Note the addition of cql2-json, which is used by the pgstac backend, but is not included in the spec above. Defines the supported filter languages for STAC API queries. KnownFilterLanguage can be used interchangeably with FilterLanguage, this enum contains the known values that the service supports. Known values supported by the service cql-json: Common Query Language in JSON format. cql2-json: Common Query Language 2 in JSON format cql2-text: Common Query Language 2 in text format.
GeometryType	Represents the type of a GeoJSON geometry. KnownGeometryType can be used interchangeably with GeometryType, this enum contains the known values that the service supports. Known values supported by the service Point: Represents a Point geometry. LineString: Represents a LineString geometry. Polygon: Represents a Polygon geometry. MultiPoint: Represents a MultiPoint geometry. MultiLineString: Represents a MultiLineString geometry. MultiPolygon: Represents a MultiPolygon geometry.
GeometryUnion	Alias for GeometryUnion
IngestionSourceType	Ingestion source type KnownIngestionSourceType can be used interchangeably with IngestionSourceType, this enum contains the known values that the service supports. Known values supported by the service SasToken: Azure Blob Storage SAS token BlobManagedIdentity: Azure Blob Managed Identity
IngestionSourceUnion	Alias for IngestionSourceUnion
IngestionStatus	Ingestion status KnownIngestionStatus can be used interchangeably with IngestionStatus, this enum contains the known values that the service supports. Known values supported by the service Ready: Ingestion accepted and ready to be run Deleting: Ingestion is being deleting in the background
IngestionType	Ingestion type KnownIngestionType can be used interchangeably with IngestionType, this enum contains the known values that the service supports. Known values supported by the service StaticCatalog: Static STAC Catalog StacGeoparquet: Ingestion STAC Geoparquet catalog
LegendConfigType	Legend type to make, one of: continuous, classmap, interval or none (note, none is a string literal). KnownLegendConfigType can be used interchangeably with LegendConfigType, this enum contains the known values that the service supports. Known values supported by the service continuous: Continuous color ramp legend. classmap: Classified map with discrete colors for classes. interval: Interval-based legend with discrete ranges. none: No legend.
MosaicMetadataType	Type of metadata resource in the system KnownMosaicMetadataType can be used interchangeably with MosaicMetadataType, this enum contains the known values that the service supports. Known values supported by the service mosaic: Metadata for a mosaic of multiple raster assets search: Metadata for a search query result
NoDataType	NoDataType KnownNoDataType can be used interchangeably with NoDataType, this enum contains the known values that the service supports. Known values supported by the service Alpha: Nodata represented by alpha channel Mask: Nodata represented by a mask Internal: Nodata represented internally in the dataset Nodata: Explicit nodata value defined in the dataset None: No nodata value defined
NodeReadableStream	Type alias for Node.js ReadableStream. On Node targets this resolves to the actual NodeJS.ReadableStream type. On browser/react-native targets the platform variant resolves to never, which drops out of union types naturally.
OperationStatus	Operation status KnownOperationStatus can be used interchangeably with OperationStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Operation accepted and ready to be run Running: Operation is running Succeeded: Operation has already finished its execution Canceled: Operation canceled by the user Canceling: Operation is being canceling Failed: Operation failed
PartitionTypeScheme	Defines partitioning schemes for temporal data organization. KnownPartitionTypeScheme can be used interchangeably with PartitionTypeScheme, this enum contains the known values that the service supports. Known values supported by the service year: Partition data by year. month: Partition data by month. none: No partitioning.
PixelSelection	Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') Represents the method used to select or compute pixels when creating composites from multiple sources KnownPixelSelection can be used interchangeably with PixelSelection, this enum contains the known values that the service supports. Known values supported by the service first: Select pixel from the first available image highest: Select pixel with the highest value lowest: Select pixel with the lowest value mean: Calculate mean of available pixels median: Calculate median of available pixels stdev: Calculate standard deviation of available pixels lastbandlow: Select image with lowest value in the last band lastbandhigh: Select image with highest value in the last band count: Count available pixels across sources
RenderOptionType	Specifies the types of render options for map visualization. KnownRenderOptionType can be used interchangeably with RenderOptionType, this enum contains the known values that the service supports. Known values supported by the service raster-tile: Raster tile rendering type. vt-polygon: Vector tile polygon rendering type. vt-line: Vector tile line rendering type.
Resampling	Resampling algorithm to use when reading source raster data at different resolutions KnownResampling can be used interchangeably with Resampling, this enum contains the known values that the service supports. Known values supported by the service nearest: Nearest neighbor - fastest method that selects the closest pixel value bilinear: Bilinear interpolation - calculates output values using a weighted average of 2x2 input cells cubic: Cubic interpolation - uses a weighted average of 4x4 input cells for smoother results cubic_spline: Cubic spline interpolation - similar to cubic but preserves edges better lanczos: Lanczos windowed sinc resampling - high-quality with minimal artifacts average: Average resampling - calculates the mean of all contributing pixels mode: Mode resampling - selects the most common value from contributing pixels gauss: Gaussian weighted resampling - applies a gaussian weighting to contributing pixels rms: Root mean square resampling - useful for resampling error or deviation grids
SelMethod	Xarray indexing method to use for inexact matches KnownSelMethod can be used interchangeably with SelMethod, this enum contains the known values that the service supports. Known values supported by the service nearest: Nearest neighbor method linear: Linear interpolation bilinear: Bilinear interpolation cubic: Cubic interpolation cubic_spline: Cubic spline interpolation lanczos: Lanczos interpolation area: Area-weighted interpolation mode: Mode (most common) value
StacAssetUrlSigningMode	Represent the signature type for asset URLs. KnownStacAssetUrlSigningMode can be used interchangeably with StacAssetUrlSigningMode, this enum contains the known values that the service supports. Known values supported by the service true: Sign asset URLs in the response. false: Do not sign asset URLs in the response.
StacGetCollectionThumbnailResponse
StacItemOrStacItemCollectionUnion	Alias for StacItemOrStacItemCollectionUnion
StacLinkType	MIME types for links. KnownStacLinkType can be used interchangeably with StacLinkType, this enum contains the known values that the service supports. Known values supported by the service image/tiff; application=geotiff: Represents an image/tiff with application=geotiff. image/jp2: Represents an image/jp2. image/png: Represents an image/png. image/jpeg: Represents an image/jpeg. image/jpg: Represents an image/jpg. image/webp: Represents an image/webp. application/x-binary: Represents an application/x-binary. application/xml: Represents an application/xml. application/json: Represents an application/json. application/geo+json: Represents an application/geo+json. text/html: Represents a text/html. text/plain: Represents a text/plain. application/x-protobuf: Represents an application/x-protobuf.
StacModelType	Enum discriminator for STAC item and collection types. KnownStacModelType can be used interchangeably with StacModelType, this enum contains the known values that the service supports. Known values supported by the service Feature: GeoJSON Feature type. FeatureCollection: GeoJSON FeatureCollection type.
StacQueryableDefinitionDataType	Queryable data types for the queryables extension. These are the data types supported by Basic CQL2. KnownStacQueryableDefinitionDataType can be used interchangeably with StacQueryableDefinitionDataType, this enum contains the known values that the service supports. Known values supported by the service string: Character strings. Example: 'This is a literal string.' number: Numbers including integers and floating point values. Examples: -100, 3.14159 boolean: Booleans. Examples: true, false timestamp: An instant with a granularity of a second or smaller. Example (JSON): { "timestamp": "1969-07-20T20:17:40Z" } date: An instant with a granularity of a day. Example (JSON): { "date": "1969-07-20" }
StacSearchSortingDirection	Defines the sorting directions for query results in STAC API. KnownStacSearchSortingDirection can be used interchangeably with StacSearchSortingDirection, this enum contains the known values that the service supports. Known values supported by the service asc: Sort results in ascending order. desc: Sort results in descending order.
TerrainAlgorithm	Supported algorithms for terrain and index-based analysis KnownTerrainAlgorithm can be used interchangeably with TerrainAlgorithm, this enum contains the known values that the service supports. Known values supported by the service hillshade: Creates hillshade visualization from elevation data contours: Generates elevation contour lines normalizedIndex: Calculates normalized difference index between bands terrarium: Encodes elevation data in Mapbox Terrarium RGB format terrainrgb: Encodes elevation data in Mapbox TerrainRGB format slope: Calculates slope from elevation data cast: Casts data to a different type ceil: Rounds values up to the nearest integer floor: Rounds values down to the nearest integer min: Computes the minimum value across bands max: Computes the maximum value across bands median: Computes the median value across bands mean: Computes the mean value across bands std: Computes the standard deviation across bands var: Computes the variance across bands
TileAddressingScheme	Scheme for tile addressing in TileJSON specification KnownTileAddressingScheme can be used interchangeably with TileAddressingScheme, this enum contains the known values that the service supports. Known values supported by the service xyz: XYZ tile addressing scheme with origin at top-left tms: TMS tile addressing scheme with origin at bottom-left
TileMatrixCornerOfOrigin	The corner of the tile matrix (topLeft or bottomLeft) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile. KnownTileMatrixCornerOfOrigin can be used interchangeably with TileMatrixCornerOfOrigin, this enum contains the known values that the service supports. Known values supported by the service topLeft: Origin at the top-left corner (Y increases downward) bottomLeft: Origin at the bottom-left corner (Y increases upward)
TileMatrixSetId	Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') Standard identifier for a coordinate reference system and tiling scheme used for serving map tiles KnownTileMatrixSetId can be used interchangeably with TileMatrixSetId, this enum contains the known values that the service supports. Known values supported by the service CanadianNAD83_LCC: Canadian NAD83 Lambert Conformal Conic projection tile matrix set EuropeanETRS89_LAEAQuad: European ETRS89 Lambert Azimuthal Equal Area Quad tile matrix set LINZAntarticaMapTilegrid: Land Information New Zealand (LINZ) Antarctica Map tile grid matrix set NZTM2000Quad: New Zealand Transverse Mercator 2000 Quad tile matrix set UPSAntarcticWGS84Quad: Universal Polar Stereographic Antarctic WGS84 Quad tile matrix set UPSArcticWGS84Quad: Universal Polar Stereographic Arctic WGS84 Quad tile matrix set UTM31WGS84Quad: Universal Transverse Mercator Zone 31 WGS84 Quad tile matrix set WGS1984Quad: WGS 1984 Quad tile matrix set WebMercatorQuad: Web Mercator Quad tile matrix set WorldCRS84Quad: World CRS84 Quad tile matrix set WorldMercatorWGS84Quad: World Mercator WGS84 Quad tile matrix set
TilerImageFormat	Image format specifier for tile and image requests KnownTilerImageFormat can be used interchangeably with TilerImageFormat, this enum contains the known values that the service supports. Known values supported by the service png: Portable Network Graphics format - supports transparency npy: NumPy array format for raw data access tif: GeoTIFF format for georeferenced raster data jpeg: JPEG format - smaller file size but lossy compression jpg: Alternate extension for JPEG format jp2: JPEG 2000 format - supports both lossy and lossless compression webp: WebP format - modern image format with good compression pngraw: Raw PNG format for access to unprocessed data
WarpKernelResampling	WarpKernel resampling algorithm used when doing re-projection. Defaults to nearest. KnownWarpKernelResampling can be used interchangeably with WarpKernelResampling, this enum contains the known values that the service supports. Known values supported by the service nearest: Nearest neighbor bilinear: Bilinear interpolation cubic: Cubic interpolation cubic_spline: Cubic spline interpolation lanczos: Lanczos windowed sinc resampling average: Average resampling mode: Mode resampling max: Maximum value resampling min: Minimum value resampling med: Median value resampling q1: First quartile resampling q3: Third quartile resampling sum: Sum resampling rms: Root mean square resampling

Enums

KnownColorMapNames	Available color maps for data visualization
KnownFeatureType	Type identifier for GeoJSON Feature objects
KnownFilterLanguage	Choices for filter-lang value in a POST request. Based on https://github.com/stac-api-extensions/filter#queryables Note the addition of cql2-json, which is used by the pgstac backend, but is not included in the spec above. Defines the supported filter languages for STAC API queries.
KnownGeometryType	Represents the type of a GeoJSON geometry.
KnownIngestionSourceType	Ingestion source type
KnownIngestionStatus	Ingestion status
KnownIngestionType	Ingestion type
KnownLegendConfigType	Legend type to make, one of: continuous, classmap, interval or none (note, none is a string literal).
KnownMosaicMetadataType	Type of metadata resource in the system
KnownNoDataType	NoDataType
KnownOperationStatus	Operation status
KnownPartitionTypeScheme	Defines partitioning schemes for temporal data organization.
KnownPixelSelection	Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') Represents the method used to select or compute pixels when creating composites from multiple sources
KnownRenderOptionType	Specifies the types of render options for map visualization.
KnownResampling	Resampling algorithm to use when reading source raster data at different resolutions
KnownSelMethod	Xarray indexing method to use for inexact matches
KnownStacAssetUrlSigningMode	Represent the signature type for asset URLs.
KnownStacLinkType	MIME types for links.
KnownStacModelType	Enum discriminator for STAC item and collection types.
KnownStacQueryableDefinitionDataType	Queryable data types for the queryables extension. These are the data types supported by Basic CQL2.
KnownStacSearchSortingDirection	Defines the sorting directions for query results in STAC API.
KnownTerrainAlgorithm	Supported algorithms for terrain and index-based analysis
KnownTileAddressingScheme	Scheme for tile addressing in TileJSON specification
KnownTileMatrixCornerOfOrigin	The corner of the tile matrix (topLeft or bottomLeft) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile.
KnownTileMatrixSetId	Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') Standard identifier for a coordinate reference system and tiling scheme used for serving map tiles
KnownTilerImageFormat	Image format specifier for tile and image requests
KnownVersions	Represents version information.
KnownWarpKernelResampling	WarpKernel resampling algorithm used when doing re-projection. Defaults to nearest.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(PlanetaryComputerProClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(PlanetaryComputerProClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: PlanetaryComputerProClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

PlanetaryComputerProClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor