StacOperations interface
Interface representing a Stac operations.
Properties
| add |
Add a mosaic definition to a given collection |
| create |
Create a new collection in the GeoCatalog instance |
| create |
Create a new asset in the Collection metadata and write the associated file to managed storage. |
| create |
Create a new STAC item or a set of items in a collection |
| create |
Set queryables for a collection given a list of queryable definitions |
| create |
Add a render option for a given collection |
| delete |
Delete a collection in the GeoCatalog instance |
| delete |
Delete an asset from a given collection. |
| delete |
Delete a STAC item from a collection |
| delete |
Delete a mosaic definition from a given collection |
| delete |
Delete queryables by name for specified collection. |
| delete |
Delete a render option for a given collection |
| get |
Get a collection in the GeoCatalog instance |
| get |
Get the complete user configuration for a given collection |
| get |
List all queryables in a given collection |
| get |
List all collections in the GeoCatalog instance |
| get |
Get thumbnail for given collection. |
| get |
Returns the STAC conformance classes. |
| get |
Fetch a single STAC Item |
| get |
Fetch features of the feature collection with id Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema. |
| get |
Return the STAC landing page. |
| get |
Get a mosaic definition from a given collection |
| get |
Get the mosaic definitions for a given collection |
| get |
Get the partitiontype for a GeoCatalog Collection. |
| get |
List all queryables in the GeoCatalog instance |
| get |
Get a render option for a given collection |
| get |
Get all render options for a given collection |
| get |
Get the tile settings for a given collection |
| replace |
Replace an existing collection in the GeoCatalog instance |
| replace |
Update an existing asset in a given collection. |
| replace |
Replace a STAC item in a collection |
| replace |
Update a mosaic definition from a given collection |
| replace |
Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded. Ideal partitioning schemes result in partitions of roughly 100k items each. The default partitioning scheme is "none" which does not partition items. |
| replace |
Updates a queryable given a queryable definition and corresponding collection id. |
| replace |
Update a render option for a given collection |
| replace |
Update the tile settings for a given collection |
| search | STAC search operation. |
| update |
Update a STAC item in a collection |
Property Details
addMosaic
Add a mosaic definition to a given collection
addMosaic: (collectionId: string, body: StacMosaic, options?: StacAddMosaicOptionalParams) => Promise<StacMosaic>Property Value
(collectionId: string, body: StacMosaic, options?: StacAddMosaicOptionalParams) => Promise<StacMosaic>
createCollection
Create a new collection in the GeoCatalog instance
createCollection: (body: StacCollection, options?: StacCreateCollectionOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(body: StacCollection, options?: StacCreateCollectionOptionalParams) => PollerLike<OperationState<void>, void>
createCollectionAsset
Create a new asset in the Collection metadata and write the associated file to managed storage.
createCollectionAsset: (collectionId: string, body: StacAssetData, options?: StacCreateCollectionAssetOptionalParams) => Promise<StacCollection>Property Value
(collectionId: string, body: StacAssetData, options?: StacCreateCollectionAssetOptionalParams) => Promise<StacCollection>
createItem
Create a new STAC item or a set of items in a collection
createItem: (collectionId: string, body: StacItemOrStacItemCollectionUnion, options?: StacCreateItemOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(collectionId: string, body: StacItemOrStacItemCollectionUnion, options?: StacCreateItemOptionalParams) => PollerLike<OperationState<void>, void>
createQueryables
Set queryables for a collection given a list of queryable definitions
createQueryables: (collectionId: string, body: StacQueryable[], options?: StacCreateQueryablesOptionalParams) => Promise<StacQueryable[]>Property Value
(collectionId: string, body: StacQueryable[], options?: StacCreateQueryablesOptionalParams) => Promise<StacQueryable[]>
createRenderOption
Add a render option for a given collection
createRenderOption: (collectionId: string, body: RenderOption, options?: StacCreateRenderOptionOptionalParams) => Promise<RenderOption>Property Value
(collectionId: string, body: RenderOption, options?: StacCreateRenderOptionOptionalParams) => Promise<RenderOption>
deleteCollection
Delete a collection in the GeoCatalog instance
deleteCollection: (collectionId: string, options?: StacDeleteCollectionOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(collectionId: string, options?: StacDeleteCollectionOptionalParams) => PollerLike<OperationState<void>, void>
deleteCollectionAsset
Delete an asset from a given collection.
deleteCollectionAsset: (collectionId: string, assetId: string, options?: StacDeleteCollectionAssetOptionalParams) => Promise<StacCollection>Property Value
(collectionId: string, assetId: string, options?: StacDeleteCollectionAssetOptionalParams) => Promise<StacCollection>
deleteItem
Delete a STAC item from a collection
deleteItem: (collectionId: string, itemId: string, options?: StacDeleteItemOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(collectionId: string, itemId: string, options?: StacDeleteItemOptionalParams) => PollerLike<OperationState<void>, void>
deleteMosaic
Delete a mosaic definition from a given collection
deleteMosaic: (collectionId: string, mosaicId: string, options?: StacDeleteMosaicOptionalParams) => Promise<void>Property Value
(collectionId: string, mosaicId: string, options?: StacDeleteMosaicOptionalParams) => Promise<void>
deleteQueryable
Delete queryables by name for specified collection.
deleteQueryable: (collectionId: string, queryableName: string, options?: StacDeleteQueryableOptionalParams) => Promise<void>Property Value
(collectionId: string, queryableName: string, options?: StacDeleteQueryableOptionalParams) => Promise<void>
deleteRenderOption
Delete a render option for a given collection
deleteRenderOption: (collectionId: string, renderOptionId: string, options?: StacDeleteRenderOptionOptionalParams) => Promise<void>Property Value
(collectionId: string, renderOptionId: string, options?: StacDeleteRenderOptionOptionalParams) => Promise<void>
getCollection
Get a collection in the GeoCatalog instance
getCollection: (collectionId: string, options?: StacGetCollectionOptionalParams) => Promise<StacCollection>Property Value
(collectionId: string, options?: StacGetCollectionOptionalParams) => Promise<StacCollection>
getCollectionConfiguration
Get the complete user configuration for a given collection
getCollectionConfiguration: (collectionId: string, options?: StacGetCollectionConfigurationOptionalParams) => Promise<UserCollectionSettings>Property Value
(collectionId: string, options?: StacGetCollectionConfigurationOptionalParams) => Promise<UserCollectionSettings>
getCollectionQueryables
List all queryables in a given collection
getCollectionQueryables: (collectionId: string, options?: StacGetCollectionQueryablesOptionalParams) => Promise<QueryableDefinitionsResponse>Property Value
(collectionId: string, options?: StacGetCollectionQueryablesOptionalParams) => Promise<QueryableDefinitionsResponse>
getCollections
List all collections in the GeoCatalog instance
getCollections: (options?: StacGetCollectionsOptionalParams) => Promise<StacCatalogCollections>Property Value
(options?: StacGetCollectionsOptionalParams) => Promise<StacCatalogCollections>
getCollectionThumbnail
Get thumbnail for given collection.
getCollectionThumbnail: (collectionId: string, options?: StacGetCollectionThumbnailOptionalParams) => Promise<StacGetCollectionThumbnailResponse>Property Value
(collectionId: string, options?: StacGetCollectionThumbnailOptionalParams) => Promise<StacGetCollectionThumbnailResponse>
getConformanceClasses
Returns the STAC conformance classes.
getConformanceClasses: (options?: StacGetConformanceClassesOptionalParams) => Promise<StacConformanceClasses>Property Value
(options?: StacGetConformanceClassesOptionalParams) => Promise<StacConformanceClasses>
getItem
Fetch a single STAC Item
getItem: (collectionId: string, itemId: string, options?: StacGetItemOptionalParams) => Promise<StacItem>Property Value
(collectionId: string, itemId: string, options?: StacGetItemOptionalParams) => Promise<StacItem>
getItemCollection
Fetch features of the feature collection with id collectionId.
Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema.
getItemCollection: (collectionId: string, options?: StacGetItemCollectionOptionalParams) => Promise<StacItemCollection>Property Value
(collectionId: string, options?: StacGetItemCollectionOptionalParams) => Promise<StacItemCollection>
getLandingPage
Return the STAC landing page.
getLandingPage: (options?: StacGetLandingPageOptionalParams) => Promise<StacLandingPage>Property Value
(options?: StacGetLandingPageOptionalParams) => Promise<StacLandingPage>
getMosaic
Get a mosaic definition from a given collection
getMosaic: (collectionId: string, mosaicId: string, options?: StacGetMosaicOptionalParams) => Promise<StacMosaic>Property Value
(collectionId: string, mosaicId: string, options?: StacGetMosaicOptionalParams) => Promise<StacMosaic>
getMosaics
Get the mosaic definitions for a given collection
getMosaics: (collectionId: string, options?: StacGetMosaicsOptionalParams) => Promise<StacMosaic[]>Property Value
(collectionId: string, options?: StacGetMosaicsOptionalParams) => Promise<StacMosaic[]>
getPartitionType
Get the partitiontype for a GeoCatalog Collection.
getPartitionType: (collectionId: string, options?: StacGetPartitionTypeOptionalParams) => Promise<PartitionType>Property Value
(collectionId: string, options?: StacGetPartitionTypeOptionalParams) => Promise<PartitionType>
getQueryables
List all queryables in the GeoCatalog instance
getQueryables: (options?: StacGetQueryablesOptionalParams) => Promise<QueryableDefinitionsResponse>Property Value
(options?: StacGetQueryablesOptionalParams) => Promise<QueryableDefinitionsResponse>
getRenderOption
Get a render option for a given collection
getRenderOption: (collectionId: string, renderOptionId: string, options?: StacGetRenderOptionOptionalParams) => Promise<RenderOption>Property Value
(collectionId: string, renderOptionId: string, options?: StacGetRenderOptionOptionalParams) => Promise<RenderOption>
getRenderOptions
Get all render options for a given collection
getRenderOptions: (collectionId: string, options?: StacGetRenderOptionsOptionalParams) => Promise<RenderOption[]>Property Value
(collectionId: string, options?: StacGetRenderOptionsOptionalParams) => Promise<RenderOption[]>
getTileSettings
Get the tile settings for a given collection
getTileSettings: (collectionId: string, options?: StacGetTileSettingsOptionalParams) => Promise<TileSettings>Property Value
(collectionId: string, options?: StacGetTileSettingsOptionalParams) => Promise<TileSettings>
replaceCollection
Replace an existing collection in the GeoCatalog instance
replaceCollection: (collectionId: string, body: StacCollection, options?: StacReplaceCollectionOptionalParams) => Promise<StacCollection>Property Value
(collectionId: string, body: StacCollection, options?: StacReplaceCollectionOptionalParams) => Promise<StacCollection>
replaceCollectionAsset
Update an existing asset in a given collection.
replaceCollectionAsset: (collectionId: string, assetId: string, body: StacAssetData, options?: StacReplaceCollectionAssetOptionalParams) => Promise<StacCollection>Property Value
(collectionId: string, assetId: string, body: StacAssetData, options?: StacReplaceCollectionAssetOptionalParams) => Promise<StacCollection>
replaceItem
Replace a STAC item in a collection
replaceItem: (collectionId: string, itemId: string, body: StacItem, options?: StacReplaceItemOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(collectionId: string, itemId: string, body: StacItem, options?: StacReplaceItemOptionalParams) => PollerLike<OperationState<void>, void>
replaceMosaic
Update a mosaic definition from a given collection
replaceMosaic: (collectionId: string, mosaicId: string, body: StacMosaic, options?: StacReplaceMosaicOptionalParams) => Promise<StacMosaic>Property Value
(collectionId: string, mosaicId: string, body: StacMosaic, options?: StacReplaceMosaicOptionalParams) => Promise<StacMosaic>
replacePartitionType
Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded.
Ideal partitioning schemes result in partitions of roughly 100k items each.
The default partitioning scheme is "none" which does not partition items.
replacePartitionType: (collectionId: string, body: PartitionType, options?: StacReplacePartitionTypeOptionalParams) => Promise<void>Property Value
(collectionId: string, body: PartitionType, options?: StacReplacePartitionTypeOptionalParams) => Promise<void>
replaceQueryable
Updates a queryable given a queryable definition and corresponding collection id.
replaceQueryable: (collectionId: string, queryableName: string, body: StacQueryable, options?: StacReplaceQueryableOptionalParams) => Promise<StacQueryable>Property Value
(collectionId: string, queryableName: string, body: StacQueryable, options?: StacReplaceQueryableOptionalParams) => Promise<StacQueryable>
replaceRenderOption
Update a render option for a given collection
replaceRenderOption: (collectionId: string, renderOptionId: string, body: RenderOption, options?: StacReplaceRenderOptionOptionalParams) => Promise<RenderOption>Property Value
(collectionId: string, renderOptionId: string, body: RenderOption, options?: StacReplaceRenderOptionOptionalParams) => Promise<RenderOption>
replaceTileSettings
Update the tile settings for a given collection
replaceTileSettings: (collectionId: string, body: TileSettings, options?: StacReplaceTileSettingsOptionalParams) => Promise<TileSettings>Property Value
(collectionId: string, body: TileSettings, options?: StacReplaceTileSettingsOptionalParams) => Promise<TileSettings>
search
STAC search operation.
search: (body: StacSearchParameters, options?: StacSearchOptionalParams) => Promise<StacItemCollection>Property Value
(body: StacSearchParameters, options?: StacSearchOptionalParams) => Promise<StacItemCollection>
updateItem
Update a STAC item in a collection
updateItem: (collectionId: string, itemId: string, body: StacItem, options?: StacUpdateItemOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(collectionId: string, itemId: string, body: StacItem, options?: StacUpdateItemOptionalParams) => PollerLike<OperationState<void>, void>
