StacClient Class

Definition

Namespace:
Azure.Analytics.PlanetaryComputer
Assembly:
Azure.Analytics.PlanetaryComputer.dll
Package:
Azure.Analytics.PlanetaryComputer v1.0.0
Source:
StacClient.cs

The StacClient sub-client.

public class StacClient
type StacClient = class
Public Class StacClient
Inheritance
Object
StacClient

Constructors

Name Description
StacClient()

Initializes a new instance of StacClient for mocking.

Properties

Name Description
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name Description
AddMosaic(String, RequestContent, RequestContext)

[Protocol Method] Add a mosaic definition to a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
AddMosaic(String, StacMosaic, CancellationToken)

Add a mosaic definition to a given collection.
AddMosaicAsync(String, RequestContent, RequestContext)

[Protocol Method] Add a mosaic definition to a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
AddMosaicAsync(String, StacMosaic, CancellationToken)

Add a mosaic definition to a given collection.
CreateCollection(WaitUntil, RequestContent, RequestContext)

Create a new collection in the GeoCatalog instance.
CreateCollection(WaitUntil, StacCollection, CancellationToken)

Create a new collection in the GeoCatalog instance.
CreateCollectionAsset(String, RequestContent, String, RequestContext)

[Protocol Method] Create a new asset in the Collection metadata and write the associated file to managed storage.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateCollectionAsset(String, StacAssetData, CancellationToken)

Create a new asset in the Collection metadata and write the associated file to managed storage.
CreateCollectionAssetAsync(String, RequestContent, String, RequestContext)

[Protocol Method] Create a new asset in the Collection metadata and write the associated file to managed storage.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateCollectionAssetAsync(String, StacAssetData, CancellationToken)

Create a new asset in the Collection metadata and write the associated file to managed storage.
CreateCollectionAsync(WaitUntil, RequestContent, RequestContext)

Create a new collection in the GeoCatalog instance.
CreateCollectionAsync(WaitUntil, StacCollection, CancellationToken)

Create a new collection in the GeoCatalog instance.
CreateItem(WaitUntil, String, RequestContent, RequestContext)

Create a new STAC item or a set of items in a collection.
CreateItem(WaitUntil, String, StacItemOrStacItemCollection, CancellationToken)

Create a new STAC item or a set of items in a collection.
CreateItemAsync(WaitUntil, String, RequestContent, RequestContext)

Create a new STAC item or a set of items in a collection.
CreateItemAsync(WaitUntil, String, StacItemOrStacItemCollection, CancellationToken)

Create a new STAC item or a set of items in a collection.
CreateQueryables(String, IEnumerable<StacQueryable>, CancellationToken)

Set queryables for a collection given a list of queryable definitions.
CreateQueryables(String, RequestContent, RequestContext)

[Protocol Method] Set queryables for a collection given a list of queryable definitions

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateQueryablesAsync(String, IEnumerable<StacQueryable>, CancellationToken)

Set queryables for a collection given a list of queryable definitions.
CreateQueryablesAsync(String, RequestContent, RequestContext)

[Protocol Method] Set queryables for a collection given a list of queryable definitions

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateRenderOption(String, RenderConfiguration, CancellationToken)

Add a render option for a given collection.
CreateRenderOption(String, RequestContent, RequestContext)

[Protocol Method] Add a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateRenderOptionAsync(String, RenderConfiguration, CancellationToken)

Add a render option for a given collection.
CreateRenderOptionAsync(String, RequestContent, RequestContext)

[Protocol Method] Add a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteCollection(WaitUntil, String, CancellationToken)

Delete a collection in the GeoCatalog instance.
DeleteCollection(WaitUntil, String, RequestContext)

Delete a collection in the GeoCatalog instance.
DeleteCollectionAsset(String, String, CancellationToken)

Delete an asset from a given collection.
DeleteCollectionAsset(String, String, RequestContext)

[Protocol Method] Delete an asset from a given collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteCollectionAssetAsync(String, String, CancellationToken)

Delete an asset from a given collection.
DeleteCollectionAssetAsync(String, String, RequestContext)

[Protocol Method] Delete an asset from a given collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteCollectionAsync(WaitUntil, String, CancellationToken)

Delete a collection in the GeoCatalog instance.
DeleteCollectionAsync(WaitUntil, String, RequestContext)

Delete a collection in the GeoCatalog instance.
DeleteItem(WaitUntil, String, String, CancellationToken)

Delete a STAC item from a collection.
DeleteItem(WaitUntil, String, String, RequestContext)

Delete a STAC item from a collection.
DeleteItemAsync(WaitUntil, String, String, CancellationToken)

Delete a STAC item from a collection.
DeleteItemAsync(WaitUntil, String, String, RequestContext)

Delete a STAC item from a collection.
DeleteMosaic(String, String, CancellationToken)

Delete a mosaic definition from a given collection.
DeleteMosaic(String, String, RequestContext)

[Protocol Method] Delete a mosaic definition from a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteMosaicAsync(String, String, CancellationToken)

Delete a mosaic definition from a given collection.
DeleteMosaicAsync(String, String, RequestContext)

[Protocol Method] Delete a mosaic definition from a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteQueryable(String, String, CancellationToken)

Delete queryables by name for specified collection.
DeleteQueryable(String, String, RequestContext)

[Protocol Method] Delete queryables by name for specified collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteQueryableAsync(String, String, CancellationToken)

Delete queryables by name for specified collection.
DeleteQueryableAsync(String, String, RequestContext)

[Protocol Method] Delete queryables by name for specified collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRenderOption(String, String, CancellationToken)

Delete a render option for a given collection.
DeleteRenderOption(String, String, RequestContext)

[Protocol Method] Delete a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRenderOptionAsync(String, String, CancellationToken)

Delete a render option for a given collection.
DeleteRenderOptionAsync(String, String, RequestContext)

[Protocol Method] Delete a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollection(String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Get a collection in the GeoCatalog instance.
GetCollection(String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Get a collection in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionAsync(String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Get a collection in the GeoCatalog instance.
GetCollectionAsync(String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Get a collection in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionConfiguration(String, CancellationToken)

Get the complete user configuration for a given collection.
GetCollectionConfiguration(String, RequestContext)

[Protocol Method] Get the complete user configuration for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionConfigurationAsync(String, CancellationToken)

Get the complete user configuration for a given collection.
GetCollectionConfigurationAsync(String, RequestContext)

[Protocol Method] Get the complete user configuration for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionQueryables(String, CancellationToken)

List all queryables in a given collection.
GetCollectionQueryables(String, RequestContext)

[Protocol Method] List all queryables in a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionQueryablesAsync(String, CancellationToken)

List all queryables in a given collection.
GetCollectionQueryablesAsync(String, RequestContext)

[Protocol Method] List all queryables in a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollections(Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

List all collections in the GeoCatalog instance.
GetCollections(String, Nullable<Int32>, RequestContext)

[Protocol Method] List all collections in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionsAsync(Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

List all collections in the GeoCatalog instance.
GetCollectionsAsync(String, Nullable<Int32>, RequestContext)

[Protocol Method] List all collections in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionThumbnail(GetCollectionThumbnailOptions, RequestContext)

[Protocol Method] Get thumbnail for given collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionThumbnailAsync(GetCollectionThumbnailOptions, RequestContext)

[Protocol Method] Get thumbnail for given collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetConformanceClasses(CancellationToken)

Returns the STAC conformance classes.
GetConformanceClasses(RequestContext)

[Protocol Method] Returns the STAC conformance classes.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetConformanceClassesAsync(CancellationToken)

Returns the STAC conformance classes.
GetConformanceClassesAsync(RequestContext)

[Protocol Method] Returns the STAC conformance classes.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetItem(String, String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Fetch a single STAC Item.
GetItem(String, String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Fetch a single STAC Item

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetItemAsync(String, String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Fetch a single STAC Item.
GetItemAsync(String, String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Fetch a single STAC Item

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetItemCollection(GetItemCollectionOptions, CancellationToken)

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(GetItemCollectionOptions, RequestContext)

[Protocol Method] 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.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetItemCollectionAsync(GetItemCollectionOptions, CancellationToken)

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.
GetItemCollectionAsync(GetItemCollectionOptions, RequestContext)

[Protocol Method] 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.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLandingPage(CancellationToken)

Return the STAC landing page.
GetLandingPage(RequestContext)

[Protocol Method] Return the STAC landing page.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLandingPageAsync(CancellationToken)

Return the STAC landing page.
GetLandingPageAsync(RequestContext)

[Protocol Method] Return the STAC landing page.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMosaic(String, String, CancellationToken)

Get a mosaic definition from a given collection.
GetMosaic(String, String, RequestContext)

[Protocol Method] Get a mosaic definition from a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMosaicAsync(String, String, CancellationToken)

Get a mosaic definition from a given collection.
GetMosaicAsync(String, String, RequestContext)

[Protocol Method] Get a mosaic definition from a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMosaics(String, CancellationToken)

Get the mosaic definitions for a given collection.
GetMosaics(String, RequestContext)

[Protocol Method] Get the mosaic definitions for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMosaicsAsync(String, CancellationToken)

Get the mosaic definitions for a given collection.
GetMosaicsAsync(String, RequestContext)

[Protocol Method] Get the mosaic definitions for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetPartitionType(String, CancellationToken)

Get the partitiontype for a GeoCatalog Collection.
GetPartitionType(String, RequestContext)

[Protocol Method] Get the partitiontype for a GeoCatalog Collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetPartitionTypeAsync(String, CancellationToken)

Get the partitiontype for a GeoCatalog Collection.
GetPartitionTypeAsync(String, RequestContext)

[Protocol Method] Get the partitiontype for a GeoCatalog Collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetQueryables(CancellationToken)

List all queryables in the GeoCatalog instance.
GetQueryables(RequestContext)

[Protocol Method] List all queryables in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetQueryablesAsync(CancellationToken)

List all queryables in the GeoCatalog instance.
GetQueryablesAsync(RequestContext)

[Protocol Method] List all queryables in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRenderOption(String, String, CancellationToken)

Get a render option for a given collection.
GetRenderOption(String, String, RequestContext)

[Protocol Method] Get a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRenderOptionAsync(String, String, CancellationToken)

Get a render option for a given collection.
GetRenderOptionAsync(String, String, RequestContext)

[Protocol Method] Get a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRenderOptions(String, CancellationToken)

Get all render options for a given collection.
GetRenderOptions(String, RequestContext)

[Protocol Method] Get all render options for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRenderOptionsAsync(String, CancellationToken)

Get all render options for a given collection.
GetRenderOptionsAsync(String, RequestContext)

[Protocol Method] Get all render options for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTileSettings(String, CancellationToken)

Get the tile settings for a given collection.
GetTileSettings(String, RequestContext)

[Protocol Method] Get the tile settings for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTileSettingsAsync(String, CancellationToken)

Get the tile settings for a given collection.
GetTileSettingsAsync(String, RequestContext)

[Protocol Method] Get the tile settings for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceCollection(String, RequestContent, RequestContext)

[Protocol Method] Replace an existing collection in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceCollection(String, StacCollection, CancellationToken)

Replace an existing collection in the GeoCatalog instance.
ReplaceCollectionAsset(String, String, RequestContent, String, RequestContext)

[Protocol Method] Update an existing asset in a given collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceCollectionAsset(String, String, StacAssetData, CancellationToken)

Update an existing asset in a given collection.
ReplaceCollectionAssetAsync(String, String, RequestContent, String, RequestContext)

[Protocol Method] Update an existing asset in a given collection.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceCollectionAssetAsync(String, String, StacAssetData, CancellationToken)

Update an existing asset in a given collection.
ReplaceCollectionAsync(String, RequestContent, RequestContext)

[Protocol Method] Replace an existing collection in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceCollectionAsync(String, StacCollection, CancellationToken)

Replace an existing collection in the GeoCatalog instance.
ReplaceItem(WaitUntil, String, String, RequestContent, RequestContext)

Replace a STAC item in a collection.
ReplaceItem(WaitUntil, String, String, StacItem, CancellationToken)

Replace a STAC item in a collection.
ReplaceItemAsync(WaitUntil, String, String, RequestContent, RequestContext)

Replace a STAC item in a collection.
ReplaceItemAsync(WaitUntil, String, String, StacItem, CancellationToken)

Replace a STAC item in a collection.
ReplaceMosaic(String, String, RequestContent, RequestContext)

[Protocol Method] Update a mosaic definition from a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceMosaic(String, String, StacMosaic, CancellationToken)

Update a mosaic definition from a given collection.
ReplaceMosaicAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Update a mosaic definition from a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceMosaicAsync(String, String, StacMosaic, CancellationToken)

Update a mosaic definition from a given collection.
ReplacePartitionType(String, PartitionKind, CancellationToken)

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(String, RequestContent, RequestContext)

[Protocol Method] 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.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplacePartitionTypeAsync(String, PartitionKind, CancellationToken)

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.
ReplacePartitionTypeAsync(String, RequestContent, RequestContext)

[Protocol Method] 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.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceQueryable(String, String, RequestContent, RequestContext)

[Protocol Method] Updates a queryable given a queryable definition and corresponding collection id.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceQueryable(String, String, StacQueryable, CancellationToken)

Updates a queryable given a queryable definition and corresponding collection id.
ReplaceQueryableAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Updates a queryable given a queryable definition and corresponding collection id.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceQueryableAsync(String, String, StacQueryable, CancellationToken)

Updates a queryable given a queryable definition and corresponding collection id.
ReplaceRenderOption(String, String, RenderConfiguration, CancellationToken)

Update a render option for a given collection.
ReplaceRenderOption(String, String, RequestContent, RequestContext)

[Protocol Method] Update a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceRenderOptionAsync(String, String, RenderConfiguration, CancellationToken)

Update a render option for a given collection.
ReplaceRenderOptionAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Update a render option for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceTileSettings(String, RequestContent, RequestContext)

[Protocol Method] Update the tile settings for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceTileSettings(String, TileSettings, CancellationToken)

Update the tile settings for a given collection.
ReplaceTileSettingsAsync(String, RequestContent, RequestContext)

[Protocol Method] Update the tile settings for a given collection

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ReplaceTileSettingsAsync(String, TileSettings, CancellationToken)

Update the tile settings for a given collection.
Search(RequestContent, String, Nullable<Int32>, RequestContext)

[Protocol Method] STAC search operation.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Search(StacSearchParameters, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

STAC search operation.
SearchAsync(RequestContent, String, Nullable<Int32>, RequestContext)

[Protocol Method] STAC search operation.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
SearchAsync(StacSearchParameters, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

STAC search operation.
UpdateItem(WaitUntil, String, String, RequestContent, RequestContext)

Update a STAC item in a collection.
UpdateItemAsync(WaitUntil, String, String, RequestContent, RequestContext)

Update a STAC item in a collection.

Applies to